@intentius/chant-lexicon-aws 0.41.20 → 0.44.1

package/dist/okf/types/LoadBalancer.md

@@ -0,0 +1,43 @@
+---
+type: resource-type
+title: LoadBalancer
+description: aws resource type AWS::ElasticLoadBalancingV2::LoadBalancer
+name: LoadBalancer
+lexicon: aws
+resource_type: AWS::ElasticLoadBalancingV2::LoadBalancer
+---
+`AWS::ElasticLoadBalancingV2::LoadBalancer`, a resource type of the aws lexicon.
+
+## Properties
+
+- `CanonicalHostedZoneID` (`string`, optional)
+- `DNSName` (`string`, optional)
+- `EnableCapacityReservationProvisionStabilize` (`boolean`, optional): Indicates whether to enable stabilization when creating or updating an LCU reservation. This ensures that the final stack status reflects the status of the LCU reservation. The default is ``false``.
+- `EnablePrefixForIpv6SourceNat` (`string`, optional): [Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be ``dualstack``. The default value is ``off``.
+- `EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic` (`string`, optional): Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink. The default is ``on``. You can't configure this property on a Network Load Balancer unless you associated a security group with the load balancer when you created it.
+- `IpAddressType` (`string`, optional): The IP address type. Internal load balancers must use ``ipv4``. [Application Load Balancers] The possible values are ``ipv4`` (IPv4 addresses), ``dualstack`` (IPv4 and IPv6 addresses), and ``dualstack-without-public-ipv4`` (public IPv6 addresses and private IPv4 and IPv6 addresses). Application Load Balancer authentication supports IPv4 addresses only when connecting to an Identity Provider (IdP) or Amazon Cognito endpoint. Without a public IPv4 address the load balancer can't complete the authentication process, resulting in HTTP 500 errors. [Network Load Balancers and Gateway Load Balancers] The possible values are ``ipv4`` (IPv4 addresses) and ``dualstack`` (IPv4 and IPv6 addresses).
+- `Ipv4IpamPoolId` (`string`, optional): The ID of the IPv4 IPAM pool.
+- `LoadBalancerArn` (`string`, optional)
+- `LoadBalancerAttributes` (`LoadBalancer_LoadBalancerAttribute[]`, optional): The load balancer attributes. Attributes that you do not modify retain their current values.
+- `LoadBalancerFullName` (`string`, optional)
+- `LoadBalancerName` (`string`, optional)
+- `MinimumLoadBalancerCapacity` (`LoadBalancer_MinimumLoadBalancerCapacity`, optional): The minimum capacity for a load balancer.
+- `Name` (`string`, optional): The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-". If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.
+- `Scheme` (`string`, optional): The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer. You can't specify a scheme for a Gateway Load Balancer.
+- `SecurityGroups` (`string[]`, optional): [Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
+- `SubnetMappings` (`LoadBalancer_SubnetMapping[]`, optional): The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You can't specify Elastic IP addresses for your subnets.
+- `Subnets` (`string[]`, optional): The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers and Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
+- `Tags` (`LoadBalancer_Tag[]`, optional): The tags to assign to the load balancer.
+- `Type` (`"application" | "gateway" | "network"`, optional): The type of load balancer. The default is ``application``.
+
+## Attributes
+
+- `CanonicalHostedZoneID`
+- `DNSName`
+- `LoadBalancerArn`
+- `LoadBalancerFullName`
+- `LoadBalancerName`
+
+## Governed by
+
+- [WAW024](/rules/WAW024.md): Application Load Balancer does not have access logging enabled

package/dist/okf/types/LoadBalancerTlsCertificate.md

@@ -0,0 +1,25 @@
+---
+type: resource-type
+title: LoadBalancerTlsCertificate
+description: aws resource type AWS::Lightsail::LoadBalancerTlsCertificate
+name: LoadBalancerTlsCertificate
+lexicon: aws
+resource_type: AWS::Lightsail::LoadBalancerTlsCertificate
+---
+`AWS::Lightsail::LoadBalancerTlsCertificate`, a resource type of the aws lexicon.
+
+## Properties
+
+- `CertificateDomainName` (`string`, required): The domain name (e.g., example.com ) for your SSL/TLS certificate.
+- `CertificateName` (`string`, required): The SSL/TLS certificate name.
+- `LoadBalancerName` (`string`, required): The name of your load balancer.
+- `CertificateAlternativeNames` (`string[]`, optional): An array of strings listing alternative domains and subdomains for your SSL/TLS certificate.
+- `HttpsRedirectionEnabled` (`boolean`, optional): A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
+- `IsAttached` (`boolean`, optional): When true, the SSL/TLS certificate is attached to the Lightsail load balancer.
+- `LoadBalancerTlsCertificateArn` (`string`, optional)
+- `Status` (`string`, optional): The validation status of the SSL/TLS certificate.
+
+## Attributes
+
+- `LoadBalancerTlsCertificateArn`
+- `Status`

package/dist/okf/types/LocalGatewayRoute.md

@@ -0,0 +1,23 @@
+---
+type: resource-type
+title: LocalGatewayRoute
+description: aws resource type AWS::EC2::LocalGatewayRoute
+name: LocalGatewayRoute
+lexicon: aws
+resource_type: AWS::EC2::LocalGatewayRoute
+---
+`AWS::EC2::LocalGatewayRoute`, a resource type of the aws lexicon.
+
+## Properties
+
+- `DestinationCidrBlock` (`string`, optional): The CIDR block used for destination matches.
+- `LocalGatewayRouteTableId` (`string`, optional): The ID of the local gateway route table.
+- `LocalGatewayVirtualInterfaceGroupId` (`string`, optional): The ID of the virtual interface group.
+- `NetworkInterfaceId` (`string`, optional): The ID of the network interface.
+- `State` (`string`, optional): The state of the route.
+- `Type` (`string`, optional): The route type.
+
+## Attributes
+
+- `State`
+- `Type`

package/dist/okf/types/LocalGatewayRouteTable.md

@@ -0,0 +1,28 @@
+---
+type: resource-type
+title: LocalGatewayRouteTable
+description: aws resource type AWS::EC2::LocalGatewayRouteTable
+name: LocalGatewayRouteTable
+lexicon: aws
+resource_type: AWS::EC2::LocalGatewayRouteTable
+---
+`AWS::EC2::LocalGatewayRouteTable`, a resource type of the aws lexicon.
+
+## Properties
+
+- `LocalGatewayId` (`string`, required): The ID of the local gateway.
+- `LocalGatewayRouteTableArn` (`string`, optional): The ARN of the local gateway route table.
+- `LocalGatewayRouteTableId` (`string`, optional): The ID of the local gateway route table.
+- `Mode` (`string`, optional): The mode of the local gateway route table.
+- `OutpostArn` (`string`, optional): The ARN of the outpost.
+- `OwnerId` (`string`, optional): The owner of the local gateway route table.
+- `State` (`string`, optional): The state of the local gateway route table.
+- `Tags` (`any`, optional): The tags for the local gateway route table.
+
+## Attributes
+
+- `LocalGatewayRouteTableArn`
+- `LocalGatewayRouteTableId`
+- `OutpostArn`
+- `OwnerId`
+- `State`

package/dist/okf/types/LocalGatewayRouteTableVPCAssociation.md

@@ -0,0 +1,24 @@
+---
+type: resource-type
+title: LocalGatewayRouteTableVPCAssociation
+description: aws resource type AWS::EC2::LocalGatewayRouteTableVPCAssociation
+name: LocalGatewayRouteTableVPCAssociation
+lexicon: aws
+resource_type: AWS::EC2::LocalGatewayRouteTableVPCAssociation
+---
+`AWS::EC2::LocalGatewayRouteTableVPCAssociation`, a resource type of the aws lexicon.
+
+## Properties
+
+- `LocalGatewayRouteTableId` (`string`, required): The ID of the local gateway route table.
+- `VpcId` (`string`, required): The ID of the VPC.
+- `LocalGatewayId` (`string`, optional): The ID of the local gateway.
+- `LocalGatewayRouteTableVpcAssociationId` (`string`, optional): The ID of the association.
+- `State` (`string`, optional): The state of the association.
+- `Tags` (`any`, optional): The tags for the association.
+
+## Attributes
+
+- `LocalGatewayId`
+- `LocalGatewayRouteTableVpcAssociationId`
+- `State`

package/dist/okf/types/LocalGatewayRouteTableVirtualInterfaceGroupAssociation.md

@@ -0,0 +1,28 @@
+---
+type: resource-type
+title: LocalGatewayRouteTableVirtualInterfaceGroupAssociation
+description: aws resource type AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation
+name: LocalGatewayRouteTableVirtualInterfaceGroupAssociation
+lexicon: aws
+resource_type: AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation
+---
+`AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation`, a resource type of the aws lexicon.
+
+## Properties
+
+- `LocalGatewayRouteTableId` (`string`, required): The ID of the local gateway route table.
+- `LocalGatewayVirtualInterfaceGroupId` (`string`, required): The ID of the local gateway route table virtual interface group.
+- `LocalGatewayId` (`string`, optional): The ID of the local gateway.
+- `LocalGatewayRouteTableArn` (`string`, optional): The ARN of the local gateway route table.
+- `LocalGatewayRouteTableVirtualInterfaceGroupAssociationId` (`string`, optional): The ID of the local gateway route table virtual interface group association.
+- `OwnerId` (`string`, optional): The owner of the local gateway route table virtual interface group association.
+- `State` (`string`, optional): The state of the local gateway route table virtual interface group association.
+- `Tags` (`any`, optional): The tags for the local gateway route table virtual interface group association.
+
+## Attributes
+
+- `LocalGatewayId`
+- `LocalGatewayRouteTableArn`
+- `LocalGatewayRouteTableVirtualInterfaceGroupAssociationId`
+- `OwnerId`
+- `State`

package/dist/okf/types/LocalGatewayVirtualInterface.md

@@ -0,0 +1,33 @@
+---
+type: resource-type
+title: LocalGatewayVirtualInterface
+description: aws resource type AWS::EC2::LocalGatewayVirtualInterface
+name: LocalGatewayVirtualInterface
+lexicon: aws
+resource_type: AWS::EC2::LocalGatewayVirtualInterface
+---
+`AWS::EC2::LocalGatewayVirtualInterface`, a resource type of the aws lexicon.
+
+## Properties
+
+- `LocalAddress` (`string`, required): The local address.
+- `LocalGatewayVirtualInterfaceGroupId` (`string`, required): The ID of the virtual interface group
+- `OutpostLagId` (`string`, required): The Outpost LAG ID.
+- `PeerAddress` (`string`, required): The peer address.
+- `Vlan` (`number`, required): The ID of the VLAN.
+- `ConfigurationState` (`string`, optional): The current state of the local gateway virtual interface
+- `LocalBgpAsn` (`number`, optional): The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP)
+- `LocalGatewayId` (`string`, optional): The ID of the local gateway
+- `LocalGatewayVirtualInterfaceId` (`string`, optional): The ID of the virtual interface
+- `OwnerId` (`string`, optional): The ID of the Amazon Web Services account that owns the local gateway virtual interface group
+- `PeerBgpAsn` (`number`, optional): The peer BGP ASN.
+- `PeerBgpAsnExtended` (`number`, optional): The extended 32-bit ASN of the BGP peer for use with larger ASN values.
+- `Tags` (`LocalGatewayVirtualInterface_Tag[]`, optional): An array of key-value pairs to apply to this resource.
+
+## Attributes
+
+- `ConfigurationState`
+- `LocalBgpAsn`
+- `LocalGatewayId`
+- `LocalGatewayVirtualInterfaceId`
+- `OwnerId`

package/dist/okf/types/LocalGatewayVirtualInterfaceGroup.md

@@ -0,0 +1,29 @@
+---
+type: resource-type
+title: LocalGatewayVirtualInterfaceGroup
+description: aws resource type AWS::EC2::LocalGatewayVirtualInterfaceGroup
+name: LocalGatewayVirtualInterfaceGroup
+lexicon: aws
+resource_type: AWS::EC2::LocalGatewayVirtualInterfaceGroup
+---
+`AWS::EC2::LocalGatewayVirtualInterfaceGroup`, a resource type of the aws lexicon.
+
+## Properties
+
+- `LocalGatewayId` (`string`, required): The ID of the local gateway
+- `ConfigurationState` (`string`, optional): The current state of the local gateway virtual interface group
+- `LocalBgpAsn` (`number`, optional): The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP)
+- `LocalBgpAsnExtended` (`number`, optional): The extended 32-bit ASN for the local BGP configuration
+- `LocalGatewayVirtualInterfaceGroupArn` (`string`, optional): The Amazon Resource Number (ARN) of the local gateway virtual interface group
+- `LocalGatewayVirtualInterfaceGroupId` (`string`, optional): The ID of the virtual interface group
+- `LocalGatewayVirtualInterfaceIds` (`string[]`, optional): The IDs of the virtual interfaces
+- `OwnerId` (`string`, optional): The ID of the Amazon Web Services account that owns the local gateway virtual interface group
+- `Tags` (`LocalGatewayVirtualInterfaceGroup_Tag[]`, optional): The tags assigned to the virtual interface group
+
+## Attributes
+
+- `ConfigurationState`
+- `LocalGatewayVirtualInterfaceGroupArn`
+- `LocalGatewayVirtualInterfaceGroupId`
+- `LocalGatewayVirtualInterfaceIds`
+- `OwnerId`

