@intentius/chant-lexicon-aws 0.58.0 → 0.59.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/codegen/enum-overlay.d.ts +113 -0
- package/dist/codegen/enum-overlay.d.ts.map +1 -0
- package/dist/codegen/enum-overlay.json +1843 -0
- package/dist/codegen/generate.d.ts.map +1 -1
- package/dist/integrity.json +4 -4
- package/dist/manifest.json +1 -1
- package/dist/meta.json +1613 -0
- package/dist/okf/types/DbCluster.md +1 -1
- package/dist/okf/types/DbInstance.md +1 -1
- package/dist/okf/types/EC2Volume.md +1 -1
- package/dist/okf/types/Function.md +1 -1
- package/dist/okf/types/Instance.md +2 -2
- package/dist/okf/types/LoadBalancer.md +1 -1
- package/dist/okf/types/ScalableTarget.md +2 -2
- package/dist/okf/types/Subscription.md +1 -1
- package/dist/okf/types/Table.md +1 -1
- package/dist/okf/types/TargetGroup.md +2 -2
- package/dist/types/index.d.ts +1587 -18
- package/package.json +2 -2
- package/src/codegen/enum-overlay.json +1843 -0
- package/src/codegen/enum-overlay.test.ts +298 -0
- package/src/codegen/enum-overlay.ts +245 -0
- package/src/codegen/generate.ts +40 -2
- package/src/generated/index.d.ts +1587 -18
- package/src/generated/lexicon-aws.json +1613 -0
|
@@ -38,7 +38,7 @@ resource_type: AWS::RDS::DBCluster
|
|
|
38
38
|
- `EnableIAMDatabaseAuthentication` (`boolean`, optional): A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information, see [IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide.* Valid for: Aurora DB clusters only
|
|
39
39
|
- `EnableLocalWriteForwarding` (`boolean`, optional): Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. Valid for: Aurora DB clusters only
|
|
40
40
|
- `Endpoint` (`DbCluster_Endpoint`, optional)
|
|
41
|
-
- `Engine` (`
|
|
41
|
+
- `Engine` (`DbCluster_Engine`, optional): The name of the database engine to be used for this DB cluster. Valid Values: + ``aurora-mysql`` + ``aurora-postgresql`` + ``mysql`` + ``postgres`` Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
42
42
|
- `EngineLifecycleSupport` (`string`, optional): The life cycle type for this DB cluster. By default, this value is set to ``open-source-rds-extended-support``, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to ``open-source-rds-extended-support-disabled``. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: + Amazon Aurora - [Amazon RDS Extended Support with Amazon Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html) in the *Amazon Aurora User Guide* + Amazon RDS - [Amazon RDS Extended Support with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide* Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: ``open-source-rds-extended-support | open-source-rds-extended-support-disabled`` Default: ``open-source-rds-extended-support``
|
|
43
43
|
- `EngineMode` (`string`, optional): The DB engine mode of the DB cluster, either ``provisioned`` or ``serverless``. The ``serverless`` engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the ``provisioned`` engine mode. For information about limitations and requirements for Serverless DB clusters, see the following sections in the *Amazon Aurora User Guide*: + [Limitations of Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations) + [Requirements for Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html) Valid for Cluster Type: Aurora DB clusters only
|
|
44
44
|
- `EngineVersion` (`string`, optional): The version number of the database engine to use. Don't use this property if your DB cluster is a member of a global database cluster. Instead, specify the ``EngineVersion`` property on the [AWS::RDS::GlobalCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html) resource. Major version upgrades aren't supported for individual members of a global cluster. Use ``ModifyGlobalCluster`` to upgrade all members of the global cluster. To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (8.0-compatible), use the following command: ``aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"`` You can supply either ``5.7`` or ``8.0`` to use the default engine version for Aurora MySQL version 2 or version 3, respectively. To list all of the available engine versions for Aurora PostgreSQL, use the following command: ``aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"`` To list all of the available engine versions for RDS for MySQL, use the following command: ``aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"`` To list all of the available engine versions for RDS for PostgreSQL, use the following command: ``aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"`` Aurora MySQL* For information, see [Database engine updates for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) in the *Amazon Aurora User Guide*. Aurora PostgreSQL* For information, see [Amazon Aurora PostgreSQL releases and engine versions](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) in the *Amazon Aurora User Guide*. MySQL* For information, see [Amazon RDS for MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide*. PostgreSQL* For information, see [Amazon RDS for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the *Amazon RDS User Guide*. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
@@ -56,7 +56,7 @@ resource_type: AWS::RDS::DBInstance
|
|
|
56
56
|
- `EnableIAMDatabaseAuthentication` (`boolean`, optional): A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* Amazon Aurora* Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
|
|
57
57
|
- `EnablePerformanceInsights` (`boolean`, optional): Specifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*. This setting doesn't apply to RDS Custom DB instances.
|
|
58
58
|
- `Endpoint` (`DbInstance_Endpoint`, optional)
|
|
59
|
-
- `Engine` (`
|
|
59
|
+
- `Engine` (`DbInstance_Engine`, optional): The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the ``Engine`` value in your templates from ``oracle-ee`` to ``oracle-ee-cdb`` or from ``oracle-se2`` to ``oracle-se2-cdb``. Converting to the CDB architecture requires an interruption. Valid Values: + ``aurora-mysql`` (for Aurora MySQL DB instances) + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances) + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances) + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances) + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances) + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances) + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances) + ``db2-ae`` + ``db2-se`` + ``mariadb`` + ``mysql`` + ``oracle-ee`` + ``oracle-ee-cdb`` + ``oracle-se2`` + ``oracle-se2-cdb`` + ``postgres`` + ``sqlserver-ee`` + ``sqlserver-se`` + ``sqlserver-ex`` + ``sqlserver-web``
|
|
60
60
|
- `EngineLifecycleSupport` (`string`, optional): The life cycle type for this DB instance. By default, this value is set to ``open-source-rds-extended-support``, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to ``open-source-rds-extended-support-disabled``. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see [Amazon RDS Extended Support with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*. Valid Values: ``open-source-rds-extended-support | open-source-rds-extended-support-disabled`` Default: ``open-source-rds-extended-support``
|
|
61
61
|
- `EngineVersion` (`string`, optional): The version number of the database engine to use. For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora* Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2* See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* MariaDB* See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* Microsoft SQL Server* See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.* MySQL* See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* Oracle* See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.* PostgreSQL* See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.*
|
|
62
62
|
- `InstanceCreateTime` (`string`, optional)
|
|
@@ -25,7 +25,7 @@ resource_type: AWS::EC2::Volume
|
|
|
25
25
|
- `Throughput` (`number`, optional): The throughput to provision for a volume, with a maximum of 2,000 MiB/s. This parameter is valid only for ``gp3`` volumes. The default value is 125. Valid Range: Minimum value of 125. Maximum value of 2000. The maximum ratio of throughput to IOPS is 0.25 MiB/s per IOPS. For example, a volume with 3,000 IOPS can have a maximum throughput of 750 MiB/s (3,000 x 0.25).
|
|
26
26
|
- `VolumeId` (`string`, optional)
|
|
27
27
|
- `VolumeInitializationRate` (`number`, optional): Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. This parameter is supported only for volumes created from snapshots. Omit this parameter if: + You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. + You want to create a volume that is initialized at the default rate. For more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EC2 User Guide*. Valid range: 100 - 300 MiB/s
|
|
28
|
-
- `VolumeType` (`
|
|
28
|
+
- `VolumeType` (`EC2Volume_VolumeType`, optional): The volume type. This parameter can be one of the following values: + General Purpose SSD: ``gp2`` | ``gp3`` + Provisioned IOPS SSD: ``io1`` | ``io2`` + Throughput Optimized HDD: ``st1`` + Cold HDD: ``sc1`` + Magnetic: ``standard`` Throughput Optimized HDD (``st1``) and Cold HDD (``sc1``) volumes can't be used as boot volumes. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the *Amazon EBS User Guide*. Default: ``gp2``
|
|
29
29
|
|
|
30
30
|
## Attributes
|
|
31
31
|
|
|
@@ -34,7 +34,7 @@ resource_type: AWS::Lambda::Function
|
|
|
34
34
|
- `PublishToLatestPublished` (`boolean`, optional)
|
|
35
35
|
- `RecursiveLoop` (`Function_RecursiveLoop`, optional): The status of your function's recursive loop detection configuration. When this value is set to ``Allow``and Lambda detects your function being invoked as part of a recursive loop, it doesn't take any action. When this value is set to ``Terminate`` and Lambda detects your function being invoked as part of a recursive loop, it stops your function being invoked and notifies you.
|
|
36
36
|
- `ReservedConcurrentExecutions` (`number`, optional): The number of simultaneous executions to reserve for the function.
|
|
37
|
-
- `Runtime` (`
|
|
37
|
+
- `Runtime` (`Function_Runtime`, optional): The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image. The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see [Runtime use after deprecation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels). For a list of all currently supported runtimes, see [Supported runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported).
|
|
38
38
|
- `RuntimeManagementConfig` (`Function_RuntimeManagementConfig`, optional): Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html).
|
|
39
39
|
- `SnapStart` (`Function_SnapStart`, optional): The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.
|
|
40
40
|
- `SnapStartResponse` (`Function_SnapStartResponse`, optional)
|
|
@@ -28,7 +28,7 @@ resource_type: AWS::EC2::Instance
|
|
|
28
28
|
- `ImageId` (`string`, optional): The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
|
|
29
29
|
- `InstanceId` (`string`, optional): The EC2 Instance ID.
|
|
30
30
|
- `InstanceInitiatedShutdownBehavior` (`string`, optional): Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
|
|
31
|
-
- `InstanceType` (`
|
|
31
|
+
- `InstanceType` (`Instance_InstanceType`, optional): The instance type.
|
|
32
32
|
- `Ipv6AddressCount` (`number`, optional): [EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet.
|
|
33
33
|
- `Ipv6Addresses` (`Instance_InstanceIpv6Address[]`, optional): [EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface.
|
|
34
34
|
- `KernelId` (`string`, optional): The ID of the kernel.
|
|
@@ -54,7 +54,7 @@ resource_type: AWS::EC2::Instance
|
|
|
54
54
|
- `State` (`Instance_State`, optional): The current state of the instance.
|
|
55
55
|
- `SubnetId` (`string`, optional): [EC2-VPC] The ID of the subnet to launch the instance into.
|
|
56
56
|
- `Tags` (`Instance_Tag[]`, optional): The tags to add to the instance.
|
|
57
|
-
- `Tenancy` (`
|
|
57
|
+
- `Tenancy` (`Instance_Tenancy`, optional): The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
|
|
58
58
|
- `UserData` (`string`, optional): The user data to make available to the instance.
|
|
59
59
|
- `Volumes` (`Instance_Volume[]`, optional): The volumes to attach to the instance.
|
|
60
60
|
- `VpcId` (`string`, optional): The ID of the VPC that the instance is running in.
|
|
@@ -23,7 +23,7 @@ resource_type: AWS::ElasticLoadBalancingV2::LoadBalancer
|
|
|
23
23
|
- `LoadBalancerName` (`string`, optional)
|
|
24
24
|
- `MinimumLoadBalancerCapacity` (`LoadBalancer_MinimumLoadBalancerCapacity`, optional): The minimum capacity for a load balancer.
|
|
25
25
|
- `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.
|
|
26
|
-
- `Scheme` (`
|
|
26
|
+
- `Scheme` (`LoadBalancer_Scheme`, 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.
|
|
27
27
|
- `SecurityGroups` (`string[]`, optional): [Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
|
|
28
28
|
- `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.
|
|
29
29
|
- `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.
|
|
@@ -13,8 +13,8 @@ resource_type: AWS::ApplicationAutoScaling::ScalableTarget
|
|
|
13
13
|
- `MaxCapacity` (`number`, required): The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand.
|
|
14
14
|
- `MinCapacity` (`number`, required): The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand.
|
|
15
15
|
- `ResourceId` (`string`, required): The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. + ECS service - The resource type is ``service`` and the unique identifier is the cluster name and service name. Example: ``service/my-cluster/my-service``. + Spot Fleet - The resource type is ``spot-fleet-request`` and the unique identifier is the Spot Fleet request ID. Example: ``spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE``. + EMR cluster - The resource type is ``instancegroup`` and the unique identifier is the cluster ID and instance group ID. Example: ``instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0``. + AppStream 2.0 fleet - The resource type is ``fleet`` and the unique identifier is the fleet name. Example: ``fleet/sample-fleet``. + DynamoDB table - The resource type is ``table`` and the unique identifier is the table name. Example: ``table/my-table``. + DynamoDB global secondary index - The resource type is ``index`` and the unique identifier is the index name. Example: ``table/my-table/index/my-table-index``. + Aurora DB cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:my-db-cluster``. + SageMaker endpoint variant - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``. + Custom resources are not supported with a resource type. This parameter must specify the ``OutputValue`` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource). + Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE``. + Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE``. + Lambda provisioned concurrency - The resource type is ``function`` and the unique identifier is the function name with a function version or alias name suffix that is not ``$LATEST``. Example: ``function:my-function:prod`` or ``function:my-function:1``. + Amazon Keyspaces table - The resource type is ``table`` and the unique identifier is the table name. Example: ``keyspace/mykeyspace/table/mytable``. + Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: ``arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5``. + Amazon ElastiCache replication group - The resource type is ``replication-group`` and the unique identifier is the replication group name. Example: ``replication-group/mycluster``. + Amazon ElastiCache cache cluster - The resource type is ``cache-cluster`` and the unique identifier is the cache cluster name. Example: ``cache-cluster/mycluster``. + Neptune cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:mycluster``. + SageMaker serverless endpoint - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``. + SageMaker inference component - The resource type is ``inference-component`` and the unique identifier is the resource ID. Example: ``inference-component/my-inference-component``. + Pool of WorkSpaces - The resource type is ``workspacespool`` and the unique identifier is the pool ID. Example: ``workspacespool/wspool-123456``.
|
|
16
|
-
- `ScalableDimension` (`
|
|
17
|
-
- `ServiceNamespace` (`
|
|
16
|
+
- `ScalableDimension` (`ScalableTarget_ScalableDimension`, required): The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. + ``ecs:service:DesiredCount`` - The task count of an ECS service. + ``elasticmapreduce:instancegroup:InstanceCount`` - The instance count of an EMR Instance Group. + ``ec2:spot-fleet-request:TargetCapacity`` - The target capacity of a Spot Fleet. + ``appstream:fleet:DesiredCapacity`` - The capacity of an AppStream 2.0 fleet. + ``dynamodb:table:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB table. + ``dynamodb:table:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB table. + ``dynamodb:index:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB global secondary index. + ``dynamodb:index:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB global secondary index. + ``rds:cluster:ReadReplicaCount`` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. + ``sagemaker:variant:DesiredInstanceCount`` - The number of EC2 instances for a SageMaker model endpoint variant. + ``custom-resource:ResourceType:Property`` - The scalable dimension for a custom resource provided by your own application or service. + ``comprehend:document-classifier-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend document classification endpoint. + ``comprehend:entity-recognizer-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend entity recognizer endpoint. + ``lambda:function:ProvisionedConcurrency`` - The provisioned concurrency for a Lambda function. + ``cassandra:table:ReadCapacityUnits`` - The provisioned read capacity for an Amazon Keyspaces table. + ``cassandra:table:WriteCapacityUnits`` - The provisioned write capacity for an Amazon Keyspaces table. + ``kafka:broker-storage:VolumeSize`` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. + ``elasticache:cache-cluster:Nodes`` - The number of nodes for an Amazon ElastiCache cache cluster. + ``elasticache:replication-group:NodeGroups`` - The number of node groups for an Amazon ElastiCache replication group. + ``elasticache:replication-group:Replicas`` - The number of replicas per node group for an Amazon ElastiCache replication group. + ``neptune:cluster:ReadReplicaCount`` - The count of read replicas in an Amazon Neptune DB cluster. + ``sagemaker:variant:DesiredProvisionedConcurrency`` - The provisioned concurrency for a SageMaker serverless endpoint. + ``sagemaker:inference-component:DesiredCopyCount`` - The number of copies across an endpoint for a SageMaker inference component. + ``workspaces:workspacespool:DesiredUserSessions`` - The number of user sessions for the WorkSpaces in the pool.
|
|
17
|
+
- `ServiceNamespace` (`ScalableTarget_ServiceNamespace`, required): The namespace of the AWS service that provides the resource, or a ``custom-resource``.
|
|
18
18
|
- `Id` (`string`, optional)
|
|
19
19
|
- `RoleARN` (`string`, optional): Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see [How Application Auto Scaling works with IAM](https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html) in the *Application Auto Scaling User Guide*. To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the [Service-linked roles](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-service-linked-roles.html) topic in the *Application Auto Scaling User Guide*. Look for the ARN in the table at the bottom of the page.
|
|
20
20
|
- `ScheduledActions` (`ScalableTarget_ScheduledAction[]`, optional): The scheduled actions for the scalable target. Duplicates aren't allowed.
|
|
@@ -10,7 +10,7 @@ resource_type: AWS::SNS::Subscription
|
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
13
|
-
- `Protocol` (`
|
|
13
|
+
- `Protocol` (`Subscription_Protocol`, required): The subscription's protocol.
|
|
14
14
|
- `TopicArn` (`string`, required): The ARN of the topic to subscribe to.
|
|
15
15
|
- `Arn` (`string`, optional): Arn of the subscription
|
|
16
16
|
- `DeliveryPolicy` (`Record<string, unknown>`, optional): The delivery policy JSON assigned to the subscription. Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic.
|
package/dist/okf/types/Table.md
CHANGED
|
@@ -13,7 +13,7 @@ resource_type: AWS::DynamoDB::Table
|
|
|
13
13
|
- `KeySchema` (`any`, required): Specifies the attributes that make up the primary key for the table. The attributes in the ``KeySchema`` property must also be defined in the ``AttributeDefinitions`` property.
|
|
14
14
|
- `Arn` (`string`, optional)
|
|
15
15
|
- `AttributeDefinitions` (`Table_AttributeDefinition[]`, optional): A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Replacement if you edit an existing AttributeDefinition.
|
|
16
|
-
- `BillingMode` (`
|
|
16
|
+
- `BillingMode` (`Table_BillingMode`, optional): Specify how you are charged for read and write throughput and how you manage capacity. Valid values include: + ``PAY_PER_REQUEST`` - We recommend using ``PAY_PER_REQUEST`` for most DynamoDB workloads. ``PAY_PER_REQUEST`` sets the billing mode to [On-demand capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode.html). + ``PROVISIONED`` - We recommend using ``PROVISIONED`` for steady workloads with predictable growth where capacity requirements can be reliably forecasted. ``PROVISIONED`` sets the billing mode to [Provisioned capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html). If not specified, the default is ``PROVISIONED``.
|
|
17
17
|
- `ContributorInsightsSpecification` (`Table_ContributorInsightsSpecification`, optional): The settings used to specify whether to enable CloudWatch Contributor Insights for the table and define which events to monitor.
|
|
18
18
|
- `DeletionProtectionEnabled` (`boolean`, optional): Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Developer Guide*.
|
|
19
19
|
- `GlobalSecondaryIndexes` (`Table_GlobalSecondaryIndex[]`, optional): Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ``ACTIVE``. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions: + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.
|
|
@@ -22,7 +22,7 @@ resource_type: AWS::ElasticLoadBalancingV2::TargetGroup
|
|
|
22
22
|
- `Matcher` (`TargetGroup_Matcher`, optional): [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.
|
|
23
23
|
- `Name` (`string`, optional): The name of the target group.
|
|
24
24
|
- `Port` (`number`, optional): The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.
|
|
25
|
-
- `Protocol` (`
|
|
25
|
+
- `Protocol` (`TargetGroup_Protocol`, optional): The protocol to use for routing traffic to the targets.
|
|
26
26
|
- `ProtocolVersion` (`string`, optional): [HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.
|
|
27
27
|
- `Tags` (`TargetGroup_Tag[]`, optional): The tags.
|
|
28
28
|
- `TargetControlPort` (`number`, optional): The port that the target control agent uses to communicate the available capacity of targets to the load balancer.
|
|
@@ -31,7 +31,7 @@ resource_type: AWS::ElasticLoadBalancingV2::TargetGroup
|
|
|
31
31
|
- `TargetGroupFullName` (`string`, optional): The full name of the target group.
|
|
32
32
|
- `TargetGroupName` (`string`, optional): The name of the target group.
|
|
33
33
|
- `Targets` (`TargetGroup_TargetDescription[]`, optional): The targets.
|
|
34
|
-
- `TargetType` (`
|
|
34
|
+
- `TargetType` (`TargetGroup_TargetType`, optional): The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
|
|
35
35
|
- `UnhealthyThresholdCount` (`number`, optional): The number of consecutive health check failures required before considering a target unhealthy.
|
|
36
36
|
- `VpcId` (`string`, optional): The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply.
|
|
37
37
|
|