package/dist/okf/types/Location.md

@@ -0,0 +1,19 @@
+---
+type: resource-type
+title: Location
+description: aws resource type AWS::GameLift::Location
+name: Location
+lexicon: aws
+resource_type: AWS::GameLift::Location
+---
+`AWS::GameLift::Location`, a resource type of the aws lexicon.
+
+## Properties
+
+- `LocationName` (`string`, required)
+- `LocationArn` (`string`, optional)
+- `Tags` (`Location_Tag[]`, optional): An array of key-value pairs to apply to this resource.
+
+## Attributes
+
+- `LocationArn`

package/dist/okf/types/LocationAzureBlob.md

@@ -0,0 +1,32 @@
+---
+type: resource-type
+title: LocationAzureBlob
+description: aws resource type AWS::DataSync::LocationAzureBlob
+name: LocationAzureBlob
+lexicon: aws
+resource_type: AWS::DataSync::LocationAzureBlob
+---
+`AWS::DataSync::LocationAzureBlob`, a resource type of the aws lexicon.
+
+## Properties
+
+- `AzureBlobAuthenticationType` (`"NONE" | "SAS"`, required): The specific authentication type that you want DataSync to use to access your Azure Blob Container.
+- `AgentArns` (`string[]`, optional): Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.
+- `AzureAccessTier` (`"ARCHIVE" | "COOL" | "HOT"`, optional): Specifies an access tier for the objects you're transferring into your Azure Blob Storage container.
+- `AzureBlobContainerUrl` (`string`, optional): The URL of the Azure Blob container that was described.
+- `AzureBlobSasConfiguration` (`LocationAzureBlob_AzureBlobSasConfiguration`, optional)
+- `AzureBlobType` (`"BLOCK"`, optional): Specifies a blob type for the objects you're transferring into your Azure Blob Storage container.
+- `CmkSecretConfig` (`LocationAzureBlob_CmkSecretConfig`, optional)
+- `CustomSecretConfig` (`LocationAzureBlob_CustomSecretConfig`, optional)
+- `LocationArn` (`string`, optional): The Amazon Resource Name (ARN) of the Azure Blob Location that is created.
+- `LocationUri` (`string`, optional): The URL of the Azure Blob Location that was described.
+- `ManagedSecretConfig` (`LocationAzureBlob_ManagedSecretConfig`, optional)
+- `Subdirectory` (`string`, optional): The subdirectory in the Azure Blob Container that is used to read data from the Azure Blob Source Location.
+- `Tags` (`LocationAzureBlob_Tag[]`, optional): An array of key-value pairs to apply to this resource.
+
+## Attributes
+
+- `CmkSecretConfig.SecretArn`
+- `LocationArn`
+- `LocationUri`
+- `ManagedSecretConfig`

package/dist/okf/types/LocationEFS.md

@@ -0,0 +1,26 @@
+---
+type: resource-type
+title: LocationEFS
+description: aws resource type AWS::DataSync::LocationEFS
+name: LocationEFS
+lexicon: aws
+resource_type: AWS::DataSync::LocationEFS
+---
+`AWS::DataSync::LocationEFS`, a resource type of the aws lexicon.
+
+## Properties
+
+- `Ec2Config` (`LocationEFS_Ec2Config`, required)
+- `AccessPointArn` (`string`, optional): The Amazon Resource Name (ARN) for the Amazon EFS Access point that DataSync uses when accessing the EFS file system.
+- `EfsFilesystemArn` (`string`, optional): The Amazon Resource Name (ARN) for the Amazon EFS file system.
+- `FileSystemAccessRoleArn` (`string`, optional): The Amazon Resource Name (ARN) of the AWS IAM role that the DataSync will assume when mounting the EFS file system.
+- `InTransitEncryption` (`"NONE" | "TLS1_2"`, optional): Protocol that is used for encrypting the traffic exchanged between the DataSync Agent and the EFS file system.
+- `LocationArn` (`string`, optional): The Amazon Resource Name (ARN) of the Amazon EFS file system location that is created.
+- `LocationUri` (`string`, optional): The URL of the EFS location that was described.
+- `Subdirectory` (`string`, optional): A subdirectory in the location's path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination.
+- `Tags` (`LocationEFS_Tag[]`, optional): An array of key-value pairs to apply to this resource.
+
+## Attributes
+
+- `LocationArn`
+- `LocationUri`

package/dist/okf/types/LocationFSxLustre.md

@@ -0,0 +1,23 @@
+---
+type: resource-type
+title: LocationFSxLustre
+description: aws resource type AWS::DataSync::LocationFSxLustre
+name: LocationFSxLustre
+lexicon: aws
+resource_type: AWS::DataSync::LocationFSxLustre
+---
+`AWS::DataSync::LocationFSxLustre`, a resource type of the aws lexicon.
+
+## Properties
+
+- `SecurityGroupArns` (`string[]`, required): The ARNs of the security groups that are to use to configure the FSx for Lustre file system.
+- `FsxFilesystemArn` (`string`, optional): The Amazon Resource Name (ARN) for the FSx for Lustre file system.
+- `LocationArn` (`string`, optional): The Amazon Resource Name (ARN) of the Amazon FSx for Lustre file system location that is created.
+- `LocationUri` (`string`, optional): The URL of the FSx for Lustre location that was described.
+- `Subdirectory` (`string`, optional): A subdirectory in the location's path.
+- `Tags` (`LocationFSxLustre_Tag[]`, optional): An array of key-value pairs to apply to this resource.
+
+## Attributes
+
+- `LocationArn`
+- `LocationUri`

package/dist/okf/types/LocationFSxONTAP.md

@@ -0,0 +1,28 @@
+---
+type: resource-type
+title: LocationFSxONTAP
+description: aws resource type AWS::DataSync::LocationFSxONTAP
+name: LocationFSxONTAP
+lexicon: aws
+resource_type: AWS::DataSync::LocationFSxONTAP
+---
+`AWS::DataSync::LocationFSxONTAP`, a resource type of the aws lexicon.
+
+## Properties
+
+- `SecurityGroupArns` (`string[]`, required): The ARNs of the security groups that are to use to configure the FSx ONTAP file system.
+- `StorageVirtualMachineArn` (`string`, required): The Amazon Resource Name (ARN) for the FSx ONTAP SVM.
+- `FsxFilesystemArn` (`string`, optional): The Amazon Resource Name (ARN) for the FSx ONAP file system.
+- `LocationArn` (`string`, optional): The Amazon Resource Name (ARN) of the Amazon FSx ONTAP file system location that is created.
+- `LocationUri` (`string`, optional): The URL of the FSx ONTAP file system that was described.
+- `Protocol` (`LocationFSxONTAP_Protocol`, optional)
+- `Subdirectory` (`string`, optional): A subdirectory in the location's path.
+- `Tags` (`LocationFSxONTAP_Tag[]`, optional): An array of key-value pairs to apply to this resource.
+
+## Attributes
+
+- `FsxFilesystemArn`
+- `LocationArn`
+- `LocationUri`
+- `Protocol.SMB.CmkSecretConfig.SecretArn`
+- `Protocol.SMB.ManagedSecretConfig`

package/dist/okf/types/LocationFSxOpenZFS.md

@@ -0,0 +1,24 @@
+---
+type: resource-type
+title: LocationFSxOpenZFS
+description: aws resource type AWS::DataSync::LocationFSxOpenZFS
+name: LocationFSxOpenZFS
+lexicon: aws
+resource_type: AWS::DataSync::LocationFSxOpenZFS
+---
+`AWS::DataSync::LocationFSxOpenZFS`, a resource type of the aws lexicon.
+
+## Properties
+
+- `Protocol` (`LocationFSxOpenZFS_Protocol`, required)
+- `SecurityGroupArns` (`string[]`, required): The ARNs of the security groups that are to use to configure the FSx OpenZFS file system.
+- `FsxFilesystemArn` (`string`, optional): The Amazon Resource Name (ARN) for the FSx OpenZFS file system.
+- `LocationArn` (`string`, optional): The Amazon Resource Name (ARN) of the Amazon FSx OpenZFS file system location that is created.
+- `LocationUri` (`string`, optional): The URL of the FSx OpenZFS that was described.
+- `Subdirectory` (`string`, optional): A subdirectory in the location's path.
+- `Tags` (`LocationFSxOpenZFS_Tag[]`, optional): An array of key-value pairs to apply to this resource.
+
+## Attributes
+
+- `LocationArn`
+- `LocationUri`

package/dist/okf/types/LocationFSxWindows.md

@@ -0,0 +1,31 @@
+---
+type: resource-type
+title: LocationFSxWindows
+description: aws resource type AWS::DataSync::LocationFSxWindows
+name: LocationFSxWindows
+lexicon: aws
+resource_type: AWS::DataSync::LocationFSxWindows
+---
+`AWS::DataSync::LocationFSxWindows`, a resource type of the aws lexicon.
+
+## Properties
+
+- `SecurityGroupArns` (`string[]`, required): The ARNs of the security groups that are to use to configure the FSx for Windows file system.
+- `User` (`string`, required): The user who has the permissions to access files and folders in the FSx for Windows file system.
+- `CmkSecretConfig` (`LocationFSxWindows_CmkSecretConfig`, optional)
+- `CustomSecretConfig` (`LocationFSxWindows_CustomSecretConfig`, optional)
+- `Domain` (`string`, optional): The name of the Windows domain that the FSx for Windows server belongs to.
+- `FsxFilesystemArn` (`string`, optional): The Amazon Resource Name (ARN) for the FSx for Windows file system.
+- `LocationArn` (`string`, optional): The Amazon Resource Name (ARN) of the Amazon FSx for Windows file system location that is created.
+- `LocationUri` (`string`, optional): The URL of the FSx for Windows location that was described.
+- `ManagedSecretConfig` (`LocationFSxWindows_ManagedSecretConfig`, optional)
+- `Password` (`string`, optional): The password of the user who has the permissions to access files and folders in the FSx for Windows file system.
+- `Subdirectory` (`string`, optional): A subdirectory in the location's path.
+- `Tags` (`LocationFSxWindows_Tag[]`, optional): An array of key-value pairs to apply to this resource.
+
+## Attributes
+
+- `CmkSecretConfig.SecretArn`
+- `LocationArn`
+- `LocationUri`
+- `ManagedSecretConfig`

package/dist/okf/types/LocationHDFS.md

@@ -0,0 +1,37 @@
+---
+type: resource-type
+title: LocationHDFS
+description: aws resource type AWS::DataSync::LocationHDFS
+name: LocationHDFS
+lexicon: aws
+resource_type: AWS::DataSync::LocationHDFS
+---
+`AWS::DataSync::LocationHDFS`, a resource type of the aws lexicon.
+
+## Properties
+
+- `AgentArns` (`string[]`, required): ARN(s) of the agent(s) to use for an HDFS location.
+- `AuthenticationType` (`"KERBEROS" | "SIMPLE"`, required): The authentication mode used to determine identity of user.
+- `NameNodes` (`LocationHDFS_NameNode[]`, required): An array of Name Node(s) of the HDFS location.
+- `BlockSize` (`number`, optional): Size of chunks (blocks) in bytes that the data is divided into when stored in the HDFS cluster.
+- `CmkSecretConfig` (`LocationHDFS_CmkSecretConfig`, optional)
+- `CustomSecretConfig` (`LocationHDFS_CustomSecretConfig`, optional)
+- `KerberosKeytab` (`string`, optional): The Base64 string representation of the Keytab file.
+- `KerberosKrb5Conf` (`string`, optional): The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket.
+- `KerberosPrincipal` (`string`, optional): The unique identity, or principal, to which Kerberos can assign tickets.
+- `KmsKeyProviderUri` (`string`, optional): The identifier for the Key Management Server where the encryption keys that encrypt data inside HDFS clusters are stored.
+- `LocationArn` (`string`, optional): The Amazon Resource Name (ARN) of the HDFS location.
+- `LocationUri` (`string`, optional): The URL of the HDFS location that was described.
+- `ManagedSecretConfig` (`LocationHDFS_ManagedSecretConfig`, optional)
+- `QopConfiguration` (`LocationHDFS_QopConfiguration`, optional)
+- `ReplicationFactor` (`number`, optional): Number of copies of each block that exists inside the HDFS cluster.
+- `SimpleUser` (`string`, optional): The user name that has read and write permissions on the specified HDFS cluster.
+- `Subdirectory` (`string`, optional): The subdirectory in HDFS that is used to read data from the HDFS source location or write data to the HDFS destination.
+- `Tags` (`LocationHDFS_Tag[]`, optional): An array of key-value pairs to apply to this resource.
+
+## Attributes
+
+- `CmkSecretConfig.SecretArn`
+- `LocationArn`
+- `LocationUri`
+- `ManagedSecretConfig`

package/dist/okf/types/LocationNFS.md

@@ -0,0 +1,24 @@
+---
+type: resource-type
+title: LocationNFS
+description: aws resource type AWS::DataSync::LocationNFS
+name: LocationNFS
+lexicon: aws
+resource_type: AWS::DataSync::LocationNFS
+---
+`AWS::DataSync::LocationNFS`, a resource type of the aws lexicon.
+
+## Properties
+
+- `OnPremConfig` (`LocationNFS_OnPremConfig`, required)
+- `LocationArn` (`string`, optional): The Amazon Resource Name (ARN) of the NFS location.
+- `LocationUri` (`string`, optional): The URL of the NFS location that was described.
+- `MountOptions` (`LocationNFS_MountOptions`, optional)
+- `ServerHostname` (`string`, optional): The name of the NFS server. This value is the IP address or DNS name of the NFS server.
+- `Subdirectory` (`string`, optional): The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination.
+- `Tags` (`LocationNFS_Tag[]`, optional): An array of key-value pairs to apply to this resource.
+
+## Attributes
+
+- `LocationArn`
+- `LocationUri`

package/dist/okf/types/LocationObjectStorage.md

@@ -0,0 +1,34 @@
+---
+type: resource-type
+title: LocationObjectStorage
+description: aws resource type AWS::DataSync::LocationObjectStorage
+name: LocationObjectStorage
+lexicon: aws
+resource_type: AWS::DataSync::LocationObjectStorage
+---
+`AWS::DataSync::LocationObjectStorage`, a resource type of the aws lexicon.
+
+## Properties
+
+- `AccessKey` (`string`, optional): Optional. The access key is used if credentials are required to access the self-managed object storage server.
+- `AgentArns` (`string[]`, optional): Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.
+- `BucketName` (`string`, optional): The name of the bucket on the self-managed object storage server.
+- `CmkSecretConfig` (`LocationObjectStorage_CmkSecretConfig`, optional)
+- `CustomSecretConfig` (`LocationObjectStorage_CustomSecretConfig`, optional)
+- `LocationArn` (`string`, optional): The Amazon Resource Name (ARN) of the location that is created.
+- `LocationUri` (`string`, optional): The URL of the object storage location that was described.
+- `ManagedSecretConfig` (`LocationObjectStorage_ManagedSecretConfig`, optional)
+- `SecretKey` (`string`, optional): Optional. The secret key is used if credentials are required to access the self-managed object storage server.
+- `ServerCertificate` (`string`, optional): X.509 PEM content containing a certificate authority or chain to trust.
+- `ServerHostname` (`string`, optional): The name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server.
+- `ServerPort` (`number`, optional): The port that your self-managed server accepts inbound network traffic on.
+- `ServerProtocol` (`"HTTP" | "HTTPS"`, optional): The protocol that the object storage server uses to communicate.
+- `Subdirectory` (`string`, optional): The subdirectory in the self-managed object storage server that is used to read data from.
+- `Tags` (`LocationObjectStorage_Tag[]`, optional): An array of key-value pairs to apply to this resource.
+
+## Attributes
+
+- `CmkSecretConfig.SecretArn`
+- `LocationArn`
+- `LocationUri`
+- `ManagedSecretConfig`

package/dist/okf/types/LocationS3.md

@@ -0,0 +1,24 @@
+---
+type: resource-type
+title: LocationS3
+description: aws resource type AWS::DataSync::LocationS3
+name: LocationS3
+lexicon: aws
+resource_type: AWS::DataSync::LocationS3
+---
+`AWS::DataSync::LocationS3`, a resource type of the aws lexicon.
+
+## Properties
+
+- `S3Config` (`LocationS3_S3Config`, required)
+- `LocationArn` (`string`, optional): The Amazon Resource Name (ARN) of the Amazon S3 bucket location.
+- `LocationUri` (`string`, optional): The URL of the S3 location that was described.
+- `S3BucketArn` (`string`, optional): The Amazon Resource Name (ARN) of the Amazon S3 bucket.
+- `S3StorageClass` (`"DEEP_ARCHIVE" | "GLACIER" | "GLACIER_INSTANT_RETRIEVAL" | "INTELLIGENT_TIERING" | "ONEZONE_IA" | "STANDARD" | "STANDARD_IA"`, optional): The Amazon S3 storage class you want to store your files in when this location is used as a task destination.
+- `Subdirectory` (`string`, optional): A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.
+- `Tags` (`LocationS3_Tag[]`, optional): An array of key-value pairs to apply to this resource.
+
+## Attributes
+
+- `LocationArn`
+- `LocationUri`

package/dist/okf/types/LocationSMB.md

@@ -0,0 +1,37 @@
+---
+type: resource-type
+title: LocationSMB
+description: aws resource type AWS::DataSync::LocationSMB
+name: LocationSMB
+lexicon: aws
+resource_type: AWS::DataSync::LocationSMB
+---
+`AWS::DataSync::LocationSMB`, a resource type of the aws lexicon.
+
+## Properties
+
+- `AgentArns` (`string[]`, required): The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
+- `AuthenticationType` (`"KERBEROS" | "NTLM"`, optional): The authentication mode used to determine identity of user.
+- `CmkSecretConfig` (`LocationSMB_CmkSecretConfig`, optional)
+- `CustomSecretConfig` (`LocationSMB_CustomSecretConfig`, optional)
+- `DnsIpAddresses` (`string[]`, optional): Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
+- `Domain` (`string`, optional): The name of the Windows domain that the SMB server belongs to.
+- `KerberosKeytab` (`string`, optional): The Base64 string representation of the Keytab file. Specifies your Kerberos key table (keytab) file, which includes mappings between your service principal name (SPN) and encryption keys. To avoid task execution errors, make sure that the SPN in the keytab file matches exactly what you specify for KerberosPrincipal and in your krb5.conf file.
+- `KerberosKrb5Conf` (`string`, optional): The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.
+- `KerberosPrincipal` (`string`, optional): Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server. SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM. Your task execution will fail if the SPN that you provide for this parameter doesn't match exactly what's in your keytab or krb5.conf files.
+- `LocationArn` (`string`, optional): The Amazon Resource Name (ARN) of the SMB location that is created.
+- `LocationUri` (`string`, optional): The URL of the SMB location that was described.
+- `ManagedSecretConfig` (`LocationSMB_ManagedSecretConfig`, optional)
+- `MountOptions` (`LocationSMB_MountOptions`, optional)
+- `Password` (`string`, optional): The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
+- `ServerHostname` (`string`, optional): The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
+- `Subdirectory` (`string`, optional): The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
+- `Tags` (`LocationSMB_Tag[]`, optional): An array of key-value pairs to apply to this resource.
+- `User` (`string`, optional): The user who can mount the share, has the permissions to access files and folders in the SMB share.
+
+## Attributes
+
+- `CmkSecretConfig.SecretArn`
+- `LocationArn`
+- `LocationUri`
+- `ManagedSecretConfig`

package/dist/okf/types/LogAlarm.md

@@ -0,0 +1,32 @@
+---
+type: resource-type
+title: LogAlarm
+description: aws resource type AWS::CloudWatch::LogAlarm
+name: LogAlarm
+lexicon: aws
+resource_type: AWS::CloudWatch::LogAlarm
+---
+`AWS::CloudWatch::LogAlarm`, a resource type of the aws lexicon.
+
+## Properties
+
+- `ComparisonOperator` (`string`, required): The arithmetic operation to use when comparing the specified threshold and the query results. Valid values are GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, and LessThanOrEqualToThreshold.
+- `QueryResultsToAlarm` (`number`, required): The number of query results that must be breaching to trigger the alarm.
+- `QueryResultsToEvaluate` (`number`, required): The number of query results over which data is compared to the specified threshold.
+- `ScheduledQueryConfiguration` (`LogAlarm_ScheduledQueryConfiguration`, required): The scheduled query configuration for the log alarm.
+- `Threshold` (`number`, required): The value to compare against the results of the scheduled query evaluation.
+- `ActionLogLineCount` (`number`, optional): The number of log lines to include in alarm notifications. Valid values are 0 to 50.
+- `ActionLogLineRoleArn` (`string`, optional): The ARN of the IAM role that grants CloudWatch permissions to fetch log lines for alarm notifications. Required when ActionLogLineCount is greater than 0.
+- `ActionsEnabled` (`boolean`, optional): Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
+- `AlarmActions` (`string[]`, optional): The list of actions to execute when this alarm transitions into an ALARM state from any other state.
+- `AlarmDescription` (`string`, optional): The description of the log alarm.
+- `AlarmName` (`string`, optional): The name of the log alarm.
+- `Arn` (`string`, optional): The ARN of the log alarm.
+- `InsufficientDataActions` (`string[]`, optional): The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
+- `OKActions` (`string[]`, optional): The actions to execute when this alarm transitions to the OK state from any other state.
+- `Tags` (`LogAlarm_Tag[]`, optional): A list of key-value pairs to associate with the log alarm.
+- `TreatMissingData` (`string`, optional): Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing.
+
+## Attributes
+
+- `Arn`