cdk-common 2.0.152 → 2.0.153
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/.jsii +9 -3
- package/API.md +5 -0
- package/changelog.md +1 -1
- package/lib/main.js +1 -1
- package/lib/managed-policies.d.ts +1 -0
- package/lib/managed-policies.d.ts.map +1 -1
- package/lib/managed-policies.js +2 -1
- package/node_modules/@aws-cdk/assert/package.json +8 -8
- package/node_modules/@aws-cdk/cfnspec/CHANGELOG.md +241 -0
- package/node_modules/@aws-cdk/cfnspec/cfn.version +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/build-tools/index.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/build-tools/massage-spec.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/build-tools/patch-set.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/build-tools/scrutiny.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/build-tools/validate-cfn.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/index.html +5 -5
- package/node_modules/@aws-cdk/cfnspec/coverage/junit.xml +7473 -7145
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/build-tools/index.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/build-tools/massage-spec.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/build-tools/patch-set.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/build-tools/scrutiny.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/build-tools/validate-cfn.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/index.html +5 -5
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/canned-metrics/canned-metrics-schema.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/canned-metrics/index.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/canned-metrics.ts.html +9 -9
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/index.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/index.ts.html +18 -18
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/schema/augmentation.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/schema/base-types.ts.html +3 -3
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/schema/index.html +5 -5
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/schema/index.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/schema/property.ts.html +53 -20
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/schema/resource-type.ts.html +5 -5
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov-report/lib/schema/specification.ts.html +2 -2
- package/node_modules/@aws-cdk/cfnspec/coverage/lcov.info +203 -198
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/canned-metrics/canned-metrics-schema.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/canned-metrics/index.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/canned-metrics.ts.html +9 -9
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/index.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/index.ts.html +18 -18
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/schema/augmentation.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/schema/base-types.ts.html +3 -3
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/schema/index.html +5 -5
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/schema/index.ts.html +1 -1
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/schema/property.ts.html +53 -20
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/schema/resource-type.ts.html +5 -5
- package/node_modules/@aws-cdk/cfnspec/coverage/lib/schema/specification.ts.html +2 -2
- package/node_modules/@aws-cdk/cfnspec/lib/schema/property.d.ts +4 -0
- package/node_modules/@aws-cdk/cfnspec/lib/schema/property.js +8 -3
- package/node_modules/@aws-cdk/cfnspec/package.json +3 -3
- package/node_modules/@aws-cdk/cfnspec/spec/cfn-docs.json +2065 -93
- package/node_modules/@aws-cdk/cfnspec/spec/specification.json +1060 -53
- package/node_modules/@aws-cdk/cfnspec/tsconfig.tsbuildinfo +4 -4
- package/node_modules/@aws-cdk/cloudformation-diff/lib/format-table.js +3 -3
- package/node_modules/@aws-cdk/cloudformation-diff/package.json +4 -4
- package/node_modules/object-inspect/CHANGELOG.md +10 -0
- package/node_modules/object-inspect/index.js +1 -1
- package/node_modules/object-inspect/package.json +18 -9
- package/node_modules/object-inspect/test/has.js +6 -25
- package/node_modules/object-inspect/test/values.js +3 -3
- package/package.json +3 -3
- package/releasetag.txt +1 -1
- package/version.txt +1 -1
- package/node_modules/object-inspect/.eslintignore +0 -1
|
@@ -168,7 +168,7 @@
|
|
|
168
168
|
"properties": {
|
|
169
169
|
"CsrExtensions": "Specifies information to be added to the extension section of the certificate signing request (CSR).",
|
|
170
170
|
"KeyAlgorithm": "Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.",
|
|
171
|
-
"KeyStorageSecurityStandard": "Specifies a cryptographic key management compliance standard used for handling CA keys.\n\nDefault: FIPS_140_2_LEVEL_3_OR_HIGHER\n\
|
|
171
|
+
"KeyStorageSecurityStandard": "Specifies a cryptographic key management compliance standard used for handling CA keys.\n\nDefault: FIPS_140_2_LEVEL_3_OR_HIGHER\n\n*Note:* `FIPS_140_2_LEVEL_3_OR_HIGHER` is not supported in the following Regions:\n\n- ap-northeast-3\n- ap-southeast-3\n\nWhen creating a CA in these Regions, you must provide `FIPS_140_2_LEVEL_2_OR_HIGHER` as the argument for `KeyStorageSecurityStandard` . Failure to do this results in an `InvalidArgsException` with the message, \"A certificate authority cannot be created in this region with the specified security standard.\"",
|
|
172
172
|
"RevocationConfiguration": "Information about the certificate revocation list (CRL) created and maintained by your private CA. Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your certificate authority can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates that have been revoked.",
|
|
173
173
|
"SigningAlgorithm": "Name of the algorithm your private CA uses to sign certificate requests.\n\nThis parameter should not be confused with the `SigningAlgorithm` parameter used to sign certificates when they are issued.",
|
|
174
174
|
"Subject": "Structure that contains X.500 distinguished name information for your private CA.",
|
|
@@ -2464,11 +2464,11 @@
|
|
|
2464
2464
|
"description": "Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the `Scheduled` trigger type.",
|
|
2465
2465
|
"properties": {
|
|
2466
2466
|
"DataPullMode": "Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.",
|
|
2467
|
-
"ScheduleEndTime": "
|
|
2467
|
+
"ScheduleEndTime": "The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as `2022-04-27T13:00:00-07:00` .",
|
|
2468
2468
|
"ScheduleExpression": "The scheduling expression that determines the rate at which the schedule will run, for example `rate(5minutes)` .",
|
|
2469
2469
|
"ScheduleOffset": "Specifies the optional offset that is added to the time interval for a schedule-triggered flow.",
|
|
2470
|
-
"ScheduleStartTime": "
|
|
2471
|
-
"TimeZone": "Specifies the time zone used when referring to the
|
|
2470
|
+
"ScheduleStartTime": "The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as `2022-04-26T13:00:00-07:00` .",
|
|
2471
|
+
"TimeZone": "Specifies the time zone used when referring to the dates and times of a scheduled flow, such as `America/New_York` . This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow.\n\nIf you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps. For example, the UTC offsets for the `America/New_York` timezone are `-04:00` EDT and `-05:00 EST` ."
|
|
2472
2472
|
}
|
|
2473
2473
|
},
|
|
2474
2474
|
"AWS::AppFlow::Flow.ServiceNowSourceProperties": {
|
|
@@ -2927,7 +2927,7 @@
|
|
|
2927
2927
|
},
|
|
2928
2928
|
"AWS::AppMesh::Mesh.MeshServiceDiscovery": {
|
|
2929
2929
|
"attributes": {},
|
|
2930
|
-
"description": "",
|
|
2930
|
+
"description": "An object that represents the service discovery information for a service mesh.",
|
|
2931
2931
|
"properties": {}
|
|
2932
2932
|
},
|
|
2933
2933
|
"AWS::AppMesh::Mesh.MeshSpec": {
|
|
@@ -5169,30 +5169,31 @@
|
|
|
5169
5169
|
"properties": {
|
|
5170
5170
|
"AutoScalingGroupName": "The name of the Auto Scaling group. This name must be unique per Region per account.",
|
|
5171
5171
|
"AvailabilityZones": "A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into EC2-Classic or the default VPC subnet in each Availability Zone when not using the `VPCZoneIdentifier` property, or for attaching a network interface when an existing network interface ID is specified in a launch template.",
|
|
5172
|
-
"CapacityRebalance": "Indicates whether Capacity Rebalancing is enabled. For more information, see [Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5172
|
+
"CapacityRebalance": "Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) in the in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5173
5173
|
"Context": "Reserved.",
|
|
5174
5174
|
"Cooldown": "*Only needed if you use simple scaling policies.*\n\nThe amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nDefault: `300` seconds",
|
|
5175
|
+
"DefaultInstanceWarmup": "Not currently supported by CloudFormation.",
|
|
5175
5176
|
"DesiredCapacity": "The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling.\n\nThe number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group.\n\nCloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.",
|
|
5176
|
-
"DesiredCapacityType": "The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports `DesiredCapacityType` for attribute-based instance type selection only. For more information, see [
|
|
5177
|
-
"HealthCheckGracePeriod": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass these health checks after they enter the `InService` state. For more information, see [Health
|
|
5177
|
+
"DesiredCapacityType": "The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports `DesiredCapacityType` for attribute-based instance type selection only. For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nBy default, Amazon EC2 Auto Scaling specifies `units` , which translates into number of instances.\n\nValid values: `units` | `vcpu` | `memory-mib`",
|
|
5178
|
+
"HealthCheckGracePeriod": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass these health checks after they enter the `InService` state. For more information, see [Health check grace period](https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period) in the *Amazon EC2 Auto Scaling User Guide* .\n\nDefault: `0` seconds",
|
|
5178
5179
|
"HealthCheckType": "The service to use for the health checks. The valid values are `EC2` (default) and `ELB` . If you configure an Auto Scaling group to use load balancer (ELB) health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks. For more information, see [Health checks for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5179
5180
|
"InstanceId": "The ID of the instance used to base the launch configuration on. For more information, see [Create an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nIf you specify `LaunchTemplate` , `MixedInstancesPolicy` , or `LaunchConfigurationName` , don't specify `InstanceId` .",
|
|
5180
|
-
"LaunchConfigurationName": "The name of the
|
|
5181
|
-
"LaunchTemplate": "
|
|
5181
|
+
"LaunchConfigurationName": "The name of the launch configuration to use to launch instances.\n\nRequired only if you don't specify `LaunchTemplate` , `MixedInstancesPolicy` , or `InstanceId` .",
|
|
5182
|
+
"LaunchTemplate": "Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a `MixedInstancesPolicy` . For more information about creating launch templates, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nIf you omit this property, you must specify `MixedInstancesPolicy` , `LaunchConfigurationName` , or `InstanceId` .",
|
|
5182
5183
|
"LifecycleHookSpecificationList": "One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.",
|
|
5183
5184
|
"LoadBalancerNames": "A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the `TargetGroupARNs` property instead.",
|
|
5184
|
-
"MaxInstanceLifetime": "The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [
|
|
5185
|
+
"MaxInstanceLifetime": "The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replacing Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5185
5186
|
"MaxSize": "The maximum size of the group.\n\n> With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above `MaxSize` to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above `MaxSize` by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).",
|
|
5186
5187
|
"MetricsCollection": "Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.",
|
|
5187
5188
|
"MinSize": "The minimum size of the group.",
|
|
5188
5189
|
"MixedInstancesPolicy": "An embedded object that specifies a mixed instances policy.\n\nThe policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types.\n\nFor more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5189
|
-
"NewInstancesProtectedFromScaleIn": "Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [
|
|
5190
|
+
"NewInstancesProtectedFromScaleIn": "Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Using instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5190
5191
|
"NotificationConfigurations": "Configures an Auto Scaling group to send notifications when specified events take place.",
|
|
5191
|
-
"PlacementGroup": "The name of the placement group into which
|
|
5192
|
-
"ServiceLinkedRoleARN": "The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS
|
|
5193
|
-
"Tags": "One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5194
|
-
"TargetGroupARNs": "
|
|
5195
|
-
"TerminationPolicies": "A policy or a list of policies that are used to select the
|
|
5192
|
+
"PlacementGroup": "The name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances* .\n\n> A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.",
|
|
5193
|
+
"ServiceLinkedRoleARN": "The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named `AWSServiceRoleForAutoScaling` , which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5194
|
+
"Tags": "One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5195
|
+
"TargetGroupARNs": "The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group. Instances are registered as targets in a target group, and traffic is routed to the target group. For more information, see [Elastic Load Balancing and Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5196
|
+
"TerminationPolicies": "A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Work with Amazon EC2 Auto Scaling termination policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nValid values: `Default` | `AllocationStrategy` | `ClosestToNextInstanceHour` | `NewestInstance` | `OldestInstance` | `OldestLaunchConfiguration` | `OldestLaunchTemplate` | `arn:aws:lambda:region:account-id:function:my-function:my-alias`",
|
|
5196
5197
|
"VPCZoneIdentifier": "A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created. If you specify `VPCZoneIdentifier` with `AvailabilityZones` , the subnets that you specify for this property must reside in those Availability Zones.\n\nIf this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html) .\n\nConditional: If your account supports EC2-Classic and VPC, this property is required to launch instances into a VPC.\n\n> When you update `VPCZoneIdentifier` , this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html) ."
|
|
5197
5198
|
}
|
|
5198
5199
|
},
|
|
@@ -5222,7 +5223,7 @@
|
|
|
5222
5223
|
},
|
|
5223
5224
|
"AWS::AutoScaling::AutoScalingGroup.InstanceRequirements": {
|
|
5224
5225
|
"attributes": {},
|
|
5225
|
-
"description": "`InstanceRequirements` specifies a set of requirements for the types of instances that can be launched by an `AWS::AutoScaling::AutoScalingGroup` resource. `InstanceRequirements` is a property of the `LaunchTemplateOverrides` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type.\n\nYou must specify `VCpuCount` and `MemoryMiB` , but all other properties are optional. Any unspecified optional property is set to its default.\n\nWhen you specify multiple properties, you get instance types that satisfy all of the specified properties. If you specify multiple values for a property, you get instance types that satisfy any of the specified values.\n\nFor
|
|
5226
|
+
"description": "`InstanceRequirements` specifies a set of requirements for the types of instances that can be launched by an `AWS::AutoScaling::AutoScalingGroup` resource. `InstanceRequirements` is a property of the `LaunchTemplateOverrides` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type.\n\nYou must specify `VCpuCount` and `MemoryMiB` , but all other properties are optional. Any unspecified optional property is set to its default.\n\nWhen you specify multiple properties, you get instance types that satisfy all of the specified properties. If you specify multiple values for a property, you get instance types that satisfy any of the specified values.\n\nFor an example template, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) .\n\nFor more information, see [Create an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5226
5227
|
"properties": {
|
|
5227
5228
|
"AcceleratorCount": "The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.\n\nTo exclude accelerator-enabled instance types, set `Max` to `0` .\n\nDefault: No minimum or maximum",
|
|
5228
5229
|
"AcceleratorManufacturers": "Indicates whether instance types must have accelerators by specific manufacturers.\n\n- For instance types with NVIDIA devices, specify `nvidia` .\n- For instance types with AMD devices, specify `amd` .\n- For instance types with AWS devices, specify `amazon-web-services` .\n- For instance types with Xilinx devices, specify `xilinx` .\n\nDefault: Any manufacturer",
|
|
@@ -5251,12 +5252,12 @@
|
|
|
5251
5252
|
"attributes": {},
|
|
5252
5253
|
"description": "`InstancesDistribution` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type that describes an instances distribution for an Auto Scaling group. All properties have a default value, which is the value that is used or assumed when the property is not specified.\n\nThe instances distribution specifies the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities.\n\nFor more information and example configurations, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5253
5254
|
"properties": {
|
|
5254
|
-
"OnDemandAllocationStrategy": "The order of the launch template overrides to use in fulfilling On-Demand capacity.\n\nIf you specify `lowest-price` , Amazon EC2 Auto Scaling uses price to determine the order, launching the lowest price first.\n\nIf you specify `prioritized` , Amazon EC2 Auto Scaling uses the priority that you assigned to each launch template override, launching the highest priority first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on.\n\nDefault: `lowest-price` for Auto Scaling groups that specify
|
|
5255
|
-
"OnDemandBaseCapacity": "The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales.\n\nIf you specify weights for the instance types in the overrides, the base capacity is measured in the same unit of measurement as the instance types. If you specify
|
|
5255
|
+
"OnDemandAllocationStrategy": "The order of the launch template overrides to use in fulfilling On-Demand capacity.\n\nIf you specify `lowest-price` , Amazon EC2 Auto Scaling uses price to determine the order, launching the lowest price first.\n\nIf you specify `prioritized` , Amazon EC2 Auto Scaling uses the priority that you assigned to each launch template override, launching the highest priority first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on.\n\nDefault: `lowest-price` for Auto Scaling groups that specify `InstanceRequirements` in the overrides and `prioritized` for Auto Scaling groups that don't.\n\nValid values: `lowest-price` | `prioritized`",
|
|
5256
|
+
"OnDemandBaseCapacity": "The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales.\n\nIf you specify weights for the instance types in the overrides, the base capacity is measured in the same unit of measurement as the instance types. If you specify `InstanceRequirements` in the overrides, the base capacity is measured in the same unit of measurement as your group's desired capacity.\n\nDefault: `0`\n\n> An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.",
|
|
5256
5257
|
"OnDemandPercentageAboveBaseCapacity": "Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond `OnDemandBaseCapacity` . Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.\n\nDefault: `100`\n\n> An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.",
|
|
5257
|
-
"SpotAllocationStrategy": "
|
|
5258
|
-
"SpotInstancePools": "The number of Spot Instance pools
|
|
5259
|
-
"SpotMaxPrice": "The maximum price per unit hour that you are willing to pay for a Spot Instance. If you
|
|
5258
|
+
"SpotAllocationStrategy": "Indicates how to allocate instances across Spot Instance pools.\n\nIf the allocation strategy is `lowest-price` , the Auto Scaling group launches instances using the Spot pools with the lowest price, and evenly allocates your instances across the number of Spot pools that you specify.\n\nIf the allocation strategy is `capacity-optimized` (recommended), the Auto Scaling group launches instances using Spot pools that are optimally chosen based on the available Spot capacity. Alternatively, you can use `capacity-optimized-prioritized` and set the order of instance types in the list of launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best-effort basis but optimizes for capacity first.\n\nDefault: `lowest-price`\n\nValid values: `lowest-price` | `capacity-optimized` | `capacity-optimized-prioritized`",
|
|
5259
|
+
"SpotInstancePools": "The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the Spot allocation strategy is `lowest-price` . Value must be in the range of 1–20.\n\nDefault: `2`",
|
|
5260
|
+
"SpotMaxPrice": "The maximum price per unit hour that you are willing to pay for a Spot Instance. If you keep the value at its default (unspecified), Amazon EC2 Auto Scaling uses the On-Demand price as the maximum Spot price. To remove a value that you previously set, include the property but specify an empty string (\"\") for the value.\n\n> If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. \n\nValid Range: Minimum value of 0.001"
|
|
5260
5261
|
}
|
|
5261
5262
|
},
|
|
5262
5263
|
"AWS::AutoScaling::AutoScalingGroup.LaunchTemplate": {
|
|
@@ -5264,22 +5265,22 @@
|
|
|
5264
5265
|
"description": "`LaunchTemplate` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type that describes a launch template and overrides. The overrides are used to override the instance type specified by the launch template with multiple instance types that can be used to launch On-Demand Instances and Spot Instances.",
|
|
5265
5266
|
"properties": {
|
|
5266
5267
|
"LaunchTemplateSpecification": "The launch template to use.",
|
|
5267
|
-
"Overrides": "Any properties that you specify override the same properties in the launch template. If not provided, Amazon EC2 Auto Scaling uses the instance type or instance requirements specified in the launch template when it launches an instance.\n\nThe overrides can include either one or more instance types or a set of instance requirements, but not both."
|
|
5268
|
+
"Overrides": "Any properties that you specify override the same properties in the launch template. If not provided, Amazon EC2 Auto Scaling uses the instance type or instance type requirements specified in the launch template when it launches an instance.\n\nThe overrides can include either one or more instance types or a set of instance requirements, but not both."
|
|
5268
5269
|
}
|
|
5269
5270
|
},
|
|
5270
5271
|
"AWS::AutoScaling::AutoScalingGroup.LaunchTemplateOverrides": {
|
|
5271
5272
|
"attributes": {},
|
|
5272
5273
|
"description": "`LaunchTemplateOverrides` is a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type that describes an override for a launch template.\n\nIf you supply your own instance types, the maximum number of instance types that can be associated with an Auto Scaling group is 40. The maximum number of distinct launch templates you can define for an Auto Scaling group is 20.",
|
|
5273
5274
|
"properties": {
|
|
5274
|
-
"InstanceRequirements": "The instance requirements. When you specify instance requirements, Amazon EC2 Auto Scaling finds instance types that satisfy your requirements, and then uses your On-Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of specific instance types.\n\n> `InstanceRequirements` are incompatible with the `InstanceType`
|
|
5275
|
-
"InstanceType": "The instance type, such as `m3.xlarge` . You must use an instance type that is supported in your requested Region and Availability Zones. For more information, see [
|
|
5275
|
+
"InstanceRequirements": "The instance requirements. When you specify instance requirements, Amazon EC2 Auto Scaling finds instance types that satisfy your requirements, and then uses your On-Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of specific instance types.\n\n> `InstanceRequirements` are incompatible with the `InstanceType` and `WeightedCapacity` properties.",
|
|
5276
|
+
"InstanceType": "The instance type, such as `m3.xlarge` . You must use an instance type that is supported in your requested Region and Availability Zones. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon Elastic Compute Cloud User Guide* .",
|
|
5276
5277
|
"LaunchTemplateSpecification": "Provides a launch template for the specified instance type or instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's defined for your mixed instances policy. For more information, see [Specifying a different launch template for an instance type](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5277
5278
|
"WeightedCapacity": "The number of capacity units provided by the instance type specified in `InstanceType` in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is provisioned, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling provisions instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only provision an instance with a `WeightedCapacity` of 5 units, the instance is provisioned, and the desired capacity is exceeded by 3 units. For more information, see [Configure instance weighting for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html) in the *Amazon EC2 Auto Scaling User Guide* . Value must be in the range of 1-999.\n\n> Every Auto Scaling group has three size parameters ( `DesiredCapacity` , `MaxSize` , and `MinSize` ). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances."
|
|
5278
5279
|
}
|
|
5279
5280
|
},
|
|
5280
5281
|
"AWS::AutoScaling::AutoScalingGroup.LaunchTemplateSpecification": {
|
|
5281
5282
|
"attributes": {},
|
|
5282
|
-
"description": "`LaunchTemplateSpecification` specifies a launch template and version for the `LaunchTemplate` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types.\n\nThe launch template that is specified must be configured for use with an Auto Scaling group. For information about creating a launch template, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nFor
|
|
5283
|
+
"description": "`LaunchTemplateSpecification` specifies a launch template and version for the `LaunchTemplate` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types.\n\nThe launch template that is specified must be configured for use with an Auto Scaling group. For information about creating a launch template, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nFor examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the `AWS::EC2::LaunchTemplate` resource.",
|
|
5283
5284
|
"properties": {
|
|
5284
5285
|
"LaunchTemplateId": "The ID of the [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) . You must specify either a `LaunchTemplateName` or a `LaunchTemplateId` .",
|
|
5285
5286
|
"LaunchTemplateName": "The name of the [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) . You must specify either a `LaunchTemplateName` or a `LaunchTemplateId` .",
|
|
@@ -5290,13 +5291,13 @@
|
|
|
5290
5291
|
"attributes": {},
|
|
5291
5292
|
"description": "`LifecycleHookSpecification` specifies a lifecycle hook for the `LifecycleHookSpecificationList` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html) resource. A lifecycle hook specifies actions to perform when Amazon EC2 Auto Scaling launches or terminates instances.\n\nFor more information, see [Amazon EC2 Auto Scaling lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide* . You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#aws-resource-as-lifecyclehook--examples) section of the `AWS::AutoScaling::LifecycleHook` resource.",
|
|
5292
5293
|
"properties": {
|
|
5293
|
-
"DefaultResult": "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The
|
|
5294
|
-
"HeartbeatTimeout": "The maximum time, in seconds, that can elapse before the lifecycle hook times out.
|
|
5294
|
+
"DefaultResult": "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is `ABANDON` .\n\nValid values: `CONTINUE` | `ABANDON`",
|
|
5295
|
+
"HeartbeatTimeout": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from `30` to `7200` seconds. The default value is `3600` seconds (1 hour).",
|
|
5295
5296
|
"LifecycleHookName": "The name of the lifecycle hook.",
|
|
5296
|
-
"LifecycleTransition": "The
|
|
5297
|
+
"LifecycleTransition": "The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.\n\n- To create a lifecycle hook for scale-out events, specify `autoscaling:EC2_INSTANCE_LAUNCHING` .\n- To create a lifecycle hook for scale-in events, specify `autoscaling:EC2_INSTANCE_TERMINATING` .",
|
|
5297
5298
|
"NotificationMetadata": "Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.",
|
|
5298
|
-
"NotificationTargetARN": "The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling
|
|
5299
|
-
"RoleARN": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target
|
|
5299
|
+
"NotificationTargetARN": "The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.",
|
|
5300
|
+
"RoleARN": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Configure a notification target for a lifecycle hook](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html#lifecycle-hook-notification-target) in the *Amazon EC2 Auto Scaling User Guide* .\n\nValid only if the notification target is an Amazon SNS topic or an Amazon SQS queue."
|
|
5300
5301
|
}
|
|
5301
5302
|
},
|
|
5302
5303
|
"AWS::AutoScaling::AutoScalingGroup.MemoryGiBPerVCpuRequest": {
|
|
@@ -5319,16 +5320,16 @@
|
|
|
5319
5320
|
"attributes": {},
|
|
5320
5321
|
"description": "`MetricsCollection` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html) resource that describes the group metrics that an Amazon EC2 Auto Scaling group sends to Amazon CloudWatch. These metrics describe the group rather than any of its instances.\n\nFor more information, see [Monitor CloudWatch metrics for your Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html) in the *Amazon EC2 Auto Scaling User Guide* . You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#aws-properties-as-group--examples) section of the `AWS::AutoScaling::AutoScalingGroup` resource.",
|
|
5321
5322
|
"properties": {
|
|
5322
|
-
"Granularity": "The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch
|
|
5323
|
-
"Metrics": "Specifies which group-level metrics to start collecting
|
|
5323
|
+
"Granularity": "The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is `1Minute` .",
|
|
5324
|
+
"Metrics": "Specifies which group-level metrics to start collecting. You can specify one or more of the following metrics:\n\n- `GroupMinSize`\n- `GroupMaxSize`\n- `GroupDesiredCapacity`\n- `GroupInServiceInstances`\n- `GroupPendingInstances`\n- `GroupStandbyInstances`\n- `GroupTerminatingInstances`\n- `GroupTotalInstances`\n\nThe instance weighting feature supports the following additional metrics:\n\n- `GroupInServiceCapacity`\n- `GroupPendingCapacity`\n- `GroupStandbyCapacity`\n- `GroupTerminatingCapacity`\n- `GroupTotalCapacity`\n\nThe warm pools feature supports the following additional metrics:\n\n- `WarmPoolDesiredCapacity`\n- `WarmPoolWarmedCapacity`\n- `WarmPoolPendingCapacity`\n- `WarmPoolTerminatingCapacity`\n- `WarmPoolTotalCapacity`\n- `GroupAndWarmPoolDesiredCapacity`\n- `GroupAndWarmPoolTotalCapacity`\n\nIf you specify `Granularity` and don't specify any metrics, all metrics are enabled."
|
|
5324
5325
|
}
|
|
5325
5326
|
},
|
|
5326
5327
|
"AWS::AutoScaling::AutoScalingGroup.MixedInstancesPolicy": {
|
|
5327
5328
|
"attributes": {},
|
|
5328
5329
|
"description": "`MixedInstancesPolicy` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html) resource. It allows you to configure a group that diversifies across On-Demand Instances and Spot Instances of multiple instance types. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nYou can create a mixed instances policy for a new Auto Scaling group, or you can create it for an existing group by updating the group to specify `MixedInstancesPolicy` as the top-level property instead of a launch template or launch configuration. If you specify a `MixedInstancesPolicy` , you must specify a launch template as a property of the policy. You cannot specify a launch configuration for the policy.",
|
|
5329
5330
|
"properties": {
|
|
5330
|
-
"InstancesDistribution": "The instances distribution
|
|
5331
|
-
"LaunchTemplate": "
|
|
5331
|
+
"InstancesDistribution": "The instances distribution.",
|
|
5332
|
+
"LaunchTemplate": "One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities."
|
|
5332
5333
|
}
|
|
5333
5334
|
},
|
|
5334
5335
|
"AWS::AutoScaling::AutoScalingGroup.NetworkInterfaceCountRequest": {
|
|
@@ -5343,7 +5344,7 @@
|
|
|
5343
5344
|
"attributes": {},
|
|
5344
5345
|
"description": "A structure that specifies an Amazon SNS notification configuration for the `NotificationConfigurations` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html) resource.\n\nFor an example template snippet, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) .\n\nFor more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5345
5346
|
"properties": {
|
|
5346
|
-
"NotificationTypes": "A list of event types that send a notification. Event types can include any of the following types.\n\n*Allowed
|
|
5347
|
+
"NotificationTypes": "A list of event types that send a notification. Event types can include any of the following types.\n\n*Allowed values* :\n\n- `autoscaling:EC2_INSTANCE_LAUNCH`\n- `autoscaling:EC2_INSTANCE_LAUNCH_ERROR`\n- `autoscaling:EC2_INSTANCE_TERMINATE`\n- `autoscaling:EC2_INSTANCE_TERMINATE_ERROR`\n- `autoscaling:TEST_NOTIFICATION`",
|
|
5347
5348
|
"TopicARN": "The Amazon Resource Name (ARN) of the Amazon SNS topic."
|
|
5348
5349
|
}
|
|
5349
5350
|
},
|
|
@@ -5378,25 +5379,25 @@
|
|
|
5378
5379
|
},
|
|
5379
5380
|
"description": "The `AWS::AutoScaling::LaunchConfiguration` resource specifies the launch configuration that can be used by an Auto Scaling group to configure Amazon EC2 instances.\n\nWhen you update the launch configuration for an Auto Scaling group, CloudFormation deletes that resource and creates a new launch configuration with the updated properties and a new name. Existing instances are not affected. To update existing instances when you update the `AWS::AutoScaling::LaunchConfiguration` resource, you can specify an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html) for the group. You can find sample update policies for rolling updates in [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) .\n\nFor more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\n> To configure Amazon EC2 instances launched as part of the Auto Scaling group, you can specify a launch template or a launch configuration. We recommend that you use a [launch template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) to make sure that you can use the latest features of Amazon EC2, such as Dedicated Hosts and T2 Unlimited instances. For more information, see [Creating a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) .",
|
|
5380
5381
|
"properties": {
|
|
5381
|
-
"AssociatePublicIpAddress": "
|
|
5382
|
-
"BlockDeviceMappings": "
|
|
5383
|
-
"ClassicLinkVPCId": "*EC2-Classic retires on August 15, 2022. This
|
|
5384
|
-
"ClassicLinkVPCSecurityGroups": "*EC2-Classic retires on August 15, 2022. This
|
|
5385
|
-
"EbsOptimized": "Specifies whether the launch configuration is optimized for EBS I/O ( `true` ) or not ( `false` ).
|
|
5386
|
-
"IamInstanceProfile": "
|
|
5387
|
-
"ImageId": "
|
|
5388
|
-
"InstanceId": "The ID of the Amazon EC2 instance
|
|
5389
|
-
"InstanceMonitoring": "Controls whether instances in this group are launched with detailed ( `true` ) or basic ( `false` ) monitoring
|
|
5390
|
-
"InstanceType": "Specifies the instance type of the EC2 instance. For information about available instance types, see [Available instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) in the *Amazon EC2 User Guide for Linux Instances* .",
|
|
5391
|
-
"KernelId": "
|
|
5392
|
-
"KeyName": "
|
|
5382
|
+
"AssociatePublicIpAddress": "Specifies whether to assign a public IPv4 address to the group's instances. If the instance is launched into a default subnet, the default is to assign a public IPv4 address, unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address, unless you enabled the option to assign a public IPv4 address on the subnet.\n\nIf you specify `true` , each instance in the Auto Scaling group receives a unique public IPv4 address. For more information, see [Launching Auto Scaling instances in a VPC](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nIf you specify this property, you must specify at least one subnet for `VPCZoneIdentifier` when you create your group.",
|
|
5383
|
+
"BlockDeviceMappings": "The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. For more information, see [Block device mappings](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) in the *Amazon EC2 User Guide for Linux Instances* .",
|
|
5384
|
+
"ClassicLinkVPCId": "*EC2-Classic retires on August 15, 2022. This property is not supported after that date.*\n\nThe ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more information, see [ClassicLink](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) in the *Amazon EC2 User Guide for Linux Instances* .",
|
|
5385
|
+
"ClassicLinkVPCSecurityGroups": "*EC2-Classic retires on August 15, 2022. This property is not supported after that date.*\n\nThe IDs of one or more security groups for the specified ClassicLink-enabled VPC.\n\nIf you specify the `ClassicLinkVPCId` property, you must specify `ClassicLinkVPCSecurityGroups` .",
|
|
5386
|
+
"EbsOptimized": "Specifies whether the launch configuration is optimized for EBS I/O ( `true` ) or not ( `false` ). The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional fees are incurred when you enable EBS optimization for an instance type that is not EBS-optimized by default. For more information, see [Amazon EBS-optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) in the *Amazon EC2 User Guide for Linux Instances* .\n\nThe default value is `false` .",
|
|
5387
|
+
"IamInstanceProfile": "The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. For more information, see [IAM role for applications that run on Amazon EC2 instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5388
|
+
"ImageId": "The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see [Finding a Linux AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html) in the *Amazon EC2 User Guide for Linux Instances* .\n\nIf you specify `InstanceId` , an `ImageId` is not required.",
|
|
5389
|
+
"InstanceId": "The ID of the Amazon EC2 instance to use to create the launch configuration. When you use an instance to create a launch configuration, all properties are derived from the instance with the exception of `BlockDeviceMapping` and `AssociatePublicIpAddress` . You can override any properties from the instance by specifying them in the launch configuration.",
|
|
5390
|
+
"InstanceMonitoring": "Controls whether instances in this group are launched with detailed ( `true` ) or basic ( `false` ) monitoring.\n\nThe default value is `true` (enabled).\n\n> When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. For more information, see [Configure Monitoring for Auto Scaling Instances](https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5391
|
+
"InstanceType": "Specifies the instance type of the EC2 instance. For information about available instance types, see [Available instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) in the *Amazon EC2 User Guide for Linux Instances* .\n\nIf you specify `InstanceId` , an `InstanceType` is not required.",
|
|
5392
|
+
"KernelId": "The ID of the kernel associated with the AMI.\n\n> We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User provided kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html) in the *Amazon EC2 User Guide for Linux Instances* .",
|
|
5393
|
+
"KeyName": "The name of the key pair. For more information, see [Amazon EC2 key pairs and Linux instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the *Amazon EC2 User Guide for Linux Instances* .",
|
|
5393
5394
|
"LaunchConfigurationName": "The name of the launch configuration. This name must be unique per Region per account.",
|
|
5394
5395
|
"MetadataOptions": "The metadata options for the instances. For more information, see [Configuring the Instance Metadata Options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5395
|
-
"PlacementTenancy": "The tenancy of the instance, either `default` or `dedicated` . An instance with `dedicated` tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.
|
|
5396
|
+
"PlacementTenancy": "The tenancy of the instance, either `default` or `dedicated` . An instance with `dedicated` tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC. To launch dedicated instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to `default` ), you must set the value of this property to `dedicated` . For more information, see [Configuring instance tenancy with Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-dedicated-instances.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nIf you specify `PlacementTenancy` , you must specify at least one subnet for `VPCZoneIdentifier` when you create your group.\n\nValid values: `default` | `dedicated`",
|
|
5396
5397
|
"RamDiskId": "The ID of the RAM disk to select.\n\n> We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User provided kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html) in the *Amazon EC2 User Guide for Linux Instances* .",
|
|
5397
|
-
"SecurityGroups": "A list that contains the security groups to assign to the instances in the Auto Scaling group. The list can contain both the IDs of existing security groups and references to [SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template.\n\nFor more information, see [
|
|
5398
|
-
"SpotPrice": "The maximum hourly price
|
|
5399
|
-
"UserData": "The Base64-encoded user data to make available to the launched EC2 instances
|
|
5398
|
+
"SecurityGroups": "A list that contains the security groups to assign to the instances in the Auto Scaling group. The list can contain both the IDs of existing security groups and references to [SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template.\n\nFor more information, see [Control traffic to resources using security groups](https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide* .",
|
|
5399
|
+
"SpotPrice": "The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see [Request Spot Instances for fault-tolerant and flexible applications](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-template-spot-instances.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nValid Range: Minimum value of 0.001\n\n> When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price.",
|
|
5400
|
+
"UserData": "The Base64-encoded user data to make available to the launched EC2 instances. For more information, see [Instance metadata and user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon EC2 User Guide for Linux Instances* ."
|
|
5400
5401
|
}
|
|
5401
5402
|
},
|
|
5402
5403
|
"AWS::AutoScaling::LaunchConfiguration.BlockDevice": {
|
|
@@ -5409,17 +5410,17 @@
|
|
|
5409
5410
|
"SnapshotId": "The snapshot ID of the volume to use.\n\nYou must specify either a `VolumeSize` or a `SnapshotId` .",
|
|
5410
5411
|
"Throughput": "The throughput (MiBps) to provision for a `gp3` volume.",
|
|
5411
5412
|
"VolumeSize": "The volume size, in GiBs. The following are the supported volumes sizes for each volume type:\n\n- `gp2` and `gp3` : 1-16,384\n- `io1` : 4-16,384\n- `st1` and `sc1` : 125-16,384\n- `standard` : 1-1,024\n\nYou must specify either a `SnapshotId` or a `VolumeSize` . If you specify both `SnapshotId` and `VolumeSize` , the volume size must be equal or greater than the size of the snapshot.",
|
|
5412
|
-
"VolumeType": "The volume type. For more information, see [Amazon EBS
|
|
5413
|
+
"VolumeType": "The volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon EC2 User Guide for Linux Instances* .\n\nValid values: `standard` | `io1` | `gp2` | `st1` | `sc1` | `gp3`"
|
|
5413
5414
|
}
|
|
5414
5415
|
},
|
|
5415
5416
|
"AWS::AutoScaling::LaunchConfiguration.BlockDeviceMapping": {
|
|
5416
5417
|
"attributes": {},
|
|
5417
5418
|
"description": "`BlockDeviceMapping` specifies a block device mapping for the `BlockDeviceMappings` property of the [AWS::AutoScaling::LaunchConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html) resource.\n\nEach instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched.\n\nFor more information, see [Example block device mapping](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#block-device-mapping-ex) in the *Amazon EC2 User Guide for Linux Instances* .",
|
|
5418
5419
|
"properties": {
|
|
5419
|
-
"DeviceName": "The device name
|
|
5420
|
-
"Ebs": "
|
|
5421
|
-
"NoDevice": "Setting this value to `true`
|
|
5422
|
-
"VirtualName": "The name of the virtual device. The name must be in the form ephemeral *X* where *X* is a number starting from zero (0), for example, `ephemeral0`
|
|
5420
|
+
"DeviceName": "The device name assigned to the volume (for example, `/dev/sdh` or `xvdh` ). For more information, see [Device naming on Linux instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html) in the *Amazon EC2 User Guide for Linux Instances* .\n\n> To define a block device mapping, set the device name and exactly one of the following properties: `Ebs` , `NoDevice` , or `VirtualName` .",
|
|
5421
|
+
"Ebs": "Information to attach an EBS volume to an instance at launch.",
|
|
5422
|
+
"NoDevice": "Setting this value to `true` prevents a volume that is included in the block device mapping of the AMI from being mapped to the specified device name at launch.\n\nIf `NoDevice` is `true` for the root device, instances might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.",
|
|
5423
|
+
"VirtualName": "The name of the instance store volume (virtual device) to attach to an instance at launch. The name must be in the form ephemeral *X* where *X* is a number starting from zero (0), for example, `ephemeral0` ."
|
|
5423
5424
|
}
|
|
5424
5425
|
},
|
|
5425
5426
|
"AWS::AutoScaling::LaunchConfiguration.MetadataOptions": {
|
|
@@ -5437,14 +5438,14 @@
|
|
|
5437
5438
|
},
|
|
5438
5439
|
"description": "The `AWS::AutoScaling::LifecycleHook` resource specifies lifecycle hooks for an Auto Scaling group. These hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs. A lifecycle hook provides a specified amount of time (one hour by default) to wait for the action to complete before the instance transitions to the next state.\n\nUse lifecycle hooks to prepare new instances for use or to delay them from being registered behind a load balancer before their configuration has been applied completely. You can also use lifecycle hooks to prepare running instances to be terminated by, for example, downloading logs or other data.\n\nFor more information, see [Amazon EC2 Auto Scaling lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5439
5440
|
"properties": {
|
|
5440
|
-
"AutoScalingGroupName": "The name of the Auto Scaling group
|
|
5441
|
-
"DefaultResult": "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The
|
|
5442
|
-
"HeartbeatTimeout": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from `30` to `7200` seconds. The default value is `3600` seconds (1 hour).
|
|
5441
|
+
"AutoScalingGroupName": "The name of the Auto Scaling group.",
|
|
5442
|
+
"DefaultResult": "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is `ABANDON` .\n\nValid values: `CONTINUE` | `ABANDON`",
|
|
5443
|
+
"HeartbeatTimeout": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from `30` to `7200` seconds. The default value is `3600` seconds (1 hour).",
|
|
5443
5444
|
"LifecycleHookName": "The name of the lifecycle hook.",
|
|
5444
|
-
"LifecycleTransition": "The
|
|
5445
|
-
"NotificationMetadata": "Additional information that
|
|
5446
|
-
"NotificationTargetARN": "The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling
|
|
5447
|
-
"RoleARN": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target
|
|
5445
|
+
"LifecycleTransition": "The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.\n\n- To create a lifecycle hook for scale-out events, specify `autoscaling:EC2_INSTANCE_LAUNCHING` .\n- To create a lifecycle hook for scale-in events, specify `autoscaling:EC2_INSTANCE_TERMINATING` .",
|
|
5446
|
+
"NotificationMetadata": "Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.",
|
|
5447
|
+
"NotificationTargetARN": "The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.",
|
|
5448
|
+
"RoleARN": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Configure a notification target for a lifecycle hook](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html#lifecycle-hook-notification-target) in the *Amazon EC2 Auto Scaling User Guide* .\n\nValid only if the notification target is an Amazon SNS topic or an Amazon SQS queue."
|
|
5448
5449
|
}
|
|
5449
5450
|
},
|
|
5450
5451
|
"AWS::AutoScaling::ScalingPolicy": {
|
|
@@ -5453,17 +5454,17 @@
|
|
|
5453
5454
|
},
|
|
5454
5455
|
"description": "The `AWS::AutoScaling::ScalingPolicy` resource specifies an Amazon EC2 Auto Scaling scaling policy so that the Auto Scaling group can scale the number of instances available for your application.\n\nFor more information about using scaling policies to scale your Auto Scaling group automatically, see [Dynamic scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html) and [Predictive scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5455
5456
|
"properties": {
|
|
5456
|
-
"AdjustmentType": "Specifies how the scaling adjustment is interpreted. The valid values are `ChangeInCapacity` , `ExactCapacity` , and `PercentChangeInCapacity` .\n\nRequired if the policy type is `StepScaling` or `SimpleScaling` . For more information, see [Scaling adjustment types](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5457
|
+
"AdjustmentType": "Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are `ChangeInCapacity` , `ExactCapacity` , and `PercentChangeInCapacity` .\n\nRequired if the policy type is `StepScaling` or `SimpleScaling` . For more information, see [Scaling adjustment types](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5457
5458
|
"AutoScalingGroupName": "The name of the Auto Scaling group.",
|
|
5458
5459
|
"Cooldown": "A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown.\n\nValid only if the policy type is `SimpleScaling` . For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nDefault: None",
|
|
5459
|
-
"EstimatedInstanceWarmup": "
|
|
5460
|
+
"EstimatedInstanceWarmup": "*Not needed if the default instance warmup is defined for the group.*\n\nThe estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.\n\nValid only if the policy type is `TargetTrackingScaling` or `StepScaling` .\n\n> The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then `EstimatedInstanceWarmup` falls back to the value of default cooldown.",
|
|
5460
5461
|
"MetricAggregationType": "The aggregation type for the CloudWatch metrics. The valid values are `Minimum` , `Maximum` , and `Average` . If the aggregation type is null, the value is treated as `Average` .\n\nValid only if the policy type is `StepScaling` .",
|
|
5461
5462
|
"MinAdjustmentMagnitude": "The minimum value to scale by when the adjustment type is `PercentChangeInCapacity` . For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.\n\nValid only if the policy type is `StepScaling` or `SimpleScaling` . For more information, see [Scaling adjustment types](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment) in the *Amazon EC2 Auto Scaling User Guide* .\n\n> Some Auto Scaling groups use instance weights. In this case, set the `MinAdjustmentMagnitude` to a value that is at least as large as your largest instance weight.",
|
|
5462
|
-
"PolicyType": "One of the following policy types:\n\n- `TargetTrackingScaling`\n- `StepScaling`\n- `SimpleScaling` (default)\n- `PredictiveScaling
|
|
5463
|
-
"PredictiveScalingConfiguration": "A predictive scaling policy. Provides support for predefined and custom metrics.\n\nPredefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.",
|
|
5463
|
+
"PolicyType": "One of the following policy types:\n\n- `TargetTrackingScaling`\n- `StepScaling`\n- `SimpleScaling` (default)\n- `PredictiveScaling`",
|
|
5464
|
+
"PredictiveScalingConfiguration": "A predictive scaling policy. Provides support for predefined and custom metrics.\n\nPredefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.\n\nRequired if the policy type is `PredictiveScaling` .",
|
|
5464
5465
|
"ScalingAdjustment": "The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value.\n\nRequired if the policy type is `SimpleScaling` . (Not used with any other policy type.)",
|
|
5465
5466
|
"StepAdjustments": "A set of adjustments that enable you to scale based on the size of the alarm breach.\n\nRequired if the policy type is `StepScaling` . (Not used with any other policy type.)",
|
|
5466
|
-
"TargetTrackingConfiguration": "A target tracking scaling policy.
|
|
5467
|
+
"TargetTrackingConfiguration": "A target tracking scaling policy. Provides support for predefined or custom metrics.\n\nThe following predefined metrics are available:\n\n- `ASGAverageCPUUtilization`\n- `ASGAverageNetworkIn`\n- `ASGAverageNetworkOut`\n- `ALBRequestCountPerTarget`\n\nIf you specify `ALBRequestCountPerTarget` for the metric, you must specify the `ResourceLabel` property with the `PredefinedMetricSpecification` .\n\nRequired if the policy type is `TargetTrackingScaling` ."
|
|
5467
5468
|
}
|
|
5468
5469
|
},
|
|
5469
5470
|
"AWS::AutoScaling::ScalingPolicy.CustomizedMetricSpecification": {
|
|
@@ -5518,8 +5519,8 @@
|
|
|
5518
5519
|
"attributes": {},
|
|
5519
5520
|
"description": "Contains predefined metric specification information for a target tracking scaling policy for Amazon EC2 Auto Scaling.\n\n`PredefinedMetricSpecification` is a property of the [AWS::AutoScaling::ScalingPolicy TargetTrackingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html) property type.",
|
|
5520
5521
|
"properties": {
|
|
5521
|
-
"PredefinedMetricType": "The metric type. The following predefined metrics are available
|
|
5522
|
-
"ResourceLabel": "
|
|
5522
|
+
"PredefinedMetricType": "The metric type. The following predefined metrics are available:\n\n- `ASGAverageCPUUtilization` - Average CPU utilization of the Auto Scaling group.\n- `ASGAverageNetworkIn` - Average number of bytes received on all network interfaces by the Auto Scaling group.\n- `ASGAverageNetworkOut` - Average number of bytes sent out on all network interfaces by the Auto Scaling group.\n- `ALBRequestCountPerTarget` - Average Application Load Balancer request count per target for your Auto Scaling group.",
|
|
5523
|
+
"ResourceLabel": "A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.\n\nYou create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:\n\n`app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff` .\n\nWhere:\n\n- app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN\n- targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.\n\nTo find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation."
|
|
5523
5524
|
}
|
|
5524
5525
|
},
|
|
5525
5526
|
"AWS::AutoScaling::ScalingPolicy.PredictiveScalingConfiguration": {
|
|
@@ -5528,7 +5529,7 @@
|
|
|
5528
5529
|
"properties": {
|
|
5529
5530
|
"MaxCapacityBreachBehavior": "Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to `HonorMaxCapacity` if not specified.\n\nThe following are possible values:\n\n- `HonorMaxCapacity` - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.\n- `IncreaseMaxCapacity` - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for `MaxCapacityBuffer` .",
|
|
5530
5531
|
"MaxCapacityBuffer": "The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.\n\nIf set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.\n\nRequired if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise.",
|
|
5531
|
-
"MetricSpecifications": "
|
|
5532
|
+
"MetricSpecifications": "This structure includes the metrics and target utilization to use for predictive scaling.\n\nThis is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.",
|
|
5532
5533
|
"Mode": "The predictive scaling mode. Defaults to `ForecastOnly` if not specified.",
|
|
5533
5534
|
"SchedulingBufferTime": "The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.\n\nThe value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified."
|
|
5534
5535
|
}
|
|
@@ -5556,14 +5557,14 @@
|
|
|
5556
5557
|
},
|
|
5557
5558
|
"AWS::AutoScaling::ScalingPolicy.PredictiveScalingMetricSpecification": {
|
|
5558
5559
|
"attributes": {},
|
|
5559
|
-
"description": "A structure that specifies a metric specification for the `MetricSpecifications` property of the [AWS::AutoScaling::ScalingPolicy PredictiveScalingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingconfiguration.html) property type.\n\nFor
|
|
5560
|
+
"description": "A structure that specifies a metric specification for the `MetricSpecifications` property of the [AWS::AutoScaling::ScalingPolicy PredictiveScalingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingconfiguration.html) property type.\n\nYou must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric.\n\nExample\n\n- You create a predictive scaling policy and specify `ALBRequestCount` as the value for the metric pair and `1000.0` as the target value. For this type of metric, you must provide the metric dimension for the corresponding target group, so you also provide a resource label for the Application Load Balancer target group that is attached to your Auto Scaling group.\n- The number of requests the target group receives per minute provides the load metric, and the request count averaged between the members of the target group provides the scaling metric. In CloudWatch, this refers to the `RequestCount` and `RequestCountPerTarget` metrics, respectively.\n- For optimal use of predictive scaling, you adhere to the best practice of using a dynamic scaling policy to automatically scale between the minimum capacity and maximum capacity in response to real-time changes in resource utilization.\n- Amazon EC2 Auto Scaling consumes data points for the load metric over the last 14 days and creates an hourly load forecast for predictive scaling. (A minimum of 24 hours of data is required.)\n- After creating the load forecast, Amazon EC2 Auto Scaling determines when to reduce or increase the capacity of your Auto Scaling group in each hour of the forecast period so that the average number of requests received by each instance is as close to 1000 requests per minute as possible at all times.\n\nFor information about using custom metrics with predictive scaling, see [Advanced predictive scaling policy configurations using custom metrics](https://docs.aws.amazon.com/autoscaling/ec2/userguide/predictive-scaling-customized-metric-specification.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5560
5561
|
"properties": {
|
|
5561
5562
|
"CustomizedCapacityMetricSpecification": "The customized capacity metric specification.",
|
|
5562
5563
|
"CustomizedLoadMetricSpecification": "The customized load metric specification.",
|
|
5563
5564
|
"CustomizedScalingMetricSpecification": "The customized scaling metric specification.",
|
|
5564
|
-
"PredefinedLoadMetricSpecification": "The load metric specification
|
|
5565
|
-
"PredefinedMetricPairSpecification": "The metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use
|
|
5566
|
-
"PredefinedScalingMetricSpecification": "The scaling metric specification
|
|
5565
|
+
"PredefinedLoadMetricSpecification": "The predefined load metric specification.",
|
|
5566
|
+
"PredefinedMetricPairSpecification": "The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.",
|
|
5567
|
+
"PredefinedScalingMetricSpecification": "The predefined scaling metric specification.",
|
|
5567
5568
|
"TargetValue": "Specifies the target utilization.\n\n> Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval."
|
|
5568
5569
|
}
|
|
5569
5570
|
},
|
|
@@ -5596,8 +5597,8 @@
|
|
|
5596
5597
|
"description": "`StepAdjustment` specifies a step adjustment for the `StepAdjustments` property of the [AWS::AutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html) resource.\n\nFor the following examples, suppose that you have an alarm with a breach threshold of 50:\n\n- To trigger a step adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.\n- To trigger a step adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.\n\nThere are a few rules for the step adjustments for your step policy:\n\n- The ranges of your step adjustments can't overlap or have a gap.\n- At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.\n- At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.\n- The upper and lower bound can't be null in the same step adjustment.\n\nFor more information, see [Step adjustments](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-steps) in the *Amazon EC2 Auto Scaling User Guide* .\n\nYou can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#aws-properties-as-policy--examples) section of the `AWS::AutoScaling::ScalingPolicy` resource.",
|
|
5597
5598
|
"properties": {
|
|
5598
5599
|
"MetricIntervalLowerBound": "The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.",
|
|
5599
|
-
"MetricIntervalUpperBound": "The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.",
|
|
5600
|
-
"ScalingAdjustment": "The amount by which to scale. The adjustment is based on the value that you specified in the `AdjustmentType` property (either an absolute number or a percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity."
|
|
5600
|
+
"MetricIntervalUpperBound": "The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.\n\nThe upper bound must be greater than the lower bound.",
|
|
5601
|
+
"ScalingAdjustment": "The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.\n\nThe amount by which to scale. The adjustment is based on the value that you specified in the `AdjustmentType` property (either an absolute number or a percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity."
|
|
5601
5602
|
}
|
|
5602
5603
|
},
|
|
5603
5604
|
"AWS::AutoScaling::ScalingPolicy.TargetTrackingConfiguration": {
|
|
@@ -5607,7 +5608,7 @@
|
|
|
5607
5608
|
"CustomizedMetricSpecification": "A customized metric. You must specify either a predefined metric or a customized metric.",
|
|
5608
5609
|
"DisableScaleIn": "Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is `false` .",
|
|
5609
5610
|
"PredefinedMetricSpecification": "A predefined metric. You must specify either a predefined metric or a customized metric.",
|
|
5610
|
-
"TargetValue": "The target value for the metric."
|
|
5611
|
+
"TargetValue": "The target value for the metric.\n\n> Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval."
|
|
5611
5612
|
}
|
|
5612
5613
|
},
|
|
5613
5614
|
"AWS::AutoScaling::ScheduledAction": {
|
|
@@ -5617,12 +5618,12 @@
|
|
|
5617
5618
|
"description": "The `AWS::AutoScaling::ScheduledAction` resource specifies an Amazon EC2 Auto Scaling scheduled action so that the Auto Scaling group can change the number of instances available for your application in response to predictable load changes.\n\nWhen you update a stack with an Auto Scaling group and scheduled action, CloudFormation always sets the min size, max size, and desired capacity properties of your group to the values that are defined in the `AWS::AutoScaling::AutoScalingGroup` section of your template. However, you might not want CloudFormation to do that when you have a scheduled action in effect. You can use an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html) to prevent CloudFormation from changing the min size, max size, or desired capacity property values during a stack update unless you modified the individual values in your template. If you have rolling updates enabled, before you can update the Auto Scaling group, you must suspend scheduled actions by specifying an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html) for the Auto Scaling group. You can find a sample update policy for rolling updates in [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) .\n\nFor more information, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html) and [Suspending and resuming scaling processes](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html) in the *Amazon EC2 Auto Scaling User Guide* .",
|
|
5618
5619
|
"properties": {
|
|
5619
5620
|
"AutoScalingGroupName": "The name of the Auto Scaling group.",
|
|
5620
|
-
"DesiredCapacity": "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. It can scale beyond this capacity if you add more scaling conditions.\n\
|
|
5621
|
+
"DesiredCapacity": "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. It can scale beyond this capacity if you add more scaling conditions.\n\n> You must specify at least one of the following properties: `MaxSize` , `MinSize` , or `DesiredCapacity` .",
|
|
5621
5622
|
"EndTime": "The date and time for the recurring schedule to end, in UTC. For example, `\"2021-06-01T00:00:00Z\"` .",
|
|
5622
|
-
"MaxSize": "The maximum size of the Auto Scaling group
|
|
5623
|
-
"MinSize": "The minimum size of the Auto Scaling group
|
|
5624
|
-
"Recurrence": "The recurring schedule for this action. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. For more information about this format, see [Crontab](https://docs.aws.amazon.com/http://crontab.org) .\n\nWhen `StartTime` and `EndTime` are specified with `Recurrence` , they form the boundaries of when the recurring action starts and stops.\n\nCron expressions use Universal Coordinated Time (UTC) by default.",
|
|
5625
|
-
"StartTime": "The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only
|
|
5623
|
+
"MaxSize": "The maximum size of the Auto Scaling group.",
|
|
5624
|
+
"MinSize": "The minimum size of the Auto Scaling group.",
|
|
5625
|
+
"Recurrence": "The recurring schedule for this action. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, `\"30 0 1 1,6,12 *\"` ). For more information about this format, see [Crontab](https://docs.aws.amazon.com/http://crontab.org) .\n\nWhen `StartTime` and `EndTime` are specified with `Recurrence` , they form the boundaries of when the recurring action starts and stops.\n\nCron expressions use Universal Coordinated Time (UTC) by default.",
|
|
5626
|
+
"StartTime": "The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, `\"2021-06-01T00:00:00Z\"` ).\n\nIf you specify `Recurrence` and `StartTime` , Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.",
|
|
5626
5627
|
"TimeZone": "Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default.\n\nValid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as `Etc/GMT+9` or `Pacific/Tahiti` ). For more information, see [https://en.wikipedia.org/wiki/List_of_tz_database_time_zones](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) ."
|
|
5627
5628
|
}
|
|
5628
5629
|
},
|
|
@@ -5924,6 +5925,459 @@
|
|
|
5924
5925
|
"ReportSetting": "Identifies the report template for the report. Reports are built using a report template. The report templates are:\n\n`RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`\n\nIf the report template is `RESOURCE_COMPLIANCE_REPORT` or `CONTROL_COMPLIANCE_REPORT` , this API resource also describes the report coverage by AWS Regions and frameworks."
|
|
5925
5926
|
}
|
|
5926
5927
|
},
|
|
5928
|
+
"AWS::Batch::ComputeEnvironment": {
|
|
5929
|
+
"attributes": {
|
|
5930
|
+
"ComputeEnvironmentArn": "Returns the compute environment ARN, such as `batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName*` .",
|
|
5931
|
+
"Ref": "`Ref` returns the compute environment ARN, such as `batch: *us-east-1* : *555555555555* :compute-environment/ *M4OnDemand*` ."
|
|
5932
|
+
},
|
|
5933
|
+
"description": "The `AWS::Batch::ComputeEnvironment` resource defines your AWS Batch compute environment. You can define `MANAGED` or `UNMANAGED` compute environments. `MANAGED` compute environments can use Amazon EC2 or AWS Fargate resources. `UNMANAGED` compute environments can only use EC2 resources. For more information, see [Compute Environments](https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) in the ** .\n\nIn a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the [launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) that you specify when you create the compute environment. You can choose either to use EC2 On-Demand Instances and EC2 Spot Instances, or to use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is below a specified percentage of the On-Demand price.\n\n> Multi-node parallel jobs are not supported on Spot Instances. \n\nIn an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility with how you configure your compute resources. For example, you can use custom AMI. However, you need to verify that your AMI meets the Amazon ECS container instance AMI specification. For more information, see [container instance AMIs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html) in the *Amazon Elastic Container Service Developer Guide* . After you have created your unmanaged compute environment, you can use the [DescribeComputeEnvironments](https://docs.aws.amazon.com/batch/latest/APIReference/API_DescribeComputeEnvironments.html) operation to find the Amazon ECS cluster that is associated with it. Then, manually launch your container instances into that Amazon ECS cluster. For more information, see [Launching an Amazon ECS container instance](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html) in the *Amazon Elastic Container Service Developer Guide* .\n\n> AWS Batch doesn't upgrade the AMIs in a compute environment after it's created except under specific conditions. For example, it doesn't automatically update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible for the management of the guest operating system (including updates and security patches) and any additional application software or utilities that you install on the compute resources. There are two ways to use a new AMI for your AWS Batch jobs. The original method is to complete these steps:\n> \n> - Create a new compute environment with the new AMI.\n> - Add the compute environment to an existing job queue.\n> - Remove the earlier compute environment from your job queue.\n> - Delete the earlier compute environment.\n> \n> In April 2022, AWS Batch added enhanced support for updating compute environments. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* . To use the enhanced updating of compute environments to update AMIs, follow these rules:\n> \n> - Either do not set the [ServiceRole](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-servicerole) property or set it to the *AWSServiceRoleForBatch* service-linked role.\n> - Set the [AllocationStrategy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-allocationstrategy) property to `BEST_FIT_PROGRESSIVE` or `SPOT_CAPACITY_OPTIMIZED` .\n> - Set the [ReplaceComputeEnvironment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-replacecomputeenvironment) property to `false` .\n> - Set the [UpdateToLatestImageVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-updatetolatestimageversion) property to `true` .\n> - Either do not specify an image ID in [ImageId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-imageid) or [ImageIdOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-ec2configurationobject.html#cfn-batch-computeenvironment-ec2configurationobject-imageidoverride) properties, or in the launch template identified by the [Launch Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-launchtemplate) property. In that case AWS Batch will select the latest Amazon ECS optimized AMI supported by AWS Batch at the time the infrastructure update is initiated. Alternatively you can specify the AMI ID in the `ImageId` or `ImageIdOverride` properties, or the launch template identified by the `LaunchTemplate` properties. Changing any of these properties will trigger an infrastructure update.\n> \n> If these rules are followed, any update that triggers an infrastructure update will cause the AMI ID to be re-selected. If the [Version](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html#cfn-batch-computeenvironment-launchtemplatespecification-version) property of the [LaunchTemplateSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html) is set to `$Latest` or `$Default` , the latest or default version of the launch template will be evaluated up at the time of the infrastructure update, even if the `LaunchTemplateSpecification` was not updated.",
|
|
5934
|
+
"properties": {
|
|
5935
|
+
"ComputeEnvironmentName": "The name for your compute environment. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).",
|
|
5936
|
+
"ComputeResources": "The ComputeResources property type specifies details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see [Compute Environments](https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) in the ** .",
|
|
5937
|
+
"ReplaceComputeEnvironment": "Specifies whether the compute environment should be replaced if an update is made that requires replacing the instances in the compute environment. The default value is `true` . To enable more properties to be updated, set this property to `false` . When changing the value of this property to `false` , no other properties should be changed at the same time. If other properties are changed at the same time, and the change needs to be rolled back but it can't, it's possible for the stack to go into the `UPDATE_ROLLBACK_FAILED` state. You can't update a stack that is in the `UPDATE_ROLLBACK_FAILED` state. However, if you can continue to roll it back, you can return the stack to its original settings and then try to update it again. For more information, see [Continue rolling back an update](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html) in the *AWS CloudFormation User Guide* .\n\nThe properties that can't be changed without replacing the compute environment are in the [`ComputeResources`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html) property type: [`AllocationStrategy`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-allocationstrategy) , [`BidPercentage`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-bidpercentage) , [`Ec2Configuration`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2configuration) , [`Ec2KeyPair`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair) , [`Ec2KeyPair`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair) , [`ImageId`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-imageid) , [`InstanceRole`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancerole) , [`InstanceTypes`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancetypes) , [`LaunchTemplate`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-launchtemplate) , [`MaxvCpus`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-maxvcpus) , [`MinvCpus`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-minvcpus) , [`PlacementGroup`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-placementgroup) , [`SecurityGroupIds`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-securitygroupids) , [`Subnets`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-subnets) , [](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-tags) , [`Type`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-type) , and [`UpdateToLatestImageVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-updatetolatestimageversion) .",
|
|
5938
|
+
"ServiceRole": "The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see [AWS Batch service IAM role](https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) in the *AWS Batch User Guide* .\n\n> If your account already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the AWS Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the AWS Batch service-linked role in your account. \n\nIf your specified role has a path other than `/` , then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name `bar` has a path of `/foo/` then you would specify `/foo/bar` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide* .\n\n> Depending on how you created your AWS Batch service role, its ARN might contain the `service-role` path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the `service-role` path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.",
|
|
5939
|
+
"State": "The state of the compute environment. If the state is `ENABLED` , then the compute environment accepts jobs from a queue and can scale out automatically based on queues.\n\nIf the state is `ENABLED` , then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.\n\nIf the state is `DISABLED` , then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a `STARTING` or `RUNNING` state continue to progress normally. Managed compute environments in the `DISABLED` state don't scale out. However, they scale in to `minvCpus` value after instances become idle.",
|
|
5940
|
+
"Tags": "The tags applied to the compute environment.",
|
|
5941
|
+
"Type": "The type of the compute environment: `MANAGED` or `UNMANAGED` . For more information, see [Compute Environments](https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) in the *AWS Batch User Guide* .",
|
|
5942
|
+
"UnmanagedvCpus": "The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.\n\n> This parameter is only supported when the `type` parameter is set to `UNMANAGED` .",
|
|
5943
|
+
"UpdatePolicy": "Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* ."
|
|
5944
|
+
}
|
|
5945
|
+
},
|
|
5946
|
+
"AWS::Batch::ComputeEnvironment.ComputeResources": {
|
|
5947
|
+
"attributes": {},
|
|
5948
|
+
"description": "Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see [Compute Environments](https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) in the *AWS Batch User Guide* .",
|
|
5949
|
+
"properties": {
|
|
5950
|
+
"AllocationStrategy": "The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or [Amazon EC2 service limits](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html) . For more information, see [Allocation strategies](https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html) in the *AWS Batch User Guide* .\n\nWhen updating a compute environment, changing the allocation strategy requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* . `BEST_FIT` is not supported when updating a compute environment.\n\n> This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified. \n\n- **BEST_FIT (default)** - AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost instance type. If additional instances of the selected instance type aren't available, AWS Batch waits for the additional instances to be available. If there aren't enough instances available, or if the user is reaching [Amazon EC2 service limits](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html) then additional jobs aren't run until the currently running jobs have completed. This allocation strategy keeps costs lower but can limit scaling. If you are using Spot Fleets with `BEST_FIT` then the Spot Fleet IAM role must be specified.\n- **BEST_FIT_PROGRESSIVE** - AWS Batch will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.\n- **SPOT_CAPACITY_OPTIMIZED** - AWS Batch will select one or more instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.\n\nWith both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED` strategies, AWS Batch might need to go above `maxvCpus` to meet your capacity requirements. In this event, AWS Batch never exceeds `maxvCpus` by more than a single instance.",
|
|
5951
|
+
"BidPercentage": "The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage.\n\nWhen updating a compute environment, changing the bid percentage requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* .\n\n> This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.",
|
|
5952
|
+
"DesiredvCpus": "The desired number of Amazon EC2 vCPUS in the compute environment. AWS Batch modifies this value between the minimum and maximum values based on job queue demand.\n\n> This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.",
|
|
5953
|
+
"Ec2Configuration": "Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If `Ec2Configuration` isn't specified, the default is `ECS_AL2` .\n\nWhen updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* . To remove the EC2 configuration and any custom AMI ID specified in `imageIdOverride` , set this value to an empty string.\n\nOne or two values can be provided.\n\n> This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.",
|
|
5954
|
+
"Ec2KeyPair": "The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this value to an empty string.\n\nWhen updating a compute environment, changing the EC2 key pair requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* .\n\n> This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.",
|
|
5955
|
+
"ImageId": "The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the `imageIdOverride` member of the `Ec2Configuration` structure. To remove the custom AMI ID and use the default AMI ID, set this value to an empty string.\n\nWhen updating a compute environment, changing the AMI ID requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* .\n\n> This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified. > The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see [Amazon ECS-optimized Amazon Linux 2 AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html) in the *Amazon Elastic Container Service Developer Guide* .",
|
|
5956
|
+
"InstanceRole": "The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, `*ecsInstanceRole*` or `arn:aws:iam:: *<aws_account_id>* :instance-profile/ *ecsInstanceRole*` . For more information, see [Amazon ECS instance role](https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html) in the *AWS Batch User Guide* .\n\nWhen updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* .\n\n> This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.",
|
|
5957
|
+
"InstanceTypes": "The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, `c5` or `p3` ), or you can specify specific sizes within a family (such as `c5.8xlarge` ). You can also choose `optimal` to select instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.\n\nWhen updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* .\n\n> This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified. > When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment. > Currently, `optimal` uses instance types from the C4, M4, and R4 instance families. In Regions that don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families are used.",
|
|
5958
|
+
"LaunchTemplate": "The launch template to use for your compute resources. Any other compute resource parameters that you specify in a [CreateComputeEnvironment](https://docs.aws.amazon.com/batch/latest/APIReference/API_CreateComputeEnvironment.html) API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see [Launch Template Support](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in the ** .\n\n> This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.",
|
|
5959
|
+
"MaxvCpus": "The maximum number of Amazon EC2 vCPUs that an environment can reach.\n\n> With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED` allocation strategies, AWS Batch might need to exceed `maxvCpus` to meet your capacity requirements. In this event, AWS Batch never exceeds `maxvCpus` by more than a single instance. That is, no more than a single instance from among those specified in your compute environment.",
|
|
5960
|
+
"MinvCpus": "The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is `DISABLED` ).\n\n> This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.",
|
|
5961
|
+
"PlacementGroup": "The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances* .\n\nWhen updating a compute environment, changing the placement group requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* .\n\n> This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.",
|
|
5962
|
+
"SecurityGroupIds": "The Amazon EC2 security groups associated with instances launched in the compute environment. This parameter is required for Fargate compute resources, where it can contain up to 5 security groups. For Fargate compute resources, providing an empty list is handled as if this parameter wasn't specified and no change is made. For EC2 compute resources, providing an empty list removes the security groups from the compute resource.\n\nWhen updating a compute environment, changing the EC2 security groups requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* .",
|
|
5963
|
+
"SpotIamFleetRole": "The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a `SPOT` compute environment. This role is required if the allocation strategy set to `BEST_FIT` or if the allocation strategy isn't specified. For more information, see [Amazon EC2 spot fleet role](https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html) in the *AWS Batch User Guide* .\n\n> This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified. > To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer *AmazonEC2SpotFleetTaggingRole* managed policy. The previously recommended *AmazonEC2SpotFleetRole* managed policy doesn't have the required permissions to tag Spot Instances. For more information, see [Spot instances not tagged on creation](https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#spot-instance-no-tag) in the *AWS Batch User Guide* .",
|
|
5964
|
+
"Subnets": "The VPC subnets where the compute resources are launched. Fargate compute resources can contain up to 16 subnets. For Fargate compute resources, providing an empty list will be handled as if this parameter wasn't specified and no change is made. For EC2 compute resources, providing an empty list removes the VPC subnets from the compute resource. For more information, see [VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) in the *Amazon VPC User Guide* .\n\nWhen updating a compute environment, changing the VPC subnets requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* .",
|
|
5965
|
+
"Tags": "Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For AWS Batch , these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for example, `{ \"Name\": \"Batch Instance - C4OnDemand\" }` . This is helpful for recognizing your AWS Batch instances in the Amazon EC2 console. These tags aren't seen when using the AWS Batch `ListTagsForResource` API operation.\n\nWhen updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* .\n\n> This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.",
|
|
5966
|
+
"Type": "The type of compute environment: `EC2` , `SPOT` , `FARGATE` , or `FARGATE_SPOT` . For more information, see [Compute environments](https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) in the *AWS Batch User Guide* .\n\nIf you choose `SPOT` , you must also specify an Amazon EC2 Spot Fleet role with the `spotIamFleetRole` parameter. For more information, see [Amazon EC2 spot fleet role](https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html) in the *AWS Batch User Guide* .\n\nWhen updating compute environment, changing the type of a compute environment requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* .\n\nWhen updating the type of a compute environment, changing between `EC2` and `SPOT` or between `FARGATE` and `FARGATE_SPOT` will initiate an infrastructure update, but if you switch between `EC2` and `FARGATE` , AWS CloudFormation will create a new compute environment.",
|
|
5967
|
+
"UpdateToLatestImageVersion": "Specifies whether the AMI ID is updated to the latest one that's supported by AWS Batch when the compute environment has an infrastructure update. The default value is `false` .\n\n> If an AMI ID is specified in the `imageId` or `imageIdOverride` parameters or by the launch template specified in the `launchTemplate` parameter, this parameter is ignored. For more information on updating AMI IDs during an infrastructure update, see [Updating the AMI ID](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html#updating-compute-environments-ami) in the *AWS Batch User Guide* . \n\nWhen updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* ."
|
|
5968
|
+
}
|
|
5969
|
+
},
|
|
5970
|
+
"AWS::Batch::ComputeEnvironment.Ec2ConfigurationObject": {
|
|
5971
|
+
"attributes": {},
|
|
5972
|
+
"description": "Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If `Ec2Configuration` isn't specified, the default is `ECS_AL2` ( [Amazon Linux 2](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami) ).\n\n> This object isn't applicable to jobs that are running on Fargate resources.",
|
|
5973
|
+
"properties": {
|
|
5974
|
+
"ImageIdOverride": "The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the `imageId` set in the `computeResource` object.\n\n> The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see [Amazon ECS-optimized Amazon Linux 2 AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html) in the *Amazon Elastic Container Service Developer Guide* .",
|
|
5975
|
+
"ImageType": "The image type to match with the instance type to select an AMI. If the `imageIdOverride` parameter isn't specified, then a recent [Amazon ECS-optimized Amazon Linux 2 AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami) ( `ECS_AL2` ) is used. If a new image type is specified in an update, but neither an `imageId` nor a `imageIdOverride` parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's supported by AWS Batch is used.\n\n- **ECS_AL2** - [Amazon Linux 2](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami) − Default for all non-GPU instance families.\n- **ECS_AL2_NVIDIA** - [Amazon Linux 2 (GPU)](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami) −Default for all GPU instance families (for example `P4` and `G4` ) and can be used for all non AWS Graviton-based instance types.\n- **ECS_AL1** - [Amazon Linux](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami) . Amazon Linux is reaching the end-of-life of standard support. For more information, see [Amazon Linux AMI](https://docs.aws.amazon.com/amazon-linux-ami/) ."
|
|
5976
|
+
}
|
|
5977
|
+
},
|
|
5978
|
+
"AWS::Batch::ComputeEnvironment.LaunchTemplateSpecification": {
|
|
5979
|
+
"attributes": {},
|
|
5980
|
+
"description": "An object representing a launch template associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both.\n\nIf security groups are specified using both the `securityGroupIds` parameter of `CreateComputeEnvironment` and the launch template, the values in the `securityGroupIds` parameter of `CreateComputeEnvironment` will be used.\n\n> This object isn't applicable to jobs that are running on Fargate resources.",
|
|
5981
|
+
"properties": {
|
|
5982
|
+
"LaunchTemplateId": "The ID of the launch template.",
|
|
5983
|
+
"LaunchTemplateName": "The name of the launch template.",
|
|
5984
|
+
"Version": "The version number of the launch template, `$Latest` , or `$Default` .\n\nIf the value is `$Latest` , the latest version of the launch template is used. If the value is `$Default` , the default version of the launch template is used.\n\n> If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the `updateToLatestImageVersion` parameter for the compute environment is set to `true` . During an infrastructure update, if either `$Latest` or `$Default` is specified, AWS Batch re-evaluates the launch template version, and it might use a different version of the launch template. This is the case even if the launch template isn't specified in the update. When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* . \n\nDefault: `$Default` ."
|
|
5985
|
+
}
|
|
5986
|
+
},
|
|
5987
|
+
"AWS::Batch::ComputeEnvironment.UpdatePolicy": {
|
|
5988
|
+
"attributes": {},
|
|
5989
|
+
"description": "Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see [Infrastructure updates](https://docs.aws.amazon.com/batch/latest/userguide/infrastructure-updates.html) in the *AWS Batch User Guide* .",
|
|
5990
|
+
"properties": {
|
|
5991
|
+
"JobExecutionTimeoutMinutes": "Specifies the job timeout, in minutes, when the compute environment infrastructure is updated. The default value is 30.",
|
|
5992
|
+
"TerminateJobsOnUpdate": "Specifies whether jobs are automatically terminated when the computer environment infrastructure is updated. The default value is `false` ."
|
|
5993
|
+
}
|
|
5994
|
+
},
|
|
5995
|
+
"AWS::Batch::JobDefinition": {
|
|
5996
|
+
"attributes": {
|
|
5997
|
+
"Ref": "`Ref` returns the job definition ARN, such as `batch: *us-east-1* : *111122223333* :job-definition/ *test-gpu* : *2*` ."
|
|
5998
|
+
},
|
|
5999
|
+
"description": "The `AWS::Batch::JobDefinition` resource specifies the parameters for an AWS Batch job definition. For more information, see [Job Definitions](https://docs.aws.amazon.com/batch/latest/userguide/job_definitions.html) in the ** .",
|
|
6000
|
+
"properties": {
|
|
6001
|
+
"ContainerProperties": "An object with various properties specific to container-based jobs.",
|
|
6002
|
+
"JobDefinitionName": "The name of the job definition.",
|
|
6003
|
+
"NodeProperties": "An object with various properties specific to multi-node parallel jobs.\n\n> If the job runs on Fargate resources, then you must not specify `nodeProperties` ; use `containerProperties` instead.",
|
|
6004
|
+
"Parameters": "Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a `SubmitJob` request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see [Job definition parameters](https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html) in the *AWS Batch User Guide* .",
|
|
6005
|
+
"PlatformCapabilities": "The platform capabilities required by the job definition. If no value is specified, it defaults to `EC2` . Jobs run on Fargate resources specify `FARGATE` .",
|
|
6006
|
+
"PropagateTags": "Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the `FAILED` state.",
|
|
6007
|
+
"RetryStrategy": "The retry strategy to use for failed jobs that are submitted with this job definition.",
|
|
6008
|
+
"SchedulingPriority": "The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.",
|
|
6009
|
+
"Tags": "The tags applied to the job definition.",
|
|
6010
|
+
"Timeout": "The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they haven't finished.",
|
|
6011
|
+
"Type": "The type of job definition. For more information about multi-node parallel jobs, see [Creating a multi-node parallel job definition](https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html) in the *AWS Batch User Guide* .\n\n> If the job is run on Fargate resources, then `multinode` isn't supported."
|
|
6012
|
+
}
|
|
6013
|
+
},
|
|
6014
|
+
"AWS::Batch::JobDefinition.AuthorizationConfig": {
|
|
6015
|
+
"attributes": {},
|
|
6016
|
+
"description": "The authorization configuration details for the Amazon EFS file system.",
|
|
6017
|
+
"properties": {
|
|
6018
|
+
"AccessPointId": "The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the `EFSVolumeConfiguration` must either be omitted or set to `/` which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the `EFSVolumeConfiguration` . For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide* .",
|
|
6019
|
+
"Iam": "Whether or not to use the AWS Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the `EFSVolumeConfiguration` . If this parameter is omitted, the default value of `DISABLED` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html#efs-volume-accesspoints) in the *AWS Batch User Guide* . EFS IAM authorization requires that `TransitEncryption` be `ENABLED` and that a `JobRoleArn` is specified."
|
|
6020
|
+
}
|
|
6021
|
+
},
|
|
6022
|
+
"AWS::Batch::JobDefinition.ContainerProperties": {
|
|
6023
|
+
"attributes": {},
|
|
6024
|
+
"description": "Container properties are used in job definitions to describe the container that's launched as part of a job.",
|
|
6025
|
+
"properties": {
|
|
6026
|
+
"Command": "The command that's passed to the container. This parameter maps to `Cmd` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `COMMAND` parameter to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . For more information, see [https://docs.docker.com/engine/reference/builder/#cmd](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#cmd) .",
|
|
6027
|
+
"Environment": "The environment variables to pass to a container. This parameter maps to `Env` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--env` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n> We don't recommend using plaintext environment variables for sensitive information, such as credential data. > Environment variables must not start with `AWS_BATCH` ; this naming convention is reserved for variables that are set by the AWS Batch service.",
|
|
6028
|
+
"ExecutionRoleArn": "The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see [AWS Batch execution IAM role](https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html) in the *AWS Batch User Guide* .",
|
|
6029
|
+
"FargatePlatformConfiguration": "The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.",
|
|
6030
|
+
"Image": "The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with `*repository-url* / *image* : *tag*` . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to `Image` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `IMAGE` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n> Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources. \n\n- Images in Amazon ECR Public repositories use the full `registry/repository[:tag]` or `registry/repository[@digest]` naming conventions. For example, `public.ecr.aws/ *registry_alias* / *my-web-app* : *latest*` .\n- Images in Amazon ECR repositories use the full registry and repository URI (for example, `012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>` ).\n- Images in official repositories on Docker Hub use a single name (for example, `ubuntu` or `mongo` ).\n- Images in other repositories on Docker Hub are qualified with an organization name (for example, `amazon/amazon-ecs-agent` ).\n- Images in other online repositories are qualified further by a domain name (for example, `quay.io/assemblyline/ubuntu` ).",
|
|
6031
|
+
"InstanceType": "The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.\n\n> This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.",
|
|
6032
|
+
"JobRoleArn": "The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more information, see [IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide* .",
|
|
6033
|
+
"LinuxParameters": "Linux-specific modifications that are applied to the container, such as details for device mappings.",
|
|
6034
|
+
"LogConfiguration": "The log configuration specification for the container.\n\nThis parameter maps to `LogConfig` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--log-driver` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation.\n\n> AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the `LogConfiguration` data type). \n\nThis parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: `sudo docker version | grep \"Server API version\"`\n\n> The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide* .",
|
|
6035
|
+
"Memory": "This parameter is deprecated, use `resourceRequirements` to specify the memory requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.",
|
|
6036
|
+
"MountPoints": "The mount points for data volumes in your container. This parameter maps to `Volumes` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--volume` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .",
|
|
6037
|
+
"NetworkConfiguration": "The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.",
|
|
6038
|
+
"Privileged": "When this parameter is true, the container is given elevated permissions on the host container instance (similar to the `root` user). This parameter maps to `Privileged` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--privileged` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . The default value is false.\n\n> This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.",
|
|
6039
|
+
"ReadonlyRootFilesystem": "When this parameter is true, the container is given read-only access to its root file system. This parameter maps to `ReadonlyRootfs` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--read-only` option to `docker run` .",
|
|
6040
|
+
"ResourceRequirements": "The type and amount of resources to assign to a container. The supported resources include `GPU` , `MEMORY` , and `VCPU` .",
|
|
6041
|
+
"Secrets": "The secrets for the container. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) in the *AWS Batch User Guide* .",
|
|
6042
|
+
"Ulimits": "A list of `ulimits` to set in the container. This parameter maps to `Ulimits` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--ulimit` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n> This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.",
|
|
6043
|
+
"User": "The user name to use inside the container. This parameter maps to `User` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--user` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .",
|
|
6044
|
+
"Vcpus": "This parameter is deprecated, use `resourceRequirements` to specify the vCPU requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it specifies the number of vCPUs reserved for the job.\n\nEach vCPU is equivalent to 1,024 CPU shares. This parameter maps to `CpuShares` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--cpu-shares` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.",
|
|
6045
|
+
"Volumes": "A list of data volumes used in a job."
|
|
6046
|
+
}
|
|
6047
|
+
},
|
|
6048
|
+
"AWS::Batch::JobDefinition.Device": {
|
|
6049
|
+
"attributes": {},
|
|
6050
|
+
"description": "An object representing a container instance host device.\n\n> This object isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.",
|
|
6051
|
+
"properties": {
|
|
6052
|
+
"ContainerPath": "The path inside the container that's used to expose the host device. By default, the `hostPath` value is used.",
|
|
6053
|
+
"HostPath": "The path for the device on the host container instance.",
|
|
6054
|
+
"Permissions": "The explicit permissions to provide to the container for the device. By default, the container has permissions for `read` , `write` , and `mknod` for the device."
|
|
6055
|
+
}
|
|
6056
|
+
},
|
|
6057
|
+
"AWS::Batch::JobDefinition.EfsVolumeConfiguration": {
|
|
6058
|
+
"attributes": {},
|
|
6059
|
+
"description": "This is used when you're using an Amazon Elastic File System file system for job storage. For more information, see [Amazon EFS Volumes](https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html) in the *AWS Batch User Guide* .",
|
|
6060
|
+
"properties": {
|
|
6061
|
+
"AuthorizationConfig": "The authorization configuration details for the Amazon EFS file system.",
|
|
6062
|
+
"FileSystemId": "The Amazon EFS file system ID to use.",
|
|
6063
|
+
"RootDirectory": "The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying `/` has the same effect as omitting this parameter. The maximum length is 4,096 characters.\n\n> If an EFS access point is specified in the `authorizationConfig` , the root directory parameter must either be omitted or set to `/` , which enforces the path set on the Amazon EFS access point.",
|
|
6064
|
+
"TransitEncryption": "Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of `DISABLED` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide* .",
|
|
6065
|
+
"TransitEncryptionPort": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide* ."
|
|
6066
|
+
}
|
|
6067
|
+
},
|
|
6068
|
+
"AWS::Batch::JobDefinition.Environment": {
|
|
6069
|
+
"attributes": {},
|
|
6070
|
+
"description": "The Environment property type specifies environment variables to use in a job definition.",
|
|
6071
|
+
"properties": {
|
|
6072
|
+
"Name": "The name of the environment variable.",
|
|
6073
|
+
"Value": "The value of the environment variable."
|
|
6074
|
+
}
|
|
6075
|
+
},
|
|
6076
|
+
"AWS::Batch::JobDefinition.EvaluateOnExit": {
|
|
6077
|
+
"attributes": {},
|
|
6078
|
+
"description": "Specifies a set of conditions to be met, and an action to take ( `RETRY` or `EXIT` ) if all conditions are met.",
|
|
6079
|
+
"properties": {
|
|
6080
|
+
"Action": "Specifies the action to take if all of the specified conditions ( `onStatusReason` , `onReason` , and `onExitCode` ) are met. The values aren't case sensitive.",
|
|
6081
|
+
"OnExitCode": "Contains a glob pattern to match against the decimal representation of the `ExitCode` returned for a job. The pattern can be up to 512 characters in length. It can contain only numbers, and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.\n\nThe string can be between 1 and 512 characters in length.",
|
|
6082
|
+
"OnReason": "Contains a glob pattern to match against the `Reason` returned for a job. The pattern can be up to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.\n\nThe string can be between 1 and 512 characters in length.",
|
|
6083
|
+
"OnStatusReason": "Contains a glob pattern to match against the `StatusReason` returned for a job. The pattern can be up to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.\n\nThe string can be between 1 and 512 characters in length."
|
|
6084
|
+
}
|
|
6085
|
+
},
|
|
6086
|
+
"AWS::Batch::JobDefinition.FargatePlatformConfiguration": {
|
|
6087
|
+
"attributes": {},
|
|
6088
|
+
"description": "The platform configuration for jobs that are running on Fargate resources. Jobs that run on EC2 resources must not specify this parameter.",
|
|
6089
|
+
"properties": {
|
|
6090
|
+
"PlatformVersion": "The AWS Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the `LATEST` platform version is used by default. This uses a recent, approved version of the AWS Fargate platform for compute resources. For more information, see [AWS Fargate platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide* ."
|
|
6091
|
+
}
|
|
6092
|
+
},
|
|
6093
|
+
"AWS::Batch::JobDefinition.LinuxParameters": {
|
|
6094
|
+
"attributes": {},
|
|
6095
|
+
"description": "Linux-specific modifications that are applied to the container, such as details for device mappings.",
|
|
6096
|
+
"properties": {
|
|
6097
|
+
"Devices": "Any host devices to expose to the container. This parameter maps to `Devices` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--device` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n> This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.",
|
|
6098
|
+
"InitProcessEnabled": "If true, run an `init` process inside the container that forwards signals and reaps processes. This parameter maps to the `--init` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: `sudo docker version | grep \"Server API version\"`",
|
|
6099
|
+
"MaxSwap": "The total amount of swap memory (in MiB) a container can use. This parameter is translated to the `--memory-swap` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) where the value is the sum of the container memory plus the `maxSwap` value. For more information, see [`--memory-swap` details](https://docs.aws.amazon.com/https://docs.docker.com/config/containers/resource_constraints/#--memory-swap-details) in the Docker documentation.\n\nIf a `maxSwap` value of `0` is specified, the container doesn't use swap. Accepted values are `0` or any positive integer. If the `maxSwap` parameter is omitted, the container doesn't use the swap configuration for the container instance it is running on. A `maxSwap` value must be set for the `swappiness` parameter to be used.\n\n> This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.",
|
|
6100
|
+
"SharedMemorySize": "The value for the size (in MiB) of the `/dev/shm` volume. This parameter maps to the `--shm-size` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n> This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.",
|
|
6101
|
+
"Swappiness": "This allows you to tune a container's memory swappiness behavior. A `swappiness` value of `0` causes swapping not to happen unless absolutely necessary. A `swappiness` value of `100` causes pages to be swapped very aggressively. Accepted values are whole numbers between `0` and `100` . If the `swappiness` parameter isn't specified, a default value of `60` is used. If a value isn't specified for `maxSwap` , then this parameter is ignored. If `maxSwap` is set to 0, the container doesn't use swap. This parameter maps to the `--memory-swappiness` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\nConsider the following when you use a per-container swap configuration.\n\n- Swap space must be enabled and allocated on the container instance for the containers to use.\n\n> The Amazon ECS optimized AMIs don't have swap enabled by default. You must enable swap on the instance to use this feature. For more information, see [Instance store swap volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html) in the *Amazon EC2 User Guide for Linux Instances* or [How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?](https://docs.aws.amazon.com/premiumsupport/knowledge-center/ec2-memory-swap-file/)\n- The swap space parameters are only supported for job definitions using EC2 resources.\n- If the `maxSwap` and `swappiness` parameters are omitted from a job definition, each container will have a default `swappiness` value of 60, and the total swap usage will be limited to two times the memory reservation of the container.\n\n> This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.",
|
|
6102
|
+
"Tmpfs": "The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the `--tmpfs` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n> This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided."
|
|
6103
|
+
}
|
|
6104
|
+
},
|
|
6105
|
+
"AWS::Batch::JobDefinition.LogConfiguration": {
|
|
6106
|
+
"attributes": {},
|
|
6107
|
+
"description": "Log configuration options to send to a custom log driver for the container.",
|
|
6108
|
+
"properties": {
|
|
6109
|
+
"LogDriver": "The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.\n\nThe supported log drivers are `awslogs` , `fluentd` , `gelf` , `json-file` , `journald` , `logentries` , `syslog` , and `splunk` .\n\n> Jobs that are running on Fargate resources are restricted to the `awslogs` and `splunk` log drivers. \n\n- **awslogs** - Specifies the Amazon CloudWatch Logs logging driver. For more information, see [Using the awslogs log driver](https://docs.aws.amazon.com/batch/latest/userguide/using_awslogs.html) in the *AWS Batch User Guide* and [Amazon CloudWatch Logs logging driver](https://docs.aws.amazon.com/https://docs.docker.com/config/containers/logging/awslogs/) in the Docker documentation.\n- **fluentd** - Specifies the Fluentd logging driver. For more information, including usage and options, see [Fluentd logging driver](https://docs.aws.amazon.com/https://docs.docker.com/config/containers/logging/fluentd/) in the Docker documentation.\n- **gelf** - Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see [Graylog Extended Format logging driver](https://docs.aws.amazon.com/https://docs.docker.com/config/containers/logging/gelf/) in the Docker documentation.\n- **journald** - Specifies the journald logging driver. For more information, including usage and options, see [Journald logging driver](https://docs.aws.amazon.com/https://docs.docker.com/config/containers/logging/journald/) in the Docker documentation.\n- **json-file** - Specifies the JSON file logging driver. For more information, including usage and options, see [JSON File logging driver](https://docs.aws.amazon.com/https://docs.docker.com/config/containers/logging/json-file/) in the Docker documentation.\n- **splunk** - Specifies the Splunk logging driver. For more information, including usage and options, see [Splunk logging driver](https://docs.aws.amazon.com/https://docs.docker.com/config/containers/logging/splunk/) in the Docker documentation.\n- **syslog** - Specifies the syslog logging driver. For more information, including usage and options, see [Syslog logging driver](https://docs.aws.amazon.com/https://docs.docker.com/config/containers/logging/syslog/) in the Docker documentation.\n\n> If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software. \n\nThis parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: `sudo docker version | grep \"Server API version\"`",
|
|
6110
|
+
"Options": "The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: `sudo docker version | grep \"Server API version\"`",
|
|
6111
|
+
"SecretOptions": "The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) in the *AWS Batch User Guide* ."
|
|
6112
|
+
}
|
|
6113
|
+
},
|
|
6114
|
+
"AWS::Batch::JobDefinition.MountPoints": {
|
|
6115
|
+
"attributes": {},
|
|
6116
|
+
"description": "Details on a Docker volume mount point that's used in a job's container properties. This parameter maps to `Volumes` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#create-a-container) section of the Docker Remote API and the `--volume` option to docker run.",
|
|
6117
|
+
"properties": {
|
|
6118
|
+
"ContainerPath": "The path on the container where the host volume is mounted.",
|
|
6119
|
+
"ReadOnly": "If this value is `true` , the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is `false` .",
|
|
6120
|
+
"SourceVolume": "The name of the volume to mount."
|
|
6121
|
+
}
|
|
6122
|
+
},
|
|
6123
|
+
"AWS::Batch::JobDefinition.NetworkConfiguration": {
|
|
6124
|
+
"attributes": {},
|
|
6125
|
+
"description": "The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.",
|
|
6126
|
+
"properties": {
|
|
6127
|
+
"AssignPublicIp": "Indicates whether the job should have a public IP address. For a job that is running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see [Amazon ECS task networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) . The default value is \"DISABLED\"."
|
|
6128
|
+
}
|
|
6129
|
+
},
|
|
6130
|
+
"AWS::Batch::JobDefinition.NodeProperties": {
|
|
6131
|
+
"attributes": {},
|
|
6132
|
+
"description": "An object representing the node properties of a multi-node parallel job.",
|
|
6133
|
+
"properties": {
|
|
6134
|
+
"MainNode": "Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes.",
|
|
6135
|
+
"NodeRangeProperties": "A list of node ranges and their properties associated with a multi-node parallel job.",
|
|
6136
|
+
"NumNodes": "The number of nodes associated with a multi-node parallel job."
|
|
6137
|
+
}
|
|
6138
|
+
},
|
|
6139
|
+
"AWS::Batch::JobDefinition.NodeRangeProperty": {
|
|
6140
|
+
"attributes": {},
|
|
6141
|
+
"description": "An object representing the properties of the node range for a multi-node parallel job.",
|
|
6142
|
+
"properties": {
|
|
6143
|
+
"Container": "The container details for the node range.",
|
|
6144
|
+
"TargetNodes": "The range of nodes, using node index values. A range of `0:3` indicates nodes with index values of `0` through `3` . If the starting range value is omitted ( `:n` ), then `0` is used to start the range. If the ending range value is omitted ( `n:` ), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes ( `0:n` ). You can nest node ranges, for example `0:10` and `4:5` , in which case the `4:5` range properties override the `0:10` properties."
|
|
6145
|
+
}
|
|
6146
|
+
},
|
|
6147
|
+
"AWS::Batch::JobDefinition.ResourceRequirement": {
|
|
6148
|
+
"attributes": {},
|
|
6149
|
+
"description": "The type and amount of a resource to assign to a container. The supported resources include `GPU` , `MEMORY` , and `VCPU` .",
|
|
6150
|
+
"properties": {
|
|
6151
|
+
"Type": "The type of resource to assign to a container. The supported resources include `GPU` , `MEMORY` , and `VCPU` .",
|
|
6152
|
+
"Value": "The quantity of the specified resource to reserve for the container. The values vary based on the `type` specified.\n\n- **type=\"GPU\"** - The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.\n\n> GPUs are not available for jobs that are running on Fargate resources.\n- **type=\"MEMORY\"** - The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to `Memory` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--memory` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to `Memory` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--memory` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n> If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see [Memory management](https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in the *AWS Batch User Guide* . \n\nFor jobs that are running on Fargate resources, then `value` is the hard limit (in MiB), and must match one of the supported values and the `VCPU` values must be one of the values supported for that memory value.\n\n- **value = 512** - `VCPU` = 0.25\n- **value = 1024** - `VCPU` = 0.25 or 0.5\n- **value = 2048** - `VCPU` = 0.25, 0.5, or 1\n- **value = 3072** - `VCPU` = 0.5, or 1\n- **value = 4096** - `VCPU` = 0.5, 1, or 2\n- **value = 5120, 6144, or 7168** - `VCPU` = 1 or 2\n- **value = 8192** - `VCPU` = 1, 2, or 4\n- **value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384** - `VCPU` = 2 or 4\n- **value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720** - `VCPU` = 4\n- **type=\"VCPU\"** - The number of vCPUs reserved for the container. This parameter maps to `CpuShares` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--cpu-shares` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.\n\nFor jobs that are running on Fargate resources, then `value` must match one of the supported values and the `MEMORY` values must be one of the values supported for that `VCPU` value. The supported values are 0.25, 0.5, 1, 2, and 4\n\n- **value = 0.25** - `MEMORY` = 512, 1024, or 2048\n- **value = 0.5** - `MEMORY` = 1024, 2048, 3072, or 4096\n- **value = 1** - `MEMORY` = 2048, 3072, 4096, 5120, 6144, 7168, or 8192\n- **value = 2** - `MEMORY` = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384\n- **value = 4** - `MEMORY` = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720"
|
|
6153
|
+
}
|
|
6154
|
+
},
|
|
6155
|
+
"AWS::Batch::JobDefinition.RetryStrategy": {
|
|
6156
|
+
"attributes": {},
|
|
6157
|
+
"description": "The retry strategy associated with a job. For more information, see [Automated job retries](https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html) in the *AWS Batch User Guide* .",
|
|
6158
|
+
"properties": {
|
|
6159
|
+
"Attempts": "The number of times to move a job to the `RUNNABLE` status. You can specify between 1 and 10 attempts. If the value of `attempts` is greater than one, the job is retried on failure the same number of attempts as the value.",
|
|
6160
|
+
"EvaluateOnExit": "Array of up to 5 objects that specify conditions under which the job should be retried or failed. If this parameter is specified, then the `attempts` parameter must also be specified."
|
|
6161
|
+
}
|
|
6162
|
+
},
|
|
6163
|
+
"AWS::Batch::JobDefinition.Secret": {
|
|
6164
|
+
"attributes": {},
|
|
6165
|
+
"description": "An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:\n\n- To inject sensitive data into your containers as environment variables, use the `secrets` container definition parameter.\n- To reference sensitive information in the log configuration of a container, use the `secretOptions` container definition parameter.\n\nFor more information, see [Specifying sensitive data](https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) in the *AWS Batch User Guide* .",
|
|
6166
|
+
"properties": {
|
|
6167
|
+
"Name": "The name of the secret.",
|
|
6168
|
+
"ValueFrom": "The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.\n\n> If the AWS Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified."
|
|
6169
|
+
}
|
|
6170
|
+
},
|
|
6171
|
+
"AWS::Batch::JobDefinition.Timeout": {
|
|
6172
|
+
"attributes": {},
|
|
6173
|
+
"description": "An object representing a job timeout configuration.",
|
|
6174
|
+
"properties": {
|
|
6175
|
+
"AttemptDurationSeconds": "The time duration in seconds (measured from the job attempt's `startedAt` timestamp) after which AWS Batch terminates your jobs if they have not finished. The minimum value for the timeout is 60 seconds."
|
|
6176
|
+
}
|
|
6177
|
+
},
|
|
6178
|
+
"AWS::Batch::JobDefinition.Tmpfs": {
|
|
6179
|
+
"attributes": {},
|
|
6180
|
+
"description": "The container path, mount options, and size of the tmpfs mount.\n\n> This object isn't applicable to jobs that are running on Fargate resources.",
|
|
6181
|
+
"properties": {
|
|
6182
|
+
"ContainerPath": "The absolute file path in the container where the tmpfs volume is mounted.",
|
|
6183
|
+
"MountOptions": "The list of tmpfs volume mount options.\n\nValid values: \" `defaults` \" | \" `ro` \" | \" `rw` \" | \" `suid` \" | \" `nosuid` \" | \" `dev` \" | \" `nodev` \" | \" `exec` \" | \" `noexec` \" | \" `sync` \" | \" `async` \" | \" `dirsync` \" | \" `remount` \" | \" `mand` \" | \" `nomand` \" | \" `atime` \" | \" `noatime` \" | \" `diratime` \" | \" `nodiratime` \" | \" `bind` \" | \" `rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime` \" | \" `norelatime` \" | \" `strictatime` \" | \" `nostrictatime` \" | \" `mode` \" | \" `uid` \" | \" `gid` \" | \" `nr_inodes` \" | \" `nr_blocks` \" | \" `mpol` \"",
|
|
6184
|
+
"Size": "The size (in MiB) of the tmpfs volume."
|
|
6185
|
+
}
|
|
6186
|
+
},
|
|
6187
|
+
"AWS::Batch::JobDefinition.Ulimit": {
|
|
6188
|
+
"attributes": {},
|
|
6189
|
+
"description": "The `ulimit` settings to pass to the container.\n\n> This object isn't applicable to jobs that are running on Fargate resources.",
|
|
6190
|
+
"properties": {
|
|
6191
|
+
"HardLimit": "The hard limit for the `ulimit` type.",
|
|
6192
|
+
"Name": "The `type` of the `ulimit` .",
|
|
6193
|
+
"SoftLimit": "The soft limit for the `ulimit` type."
|
|
6194
|
+
}
|
|
6195
|
+
},
|
|
6196
|
+
"AWS::Batch::JobDefinition.Volumes": {
|
|
6197
|
+
"attributes": {},
|
|
6198
|
+
"description": "A list of volumes associated with the job.",
|
|
6199
|
+
"properties": {
|
|
6200
|
+
"EfsVolumeConfiguration": "This is used when you're using an Amazon Elastic File System file system for job storage. For more information, see [Amazon EFS Volumes](https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html) in the *AWS Batch User Guide* .",
|
|
6201
|
+
"Host": "The contents of the `host` parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers associated with it stop running.\n\n> This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.",
|
|
6202
|
+
"Name": "The name of the volume. It can be up to 255 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). This name is referenced in the `sourceVolume` parameter of container definition `mountPoints` ."
|
|
6203
|
+
}
|
|
6204
|
+
},
|
|
6205
|
+
"AWS::Batch::JobDefinition.VolumesHost": {
|
|
6206
|
+
"attributes": {},
|
|
6207
|
+
"description": "Determine whether your data volume persists on the host container instance and where it is stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data isn't guaranteed to persist after the containers associated with it stop running.",
|
|
6208
|
+
"properties": {
|
|
6209
|
+
"SourcePath": "The path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.\n\n> This parameter isn't applicable to jobs that run on Fargate resources and shouldn't be provided."
|
|
6210
|
+
}
|
|
6211
|
+
},
|
|
6212
|
+
"AWS::Batch::JobQueue": {
|
|
6213
|
+
"attributes": {
|
|
6214
|
+
"JobQueueArn": "Returns the job queue ARN, such as `batch: *us-east-1* : *111122223333* :job-queue/ *JobQueueName*` .",
|
|
6215
|
+
"Ref": "`Ref` returns the job queue ARN, such as `batch: *us-east-1* : *111122223333* :job-queue/ *HighPriority*` ."
|
|
6216
|
+
},
|
|
6217
|
+
"description": "The `AWS::Batch::JobQueue` resource specifies the parameters for an AWS Batch job queue definition. For more information, see [Job Queues](https://docs.aws.amazon.com/batch/latest/userguide/job_queues.html) in the ** .",
|
|
6218
|
+
"properties": {
|
|
6219
|
+
"ComputeEnvironmentOrder": "The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the `VALID` state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 ( `EC2` or `SPOT` ) or Fargate ( `FARGATE` or `FARGATE_SPOT` ); EC2 and Fargate compute environments can't be mixed.\n\n> All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.",
|
|
6220
|
+
"JobQueueName": "The name of the job queue. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).",
|
|
6221
|
+
"Priority": "The priority of the job queue. Job queues with a higher priority (or a higher integer value for the `priority` parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of `10` is given scheduling preference over a job queue with a priority value of `1` . All of the compute environments must be either EC2 ( `EC2` or `SPOT` ) or Fargate ( `FARGATE` or `FARGATE_SPOT` ); EC2 and Fargate compute environments can't be mixed.",
|
|
6222
|
+
"SchedulingPolicyArn": "The Amazon Resource Name (ARN) of the scheduling policy. The format is `aws: *Partition* :batch: *Region* : *Account* :scheduling-policy/ *Name*` . For example, `aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy` .",
|
|
6223
|
+
"State": "The state of the job queue. If the job queue state is `ENABLED` , it is able to accept jobs. If the job queue state is `DISABLED` , new jobs can't be added to the queue, but jobs already in the queue can finish.",
|
|
6224
|
+
"Tags": "The tags applied to the job queue. For more information, see [Tagging your AWS Batch resources](https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html) in *AWS Batch User Guide* ."
|
|
6225
|
+
}
|
|
6226
|
+
},
|
|
6227
|
+
"AWS::Batch::JobQueue.ComputeEnvironmentOrder": {
|
|
6228
|
+
"attributes": {},
|
|
6229
|
+
"description": "The order in which compute environments are tried for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first. Compute environments must be in the `VALID` state before you can associate them with a job queue. All of the compute environments must be either EC2 ( `EC2` or `SPOT` ) or Fargate ( `FARGATE` or `FARGATE_SPOT` ); EC2 and Fargate compute environments can't be mixed.\n\n> All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.",
|
|
6230
|
+
"properties": {
|
|
6231
|
+
"ComputeEnvironment": "The Amazon Resource Name (ARN) of the compute environment.",
|
|
6232
|
+
"Order": "The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower `order` integer value is tried for job placement first."
|
|
6233
|
+
}
|
|
6234
|
+
},
|
|
6235
|
+
"AWS::Batch::SchedulingPolicy": {
|
|
6236
|
+
"attributes": {
|
|
6237
|
+
"Arn": "Returns the scheduling policy ARN, such as `batch: *us-east-1* : *111122223333* :scheduling-policy/ *HighPriority*` .",
|
|
6238
|
+
"Ref": "`Ref` returns the scheduling policy ARN, such as `batch: *us-east-1* : *111122223333* :scheduling-policy/ *HighPriority*` ."
|
|
6239
|
+
},
|
|
6240
|
+
"description": "The `AWS::Batch::SchedulingPolicy` resource specifies the parameters for an AWS Batch scheduling policy. For more information, see [Scheduling Policies](https://docs.aws.amazon.com/batch/latest/userguide/scheduling_policies.html) in the ** .",
|
|
6241
|
+
"properties": {
|
|
6242
|
+
"FairsharePolicy": "The fair share policy of the scheduling policy.",
|
|
6243
|
+
"Name": "The name of the scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).",
|
|
6244
|
+
"Tags": "The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in *AWS General Reference* .\n\nThese tags can be updated or removed using the [TagResource](https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html) and [UntagResource](https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html) API operations."
|
|
6245
|
+
}
|
|
6246
|
+
},
|
|
6247
|
+
"AWS::Batch::SchedulingPolicy.FairsharePolicy": {
|
|
6248
|
+
"attributes": {},
|
|
6249
|
+
"description": "The fair share policy for a scheduling policy.",
|
|
6250
|
+
"properties": {
|
|
6251
|
+
"ComputeReservation": "A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been used.\n\nThe reserved ratio is `( *computeReservation* /100)^ *ActiveFairShares*` where `*ActiveFairShares*` is the number of active fair share identifiers.\n\nFor example, a `computeReservation` value of 50 indicates that AWS Batch should reserve 50% of the maximum available vCPU if there is only one fair share identifier, 25% if there are two fair share identifiers, and 12.5% if there are three fair share identifiers. A `computeReservation` value of 25 indicates that AWS Batch should reserve 25% of the maximum available vCPU if there is only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.\n\nThe minimum value is 0 and the maximum value is 99.",
|
|
6252
|
+
"ShareDecaySeconds": "The time period to use to calculate a fair share percentage for each fair share identifier in use, in seconds. A value of zero (0) indicates that only current usage should be measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).",
|
|
6253
|
+
"ShareDistribution": "An array of `SharedIdentifier` objects that contain the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of `1.0` ."
|
|
6254
|
+
}
|
|
6255
|
+
},
|
|
6256
|
+
"AWS::Batch::SchedulingPolicy.ShareAttributes": {
|
|
6257
|
+
"attributes": {},
|
|
6258
|
+
"description": "Specifies the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of `1.0` .",
|
|
6259
|
+
"properties": {
|
|
6260
|
+
"ShareIdentifier": "A fair share identifier or fair share identifier prefix. If the string ends with an asterisk (*), this entry specifies the weight factor to use for fair share identifiers that start with that prefix. The list of fair share identifiers in a fair share policy cannot overlap. For example, you can't have one that specifies a `shareIdentifier` of `UserA*` and another that specifies a `shareIdentifier` of `UserA-1` .\n\nThere can be no more than 500 fair share identifiers active in a job queue.\n\nThe string is limited to 255 alphanumeric characters, optionally followed by an asterisk (*).",
|
|
6261
|
+
"WeightFactor": "The weight factor for the fair share identifier. The default value is 1.0. A lower value has a higher priority for compute resources. For example, jobs that use a share identifier with a weight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share identifier with a weight factor of 1.\n\nThe smallest supported value is 0.0001, and the largest supported value is 999.9999."
|
|
6262
|
+
}
|
|
6263
|
+
},
|
|
6264
|
+
"AWS::BillingConductor::BillingGroup": {
|
|
6265
|
+
"attributes": {
|
|
6266
|
+
"Arn": "The Amazon Resource Name (ARN) of the created billing group.",
|
|
6267
|
+
"CreationTime": "The time the billing group was created.",
|
|
6268
|
+
"LastModifiedTime": "The most recent time the billing group was modified.",
|
|
6269
|
+
"Ref": "",
|
|
6270
|
+
"Size": "The number of accounts in the particular billing group.",
|
|
6271
|
+
"Status": "The billing group status. Only one of the valid values can be used.",
|
|
6272
|
+
"StatusReason": "The reason why the billing group is in its current status."
|
|
6273
|
+
},
|
|
6274
|
+
"description": "Creates a billing group that resembles a consolidated billing family that AWS charges, based off of the predefined pricing plan computation.",
|
|
6275
|
+
"properties": {
|
|
6276
|
+
"AccountGrouping": "The set of accounts that will be under the billing group. The set of accounts resemble the linked accounts in a consolidated family.",
|
|
6277
|
+
"ComputationPreference": "The preferences and settings that will be used to compute the AWS charges for a billing group.",
|
|
6278
|
+
"Description": "The billing group description.",
|
|
6279
|
+
"Name": "The billing group's name.",
|
|
6280
|
+
"PrimaryAccountId": "The account ID that serves as the main account in a billing group."
|
|
6281
|
+
}
|
|
6282
|
+
},
|
|
6283
|
+
"AWS::BillingConductor::BillingGroup.AccountGrouping": {
|
|
6284
|
+
"attributes": {},
|
|
6285
|
+
"description": "The set of accounts that will be under the billing group. The set of accounts resemble the linked accounts in a consolidated family.",
|
|
6286
|
+
"properties": {
|
|
6287
|
+
"LinkedAccountIds": "The account IDs that make up the billing group. Account IDs must be a part of the consolidated billing family, and not associated with another billing group."
|
|
6288
|
+
}
|
|
6289
|
+
},
|
|
6290
|
+
"AWS::BillingConductor::BillingGroup.ComputationPreference": {
|
|
6291
|
+
"attributes": {},
|
|
6292
|
+
"description": "The preferences and settings that will be used to compute the AWS charges for a billing group.",
|
|
6293
|
+
"properties": {
|
|
6294
|
+
"PricingPlanArn": "The Amazon Resource Name (ARN) of the pricing plan used to compute the AWS charges for a billing group."
|
|
6295
|
+
}
|
|
6296
|
+
},
|
|
6297
|
+
"AWS::BillingConductor::CustomLineItem": {
|
|
6298
|
+
"attributes": {
|
|
6299
|
+
"Arn": "The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.",
|
|
6300
|
+
"AssociationSize": "The number of resources that are associated to the custom line item.",
|
|
6301
|
+
"CreationTime": "The time created.",
|
|
6302
|
+
"CurrencyCode": "The custom line item's charge value currency. Only one of the valid values can be used.",
|
|
6303
|
+
"LastModifiedTime": "The most recent time the custom line item was modified.",
|
|
6304
|
+
"ProductCode": "The product code associated with the custom line item.",
|
|
6305
|
+
"Ref": ""
|
|
6306
|
+
},
|
|
6307
|
+
"description": "Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period. The one-time fixed charge is either a fee or discount.",
|
|
6308
|
+
"properties": {
|
|
6309
|
+
"BillingGroupArn": "The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.",
|
|
6310
|
+
"BillingPeriodRange": "A time range for which the custom line item is effective.",
|
|
6311
|
+
"CustomLineItemChargeDetails": "The charge details of a custom line item. It should contain only one of `Flat` or `Percentage` .",
|
|
6312
|
+
"Description": "The custom line item's description. This is shown on the Bills page in association with the charge value.",
|
|
6313
|
+
"Name": "The custom line item's name."
|
|
6314
|
+
}
|
|
6315
|
+
},
|
|
6316
|
+
"AWS::BillingConductor::CustomLineItem.BillingPeriodRange": {
|
|
6317
|
+
"attributes": {},
|
|
6318
|
+
"description": "The billing period range in which the custom line item request will be applied.",
|
|
6319
|
+
"properties": {
|
|
6320
|
+
"ExclusiveEndBillingPeriod": "The inclusive end billing period that defines a billing period range where a custom line is applied.",
|
|
6321
|
+
"InclusiveStartBillingPeriod": "The inclusive start billing period that defines a billing period range where a custom line is applied."
|
|
6322
|
+
}
|
|
6323
|
+
},
|
|
6324
|
+
"AWS::BillingConductor::CustomLineItem.CustomLineItemChargeDetails": {
|
|
6325
|
+
"attributes": {},
|
|
6326
|
+
"description": "The charge details of a custom line item. It should contain only one of `Flat` or `Percentage` .",
|
|
6327
|
+
"properties": {
|
|
6328
|
+
"Flat": "A `CustomLineItemFlatChargeDetails` that describes the charge details of a flat custom line item.",
|
|
6329
|
+
"Percentage": "A `CustomLineItemPercentageChargeDetails` that describes the charge details of a percentage custom line item.",
|
|
6330
|
+
"Type": "The type of the custom line item that indicates whether the charge is a fee or credit."
|
|
6331
|
+
}
|
|
6332
|
+
},
|
|
6333
|
+
"AWS::BillingConductor::CustomLineItem.CustomLineItemFlatChargeDetails": {
|
|
6334
|
+
"attributes": {},
|
|
6335
|
+
"description": "The charge details of a custom line item. It should contain only one of `Flat` or `Percentage` .",
|
|
6336
|
+
"properties": {
|
|
6337
|
+
"ChargeValue": "The custom line item's fixed charge value in USD."
|
|
6338
|
+
}
|
|
6339
|
+
},
|
|
6340
|
+
"AWS::BillingConductor::CustomLineItem.CustomLineItemPercentageChargeDetails": {
|
|
6341
|
+
"attributes": {},
|
|
6342
|
+
"description": "A representation of the charge details associated with a percentage custom line item.",
|
|
6343
|
+
"properties": {
|
|
6344
|
+
"ChildAssociatedResources": "A list of resource ARNs to associate to the percentage custom line item.",
|
|
6345
|
+
"PercentageValue": "The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value."
|
|
6346
|
+
}
|
|
6347
|
+
},
|
|
6348
|
+
"AWS::BillingConductor::PricingPlan": {
|
|
6349
|
+
"attributes": {
|
|
6350
|
+
"Arn": "The Amazon Resource Name (ARN) of the created pricing plan.",
|
|
6351
|
+
"CreationTime": "The time the pricing plan was created.",
|
|
6352
|
+
"LastModifiedTime": "The most recent time the pricing plan was modified.",
|
|
6353
|
+
"Ref": "",
|
|
6354
|
+
"Size": "The pricing rules count currently associated with this pricing plan list element."
|
|
6355
|
+
},
|
|
6356
|
+
"description": "Creates a pricing plan that is used for computing AWS charges for billing groups.",
|
|
6357
|
+
"properties": {
|
|
6358
|
+
"Description": "The pricing plan description.",
|
|
6359
|
+
"Name": "The name of a pricing plan.",
|
|
6360
|
+
"PricingRuleArns": "The `PricingRuleArns` that are associated with the Pricing Plan."
|
|
6361
|
+
}
|
|
6362
|
+
},
|
|
6363
|
+
"AWS::BillingConductor::PricingRule": {
|
|
6364
|
+
"attributes": {
|
|
6365
|
+
"Arn": "The Amazon Resource Name (ARN) used to uniquely identify a pricing rule.",
|
|
6366
|
+
"AssociatedPricingPlanCount": "The pricing plans count that this pricing rule is associated with.",
|
|
6367
|
+
"CreationTime": "The time the pricing rule was created.",
|
|
6368
|
+
"LastModifiedTime": "The most recent time the pricing rule was modified.",
|
|
6369
|
+
"Ref": ""
|
|
6370
|
+
},
|
|
6371
|
+
"description": "Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans.",
|
|
6372
|
+
"properties": {
|
|
6373
|
+
"Description": "The pricing rule description.",
|
|
6374
|
+
"ModifierPercentage": "A percentage modifier applied on the public pricing rates.",
|
|
6375
|
+
"Name": "The name of a pricing rule.",
|
|
6376
|
+
"Scope": "The scope of pricing rule that indicates if it is globally applicable, or if it is service-specific.",
|
|
6377
|
+
"Service": "If the `Scope` attribute is `SERVICE` , this attribute indicates which service the `PricingRule` is applicable for.",
|
|
6378
|
+
"Type": "The type of pricing rule."
|
|
6379
|
+
}
|
|
6380
|
+
},
|
|
5927
6381
|
"AWS::Budgets::Budget": {
|
|
5928
6382
|
"attributes": {
|
|
5929
6383
|
"Ref": "`Ref` returns the name of the budget that is created by the template."
|
|
@@ -10441,6 +10895,614 @@
|
|
|
10441
10895
|
"TaskData": ""
|
|
10442
10896
|
}
|
|
10443
10897
|
},
|
|
10898
|
+
"AWS::DataBrew::Dataset": {
|
|
10899
|
+
"attributes": {
|
|
10900
|
+
"Ref": "When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n\n`{ \"Ref\": \"myDataset\" }`\n\nFor an AWS Glue DataBrew dataset named `myDataset` , `Ref` returns the name of the dataset."
|
|
10901
|
+
},
|
|
10902
|
+
"description": "Specifies a new DataBrew dataset.",
|
|
10903
|
+
"properties": {
|
|
10904
|
+
"Format": "The file format of a dataset that is created from an Amazon S3 file or folder.",
|
|
10905
|
+
"FormatOptions": "A set of options that define how DataBrew interprets the data in the dataset.",
|
|
10906
|
+
"Input": "Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 .",
|
|
10907
|
+
"Name": "The unique name of the dataset.",
|
|
10908
|
+
"PathOptions": "A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.",
|
|
10909
|
+
"Tags": "Metadata tags that have been applied to the dataset."
|
|
10910
|
+
}
|
|
10911
|
+
},
|
|
10912
|
+
"AWS::DataBrew::Dataset.CsvOptions": {
|
|
10913
|
+
"attributes": {},
|
|
10914
|
+
"description": "Represents a set of options that define how DataBrew will read a comma-separated value (CSV) file when creating a dataset from that file.",
|
|
10915
|
+
"properties": {
|
|
10916
|
+
"Delimiter": "A single character that specifies the delimiter being used in the CSV file.",
|
|
10917
|
+
"HeaderRow": "A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated."
|
|
10918
|
+
}
|
|
10919
|
+
},
|
|
10920
|
+
"AWS::DataBrew::Dataset.DataCatalogInputDefinition": {
|
|
10921
|
+
"attributes": {},
|
|
10922
|
+
"description": "Represents how metadata stored in the AWS Glue Data Catalog is defined in a DataBrew dataset.",
|
|
10923
|
+
"properties": {
|
|
10924
|
+
"CatalogId": "The unique identifier of the AWS account that holds the Data Catalog that stores the data.",
|
|
10925
|
+
"DatabaseName": "The name of a database in the Data Catalog.",
|
|
10926
|
+
"TableName": "The name of a database table in the Data Catalog. This table corresponds to a DataBrew dataset.",
|
|
10927
|
+
"TempDirectory": "An Amazon location that AWS Glue Data Catalog can use as a temporary directory."
|
|
10928
|
+
}
|
|
10929
|
+
},
|
|
10930
|
+
"AWS::DataBrew::Dataset.DatabaseInputDefinition": {
|
|
10931
|
+
"attributes": {},
|
|
10932
|
+
"description": "Connection information for dataset input files stored in a database.",
|
|
10933
|
+
"properties": {
|
|
10934
|
+
"DatabaseTableName": "The table within the target database.",
|
|
10935
|
+
"GlueConnectionName": "The AWS Glue Connection that stores the connection information for the target database.",
|
|
10936
|
+
"QueryString": "Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.",
|
|
10937
|
+
"TempDirectory": "An Amazon location that AWS Glue Data Catalog can use as a temporary directory."
|
|
10938
|
+
}
|
|
10939
|
+
},
|
|
10940
|
+
"AWS::DataBrew::Dataset.DatasetParameter": {
|
|
10941
|
+
"attributes": {},
|
|
10942
|
+
"description": "Represents a dataset paramater that defines type and conditions for a parameter in the Amazon S3 path of the dataset.",
|
|
10943
|
+
"properties": {
|
|
10944
|
+
"CreateColumn": "Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.",
|
|
10945
|
+
"DatetimeOptions": "Additional parameter options such as a format and a timezone. Required for datetime parameters.",
|
|
10946
|
+
"Filter": "The optional filter expression structure to apply additional matching criteria to the parameter.",
|
|
10947
|
+
"Name": "The name of the parameter that is used in the dataset's Amazon S3 path.",
|
|
10948
|
+
"Type": "The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'."
|
|
10949
|
+
}
|
|
10950
|
+
},
|
|
10951
|
+
"AWS::DataBrew::Dataset.DatetimeOptions": {
|
|
10952
|
+
"attributes": {},
|
|
10953
|
+
"description": "Represents additional options for correct interpretation of datetime parameters used in the Amazon S3 path of a dataset.",
|
|
10954
|
+
"properties": {
|
|
10955
|
+
"Format": "Required option, that defines the datetime format used for a date parameter in the Amazon S3 path. Should use only supported datetime specifiers and separation characters, all litera a-z or A-Z character should be escaped with single quotes. E.g. \"MM.dd.yyyy-'at'-HH:mm\".",
|
|
10956
|
+
"LocaleCode": "Optional value for a non-US locale code, needed for correct interpretation of some date formats.",
|
|
10957
|
+
"TimezoneOffset": "Optional value for a timezone offset of the datetime parameter value in the Amazon S3 path. Shouldn't be used if Format for this parameter includes timezone fields. If no offset specified, UTC is assumed."
|
|
10958
|
+
}
|
|
10959
|
+
},
|
|
10960
|
+
"AWS::DataBrew::Dataset.ExcelOptions": {
|
|
10961
|
+
"attributes": {},
|
|
10962
|
+
"description": "Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when creating a dataset from that file.",
|
|
10963
|
+
"properties": {
|
|
10964
|
+
"HeaderRow": "A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.",
|
|
10965
|
+
"SheetIndexes": "One or more sheet numbers in the Excel file that will be included in the dataset.",
|
|
10966
|
+
"SheetNames": "One or more named sheets in the Excel file that will be included in the dataset."
|
|
10967
|
+
}
|
|
10968
|
+
},
|
|
10969
|
+
"AWS::DataBrew::Dataset.FilesLimit": {
|
|
10970
|
+
"attributes": {},
|
|
10971
|
+
"description": "Represents a limit imposed on number of Amazon S3 files that should be selected for a dataset from a connected Amazon S3 path.",
|
|
10972
|
+
"properties": {
|
|
10973
|
+
"MaxFiles": "The number of Amazon S3 files to select.",
|
|
10974
|
+
"Order": "A criteria to use for Amazon S3 files sorting before their selection. By default uses DESCENDING order, i.e. most recent files are selected first. Anotherpossible value is ASCENDING.",
|
|
10975
|
+
"OrderedBy": "A criteria to use for Amazon S3 files sorting before their selection. By default uses LAST_MODIFIED_DATE as a sorting criteria. Currently it's the only allowed value."
|
|
10976
|
+
}
|
|
10977
|
+
},
|
|
10978
|
+
"AWS::DataBrew::Dataset.FilterExpression": {
|
|
10979
|
+
"attributes": {},
|
|
10980
|
+
"description": "Represents a structure for defining parameter conditions.",
|
|
10981
|
+
"properties": {
|
|
10982
|
+
"Expression": "The expression which includes condition names followed by substitution variables, possibly grouped and combined with other conditions. For example, \"(starts_with :prefix1 or starts_with :prefix2) and (ends_with :suffix1 or ends_with :suffix2)\". Substitution variables should start with ':' symbol.",
|
|
10983
|
+
"ValuesMap": "The map of substitution variable names to their values used in this filter expression."
|
|
10984
|
+
}
|
|
10985
|
+
},
|
|
10986
|
+
"AWS::DataBrew::Dataset.FilterValue": {
|
|
10987
|
+
"attributes": {},
|
|
10988
|
+
"description": "Represents a single entry in the `ValuesMap` of a `FilterExpression` . A `FilterValue` associates the name of a substitution variable in an expression to its value.",
|
|
10989
|
+
"properties": {
|
|
10990
|
+
"Value": "The value to be associated with the substitution variable.",
|
|
10991
|
+
"ValueReference": "The substitution variable reference."
|
|
10992
|
+
}
|
|
10993
|
+
},
|
|
10994
|
+
"AWS::DataBrew::Dataset.FormatOptions": {
|
|
10995
|
+
"attributes": {},
|
|
10996
|
+
"description": "Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input.",
|
|
10997
|
+
"properties": {
|
|
10998
|
+
"Csv": "Options that define how CSV input is to be interpreted by DataBrew.",
|
|
10999
|
+
"Excel": "Options that define how Excel input is to be interpreted by DataBrew.",
|
|
11000
|
+
"Json": "Options that define how JSON input is to be interpreted by DataBrew."
|
|
11001
|
+
}
|
|
11002
|
+
},
|
|
11003
|
+
"AWS::DataBrew::Dataset.Input": {
|
|
11004
|
+
"attributes": {},
|
|
11005
|
+
"description": "Represents information on how DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3.",
|
|
11006
|
+
"properties": {
|
|
11007
|
+
"DataCatalogInputDefinition": "The AWS Glue Data Catalog parameters for the data.",
|
|
11008
|
+
"DatabaseInputDefinition": "Connection information for dataset input files stored in a database.",
|
|
11009
|
+
"Metadata": "Contains additional resource information needed for specific datasets.",
|
|
11010
|
+
"S3InputDefinition": "The Amazon S3 location where the data is stored."
|
|
11011
|
+
}
|
|
11012
|
+
},
|
|
11013
|
+
"AWS::DataBrew::Dataset.JsonOptions": {
|
|
11014
|
+
"attributes": {},
|
|
11015
|
+
"description": "Represents the JSON-specific options that define how input is to be interpreted by AWS Glue DataBrew .",
|
|
11016
|
+
"properties": {
|
|
11017
|
+
"MultiLine": "A value that specifies whether JSON input contains embedded new line characters."
|
|
11018
|
+
}
|
|
11019
|
+
},
|
|
11020
|
+
"AWS::DataBrew::Dataset.Metadata": {
|
|
11021
|
+
"attributes": {},
|
|
11022
|
+
"description": "Contains additional resource information needed for specific datasets.",
|
|
11023
|
+
"properties": {
|
|
11024
|
+
"SourceArn": "The Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew only supports ARNs from Amazon AppFlow."
|
|
11025
|
+
}
|
|
11026
|
+
},
|
|
11027
|
+
"AWS::DataBrew::Dataset.PathOptions": {
|
|
11028
|
+
"attributes": {},
|
|
11029
|
+
"description": "Represents a set of options that define how DataBrew selects files for a given Amazon S3 path in a dataset.",
|
|
11030
|
+
"properties": {
|
|
11031
|
+
"FilesLimit": "If provided, this structure imposes a limit on a number of files that should be selected.",
|
|
11032
|
+
"LastModifiedDateCondition": "If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 .",
|
|
11033
|
+
"Parameters": "A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions."
|
|
11034
|
+
}
|
|
11035
|
+
},
|
|
11036
|
+
"AWS::DataBrew::Dataset.PathParameter": {
|
|
11037
|
+
"attributes": {},
|
|
11038
|
+
"description": "Represents a single entry in the path parameters of a dataset. Each `PathParameter` consists of a name and a parameter definition.",
|
|
11039
|
+
"properties": {
|
|
11040
|
+
"DatasetParameter": "The path parameter definition.",
|
|
11041
|
+
"PathParameterName": "The name of the path parameter."
|
|
11042
|
+
}
|
|
11043
|
+
},
|
|
11044
|
+
"AWS::DataBrew::Dataset.S3Location": {
|
|
11045
|
+
"attributes": {},
|
|
11046
|
+
"description": "Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.",
|
|
11047
|
+
"properties": {
|
|
11048
|
+
"Bucket": "The Amazon S3 bucket name.",
|
|
11049
|
+
"Key": "The unique name of the object in the bucket."
|
|
11050
|
+
}
|
|
11051
|
+
},
|
|
11052
|
+
"AWS::DataBrew::Job": {
|
|
11053
|
+
"attributes": {
|
|
11054
|
+
"Ref": "When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n\n`{ \"Ref\": \"myJob\" }`\n\nFor an AWS Glue DataBrew job named `myJob` , `Ref` returns the name of the job."
|
|
11055
|
+
},
|
|
11056
|
+
"description": "Specifies a new DataBrew job.",
|
|
11057
|
+
"properties": {
|
|
11058
|
+
"DataCatalogOutputs": "One or more artifacts that represent the AWS Glue Data Catalog output from running the job.",
|
|
11059
|
+
"DatabaseOutputs": "Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.",
|
|
11060
|
+
"DatasetName": "A dataset that the job is to process.",
|
|
11061
|
+
"EncryptionKeyArn": "The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see [Encrypting data written by DataBrew jobs](https://docs.aws.amazon.com/databrew/latest/dg/encryption-security-configuration.html)",
|
|
11062
|
+
"EncryptionMode": "The encryption mode for the job, which can be one of the following:\n\n- `SSE-KMS` - Server-side encryption with keys managed by AWS KMS .\n- `SSE-S3` - Server-side encryption with keys managed by Amazon S3.",
|
|
11063
|
+
"JobSample": "A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a `JobSample` value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.",
|
|
11064
|
+
"LogSubscription": "The current status of Amazon CloudWatch logging for the job.",
|
|
11065
|
+
"MaxCapacity": "The maximum number of nodes that can be consumed when the job processes data.",
|
|
11066
|
+
"MaxRetries": "The maximum number of times to retry the job after a job run fails.",
|
|
11067
|
+
"Name": "The unique name of the job.",
|
|
11068
|
+
"OutputLocation": "",
|
|
11069
|
+
"Outputs": "One or more artifacts that represent output from running the job.",
|
|
11070
|
+
"ProfileConfiguration": "Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns.",
|
|
11071
|
+
"ProjectName": "The name of the project that the job is associated with.",
|
|
11072
|
+
"Recipe": "A series of data transformation steps that the job runs.",
|
|
11073
|
+
"RoleArn": "The Amazon Resource Name (ARN) of the role to be assumed for this job.",
|
|
11074
|
+
"Tags": "Metadata tags that have been applied to the job.",
|
|
11075
|
+
"Timeout": "The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of `TIMEOUT` .",
|
|
11076
|
+
"Type": "The job type of the job, which must be one of the following:\n\n- `PROFILE` - A job to analyze a dataset, to determine its size, data types, data distribution, and more.\n- `RECIPE` - A job to apply one or more transformations to a dataset.",
|
|
11077
|
+
"ValidationConfigurations": "List of validation configurations that are applied to the profile job."
|
|
11078
|
+
}
|
|
11079
|
+
},
|
|
11080
|
+
"AWS::DataBrew::Job.AllowedStatistics": {
|
|
11081
|
+
"attributes": {},
|
|
11082
|
+
"description": "Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.",
|
|
11083
|
+
"properties": {
|
|
11084
|
+
"Statistics": "One or more column statistics to allow for columns that contain detected entities."
|
|
11085
|
+
}
|
|
11086
|
+
},
|
|
11087
|
+
"AWS::DataBrew::Job.ColumnSelector": {
|
|
11088
|
+
"attributes": {},
|
|
11089
|
+
"description": "Selector of a column from a dataset for profile job configuration. One selector includes either a column name or a regular expression.",
|
|
11090
|
+
"properties": {
|
|
11091
|
+
"Name": "The name of a column from a dataset.",
|
|
11092
|
+
"Regex": "A regular expression for selecting a column from a dataset."
|
|
11093
|
+
}
|
|
11094
|
+
},
|
|
11095
|
+
"AWS::DataBrew::Job.ColumnStatisticsConfiguration": {
|
|
11096
|
+
"attributes": {},
|
|
11097
|
+
"description": "Configuration for column evaluations for a profile job. ColumnStatisticsConfiguration can be used to select evaluations and override parameters of evaluations for particular columns.",
|
|
11098
|
+
"properties": {
|
|
11099
|
+
"Selectors": "List of column selectors. Selectors can be used to select columns from the dataset. When selectors are undefined, configuration will be applied to all supported columns.",
|
|
11100
|
+
"Statistics": "Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations."
|
|
11101
|
+
}
|
|
11102
|
+
},
|
|
11103
|
+
"AWS::DataBrew::Job.CsvOutputOptions": {
|
|
11104
|
+
"attributes": {},
|
|
11105
|
+
"description": "Represents a set of options that define how DataBrew will write a comma-separated value (CSV) file.",
|
|
11106
|
+
"properties": {
|
|
11107
|
+
"Delimiter": "A single character that specifies the delimiter used to create CSV job output."
|
|
11108
|
+
}
|
|
11109
|
+
},
|
|
11110
|
+
"AWS::DataBrew::Job.DataCatalogOutput": {
|
|
11111
|
+
"attributes": {},
|
|
11112
|
+
"description": "Represents options that specify how and where in the AWS Glue Data Catalog DataBrew writes the output generated by recipe jobs.",
|
|
11113
|
+
"properties": {
|
|
11114
|
+
"CatalogId": "The unique identifier of the AWS account that holds the Data Catalog that stores the data.",
|
|
11115
|
+
"DatabaseName": "The name of a database in the Data Catalog.",
|
|
11116
|
+
"DatabaseOptions": "Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.",
|
|
11117
|
+
"Overwrite": "A value that, if true, means that any data in the location specified for output is overwritten with new output. Not supported with DatabaseOptions.",
|
|
11118
|
+
"S3Options": "Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.",
|
|
11119
|
+
"TableName": "The name of a table in the Data Catalog."
|
|
11120
|
+
}
|
|
11121
|
+
},
|
|
11122
|
+
"AWS::DataBrew::Job.DatabaseOutput": {
|
|
11123
|
+
"attributes": {},
|
|
11124
|
+
"description": "Represents a JDBC database output object which defines the output destination for a DataBrew recipe job to write into.",
|
|
11125
|
+
"properties": {
|
|
11126
|
+
"DatabaseOptions": "Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.",
|
|
11127
|
+
"DatabaseOutputMode": "The output mode to write into the database. Currently supported option: NEW_TABLE.",
|
|
11128
|
+
"GlueConnectionName": "The AWS Glue connection that stores the connection information for the target database."
|
|
11129
|
+
}
|
|
11130
|
+
},
|
|
11131
|
+
"AWS::DataBrew::Job.DatabaseTableOutputOptions": {
|
|
11132
|
+
"attributes": {},
|
|
11133
|
+
"description": "Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.",
|
|
11134
|
+
"properties": {
|
|
11135
|
+
"TableName": "A prefix for the name of a table DataBrew will create in the database.",
|
|
11136
|
+
"TempDirectory": "Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results."
|
|
11137
|
+
}
|
|
11138
|
+
},
|
|
11139
|
+
"AWS::DataBrew::Job.EntityDetectorConfiguration": {
|
|
11140
|
+
"attributes": {},
|
|
11141
|
+
"description": "Configuration of entity detection for a profile job. When undefined, entity detection is disabled.",
|
|
11142
|
+
"properties": {
|
|
11143
|
+
"AllowedStatistics": "Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.",
|
|
11144
|
+
"EntityTypes": "Entity types to detect. Can be any of the following:\n\n- USA_SSN\n- EMAIL\n- USA_ITIN\n- USA_PASSPORT_NUMBER\n- PHONE_NUMBER\n- USA_DRIVING_LICENSE\n- BANK_ACCOUNT\n- CREDIT_CARD\n- IP_ADDRESS\n- MAC_ADDRESS\n- USA_DEA_NUMBER\n- USA_HCPCS_CODE\n- USA_NATIONAL_PROVIDER_IDENTIFIER\n- USA_NATIONAL_DRUG_CODE\n- USA_HEALTH_INSURANCE_CLAIM_NUMBER\n- USA_MEDICARE_BENEFICIARY_IDENTIFIER\n- USA_CPT_CODE\n- PERSON_NAME\n- DATE\n\nThe Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE."
|
|
11145
|
+
}
|
|
11146
|
+
},
|
|
11147
|
+
"AWS::DataBrew::Job.JobSample": {
|
|
11148
|
+
"attributes": {},
|
|
11149
|
+
"description": "A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a `JobSample` value isn't provided, the default is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.",
|
|
11150
|
+
"properties": {
|
|
11151
|
+
"Mode": "A value that determines whether the profile job is run on the entire dataset or a specified number of rows. This value must be one of the following:\n\n- FULL_DATASET - The profile job is run on the entire dataset.\n- CUSTOM_ROWS - The profile job is run on the number of rows specified in the `Size` parameter.",
|
|
11152
|
+
"Size": "The `Size` parameter is only required when the mode is CUSTOM_ROWS. The profile job is run on the specified number of rows. The maximum value for size is Long.MAX_VALUE.\n\nLong.MAX_VALUE = 9223372036854775807"
|
|
11153
|
+
}
|
|
11154
|
+
},
|
|
11155
|
+
"AWS::DataBrew::Job.Output": {
|
|
11156
|
+
"attributes": {},
|
|
11157
|
+
"description": "Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by recipe jobs or profile jobs.",
|
|
11158
|
+
"properties": {
|
|
11159
|
+
"CompressionFormat": "The compression algorithm used to compress the output text of the job.",
|
|
11160
|
+
"Format": "The data format of the output of the job.",
|
|
11161
|
+
"FormatOptions": "Represents options that define how DataBrew formats job output files.",
|
|
11162
|
+
"Location": "The location in Amazon S3 where the job writes its output.",
|
|
11163
|
+
"MaxOutputFiles": "The maximum number of files to be generated by the job and written to the output folder.",
|
|
11164
|
+
"Overwrite": "A value that, if true, means that any data in the location specified for output is overwritten with new output.",
|
|
11165
|
+
"PartitionColumns": "The names of one or more partition columns for the output of the job."
|
|
11166
|
+
}
|
|
11167
|
+
},
|
|
11168
|
+
"AWS::DataBrew::Job.OutputFormatOptions": {
|
|
11169
|
+
"attributes": {},
|
|
11170
|
+
"description": "Represents a set of options that define the structure of comma-separated (CSV) job output.",
|
|
11171
|
+
"properties": {
|
|
11172
|
+
"Csv": "Represents a set of options that define the structure of comma-separated value (CSV) job output."
|
|
11173
|
+
}
|
|
11174
|
+
},
|
|
11175
|
+
"AWS::DataBrew::Job.OutputLocation": {
|
|
11176
|
+
"attributes": {},
|
|
11177
|
+
"description": "The location in Amazon S3 or AWS Glue Data Catalog where the job writes its output.",
|
|
11178
|
+
"properties": {
|
|
11179
|
+
"Bucket": "The Amazon S3 bucket name.",
|
|
11180
|
+
"BucketOwner": "",
|
|
11181
|
+
"Key": "The unique name of the object in the bucket."
|
|
11182
|
+
}
|
|
11183
|
+
},
|
|
11184
|
+
"AWS::DataBrew::Job.ParameterMap": {
|
|
11185
|
+
"attributes": {},
|
|
11186
|
+
"description": "A map that includes job parameters.",
|
|
11187
|
+
"properties": {}
|
|
11188
|
+
},
|
|
11189
|
+
"AWS::DataBrew::Job.ProfileConfiguration": {
|
|
11190
|
+
"attributes": {},
|
|
11191
|
+
"description": "Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns.",
|
|
11192
|
+
"properties": {
|
|
11193
|
+
"ColumnStatisticsConfigurations": "List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations.",
|
|
11194
|
+
"DatasetStatisticsConfiguration": "Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations.",
|
|
11195
|
+
"EntityDetectorConfiguration": "Configuration of entity detection for a profile job. When undefined, entity detection is disabled.",
|
|
11196
|
+
"ProfileColumns": "List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns."
|
|
11197
|
+
}
|
|
11198
|
+
},
|
|
11199
|
+
"AWS::DataBrew::Job.Recipe": {
|
|
11200
|
+
"attributes": {},
|
|
11201
|
+
"description": "Represents one or more actions to be performed on a DataBrew dataset.",
|
|
11202
|
+
"properties": {
|
|
11203
|
+
"Name": "The unique name for the recipe.",
|
|
11204
|
+
"Version": "The identifier for the version for the recipe."
|
|
11205
|
+
}
|
|
11206
|
+
},
|
|
11207
|
+
"AWS::DataBrew::Job.S3Location": {
|
|
11208
|
+
"attributes": {},
|
|
11209
|
+
"description": "Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.",
|
|
11210
|
+
"properties": {
|
|
11211
|
+
"Bucket": "The Amazon S3 bucket name.",
|
|
11212
|
+
"BucketOwner": "The AWS account ID of the bucket owner.",
|
|
11213
|
+
"Key": "The unique name of the object in the bucket."
|
|
11214
|
+
}
|
|
11215
|
+
},
|
|
11216
|
+
"AWS::DataBrew::Job.S3TableOutputOptions": {
|
|
11217
|
+
"attributes": {},
|
|
11218
|
+
"description": "Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.",
|
|
11219
|
+
"properties": {
|
|
11220
|
+
"Location": "Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job."
|
|
11221
|
+
}
|
|
11222
|
+
},
|
|
11223
|
+
"AWS::DataBrew::Job.StatisticOverride": {
|
|
11224
|
+
"attributes": {},
|
|
11225
|
+
"description": "Override of a particular evaluation for a profile job.",
|
|
11226
|
+
"properties": {
|
|
11227
|
+
"Parameters": "A map that includes overrides of an evaluation’s parameters.",
|
|
11228
|
+
"Statistic": "The name of an evaluation"
|
|
11229
|
+
}
|
|
11230
|
+
},
|
|
11231
|
+
"AWS::DataBrew::Job.StatisticsConfiguration": {
|
|
11232
|
+
"attributes": {},
|
|
11233
|
+
"description": "Configuration of evaluations for a profile job. This configuration can be used to select evaluations and override the parameters of selected evaluations.",
|
|
11234
|
+
"properties": {
|
|
11235
|
+
"IncludedStatistics": "List of included evaluations. When the list is undefined, all supported evaluations will be included.",
|
|
11236
|
+
"Overrides": "List of overrides for evaluations."
|
|
11237
|
+
}
|
|
11238
|
+
},
|
|
11239
|
+
"AWS::DataBrew::Job.ValidationConfiguration": {
|
|
11240
|
+
"attributes": {},
|
|
11241
|
+
"description": "Configuration for data quality validation. Used to select the Rulesets and Validation Mode to be used in the profile job. When ValidationConfiguration is null, the profile job will run without data quality validation.",
|
|
11242
|
+
"properties": {
|
|
11243
|
+
"RulesetArn": "The Amazon Resource Name (ARN) for the ruleset to be validated in the profile job. The TargetArn of the selected ruleset should be the same as the Amazon Resource Name (ARN) of the dataset that is associated with the profile job.",
|
|
11244
|
+
"ValidationMode": "Mode of data quality validation. Default mode is “CHECK_ALL” which verifies all rules defined in the selected ruleset."
|
|
11245
|
+
}
|
|
11246
|
+
},
|
|
11247
|
+
"AWS::DataBrew::Project": {
|
|
11248
|
+
"attributes": {
|
|
11249
|
+
"Ref": "When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n\n`{ \"Ref\": \"myProject\" }`\n\nFor an AWS Glue DataBrew project named `myProject` , `Ref` returns the name of the project."
|
|
11250
|
+
},
|
|
11251
|
+
"description": "Specifies a new AWS Glue DataBrew project.",
|
|
11252
|
+
"properties": {
|
|
11253
|
+
"DatasetName": "The dataset that the project is to act upon.",
|
|
11254
|
+
"Name": "The unique name of a project.",
|
|
11255
|
+
"RecipeName": "The name of a recipe that will be developed during a project session.",
|
|
11256
|
+
"RoleArn": "The Amazon Resource Name (ARN) of the role that will be assumed for this project.",
|
|
11257
|
+
"Sample": "The sample size and sampling type to apply to the data. If this parameter isn't specified, then the sample consists of the first 500 rows from the dataset.",
|
|
11258
|
+
"Tags": "Metadata tags that have been applied to the project."
|
|
11259
|
+
}
|
|
11260
|
+
},
|
|
11261
|
+
"AWS::DataBrew::Project.Sample": {
|
|
11262
|
+
"attributes": {},
|
|
11263
|
+
"description": "Represents the sample size and sampling type for DataBrew to use for interactive data analysis.",
|
|
11264
|
+
"properties": {
|
|
11265
|
+
"Size": "The number of rows in the sample.",
|
|
11266
|
+
"Type": "The way in which DataBrew obtains rows from a dataset."
|
|
11267
|
+
}
|
|
11268
|
+
},
|
|
11269
|
+
"AWS::DataBrew::Recipe": {
|
|
11270
|
+
"attributes": {
|
|
11271
|
+
"Ref": "When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n\n`{ \"Ref\": \"myRecipe\" }`\n\nFor an AWS Glue DataBrew recipe named `myRecipe` , `Ref` returns the name of the recipe."
|
|
11272
|
+
},
|
|
11273
|
+
"description": "Specifies a new AWS Glue DataBrew transformation recipe.",
|
|
11274
|
+
"properties": {
|
|
11275
|
+
"Description": "The description of the recipe.",
|
|
11276
|
+
"Name": "The unique name for the recipe.",
|
|
11277
|
+
"Steps": "A list of steps that are defined by the recipe.",
|
|
11278
|
+
"Tags": "Metadata tags that have been applied to the recipe."
|
|
11279
|
+
}
|
|
11280
|
+
},
|
|
11281
|
+
"AWS::DataBrew::Recipe.Action": {
|
|
11282
|
+
"attributes": {},
|
|
11283
|
+
"description": "Represents a transformation and associated parameters that are used to apply a change to an AWS Glue DataBrew dataset.",
|
|
11284
|
+
"properties": {
|
|
11285
|
+
"Operation": "The name of a valid DataBrew transformation to be performed on the data.",
|
|
11286
|
+
"Parameters": "Contextual parameters for the transformation."
|
|
11287
|
+
}
|
|
11288
|
+
},
|
|
11289
|
+
"AWS::DataBrew::Recipe.ConditionExpression": {
|
|
11290
|
+
"attributes": {},
|
|
11291
|
+
"description": "Represents an individual condition that evaluates to true or false.\n\nConditions are used with recipe actions. The action is only performed for column values where the condition evaluates to true.\n\nIf a recipe requires more than one condition, then the recipe must specify multiple `ConditionExpression` elements. Each condition is applied to the rows in a dataset first, before the recipe action is performed.",
|
|
11292
|
+
"properties": {
|
|
11293
|
+
"Condition": "A specific condition to apply to a recipe action. For more information, see [Recipe structure](https://docs.aws.amazon.com/databrew/latest/dg/recipe-structure.html) in the *AWS Glue DataBrew Developer Guide* .",
|
|
11294
|
+
"TargetColumn": "A column to apply this condition to.",
|
|
11295
|
+
"Value": "A value that the condition must evaluate to for the condition to succeed."
|
|
11296
|
+
}
|
|
11297
|
+
},
|
|
11298
|
+
"AWS::DataBrew::Recipe.DataCatalogInputDefinition": {
|
|
11299
|
+
"attributes": {},
|
|
11300
|
+
"description": "Represents how metadata stored in the AWS Glue Data Catalog is defined in a DataBrew dataset.",
|
|
11301
|
+
"properties": {
|
|
11302
|
+
"CatalogId": "The unique identifier of the AWS account that holds the Data Catalog that stores the data.",
|
|
11303
|
+
"DatabaseName": "The name of a database in the Data Catalog.",
|
|
11304
|
+
"TableName": "The name of a database table in the Data Catalog. This table corresponds to a DataBrew dataset.",
|
|
11305
|
+
"TempDirectory": "Represents an Amazon location where DataBrew can store intermediate results."
|
|
11306
|
+
}
|
|
11307
|
+
},
|
|
11308
|
+
"AWS::DataBrew::Recipe.ParameterMap": {
|
|
11309
|
+
"attributes": {},
|
|
11310
|
+
"description": "Contextual parameters for a recipe transformation.",
|
|
11311
|
+
"properties": {}
|
|
11312
|
+
},
|
|
11313
|
+
"AWS::DataBrew::Recipe.RecipeParameters": {
|
|
11314
|
+
"attributes": {},
|
|
11315
|
+
"description": "Parameters that are used as inputs for various recipe actions. The parameters are specific to the context in which they're used.",
|
|
11316
|
+
"properties": {
|
|
11317
|
+
"AggregateFunction": "The name of an aggregation function to apply.",
|
|
11318
|
+
"Base": "The number of digits used in a counting system.",
|
|
11319
|
+
"CaseStatement": "A case statement associated with a recipe.",
|
|
11320
|
+
"CategoryMap": "A category map used for one-hot encoding.",
|
|
11321
|
+
"CharsToRemove": "Characters to remove from a step that applies one-hot encoding or tokenization.",
|
|
11322
|
+
"CollapseConsecutiveWhitespace": "Remove any non-word non-punctuation character.",
|
|
11323
|
+
"ColumnDataType": "The data type of the column.",
|
|
11324
|
+
"ColumnRange": "A range of columns to which a step is applied.",
|
|
11325
|
+
"Count": "The number of times a string needs to be repeated.",
|
|
11326
|
+
"CustomCharacters": "One or more characters that can be substituted or removed, depending on the context.",
|
|
11327
|
+
"CustomStopWords": "A list of words to ignore in a step that applies word tokenization.",
|
|
11328
|
+
"CustomValue": "A list of custom values to use in a step that requires that you provide a value to finish the operation.",
|
|
11329
|
+
"DatasetsColumns": "A list of the dataset columns included in a project.",
|
|
11330
|
+
"DateAddValue": "A value that specifies how many units of time to add or subtract for a date math operation.",
|
|
11331
|
+
"DateTimeFormat": "A date format to apply to a date.",
|
|
11332
|
+
"DateTimeParameters": "A set of parameters associated with a datetime.",
|
|
11333
|
+
"DeleteOtherRows": "Determines whether unmapped rows in a categorical mapping should be deleted",
|
|
11334
|
+
"Delimiter": "The delimiter to use when parsing separated values in a text file.",
|
|
11335
|
+
"EndPattern": "The end pattern to locate.",
|
|
11336
|
+
"EndPosition": "The end position to locate.",
|
|
11337
|
+
"EndValue": "The end value to locate.",
|
|
11338
|
+
"ExpandContractions": "A list of word contractions and what they expand to. For eample: *can't* ; *cannot* ; *can not* .",
|
|
11339
|
+
"Exponent": "The exponent to apply in an exponential operation.",
|
|
11340
|
+
"FalseString": "A value that represents `FALSE` .",
|
|
11341
|
+
"GroupByAggFunctionOptions": "Specifies options to apply to the `GROUP BY` used in an aggregation.",
|
|
11342
|
+
"GroupByColumns": "The columns to use in the `GROUP BY` clause.",
|
|
11343
|
+
"HiddenColumns": "A list of columns to hide.",
|
|
11344
|
+
"IgnoreCase": "Indicates that lower and upper case letters are treated equally.",
|
|
11345
|
+
"IncludeInSplit": "Indicates if this column is participating in a split transform.",
|
|
11346
|
+
"Input": "The input location to load the dataset from - Amazon S3 or AWS Glue Data Catalog .",
|
|
11347
|
+
"Interval": "The number of characters to split by.",
|
|
11348
|
+
"IsText": "Indicates if the content is text.",
|
|
11349
|
+
"JoinKeys": "The keys or columns involved in a join.",
|
|
11350
|
+
"JoinType": "The type of join to use, for example, `INNER JOIN` , `OUTER JOIN` , and so on.",
|
|
11351
|
+
"LeftColumns": "The columns on the left side of the join.",
|
|
11352
|
+
"Limit": "The number of times to perform `split` or `replaceBy` in a string",
|
|
11353
|
+
"LowerBound": "The lower boundary for a value.",
|
|
11354
|
+
"MapType": "The type of mappings to apply to construct a new dynamic frame.",
|
|
11355
|
+
"ModeType": "Determines the manner in which mode value is calculated, in case there is more than one mode value. Valid values: `NONE` | `AVERAGE` | `MINIMUM` | `MAXIMUM`",
|
|
11356
|
+
"MultiLine": "Specifies whether JSON input contains embedded new line characters.",
|
|
11357
|
+
"NumRows": "The number of rows to consider in a window.",
|
|
11358
|
+
"NumRowsAfter": "The number of rows to consider after the current row in a window",
|
|
11359
|
+
"NumRowsBefore": "The number of rows to consider before the current row in a window",
|
|
11360
|
+
"OrderByColumn": "A column to sort the results by.",
|
|
11361
|
+
"OrderByColumns": "The columns to sort the results by.",
|
|
11362
|
+
"Other": "The value to assign to unmapped cells, in categorical mapping",
|
|
11363
|
+
"Pattern": "The pattern to locate.",
|
|
11364
|
+
"PatternOption1": "The starting pattern to split between.",
|
|
11365
|
+
"PatternOption2": "The ending pattern to split between.",
|
|
11366
|
+
"PatternOptions": "For splitting by multiple delimiters: A JSON-encoded string that lists the patterns in the format. For example: `[{\\\"pattern\\\":\\\"1\\\",\\\"includeInSplit\\\":true}]`",
|
|
11367
|
+
"Period": "The size of the rolling window.",
|
|
11368
|
+
"Position": "The character index within a string",
|
|
11369
|
+
"RemoveAllPunctuation": "If `true` , removes all of the following characters: `.` `.!` `.,` `.?`",
|
|
11370
|
+
"RemoveAllQuotes": "If `true` , removes all single quotes and double quotes.",
|
|
11371
|
+
"RemoveAllWhitespace": "If `true` , removes all whitespaces from the value.",
|
|
11372
|
+
"RemoveCustomCharacters": "If `true` , removes all chraracters specified by `CustomCharacters` .",
|
|
11373
|
+
"RemoveCustomValue": "If `true` , removes all chraracters specified by `CustomValue` .",
|
|
11374
|
+
"RemoveLeadingAndTrailingPunctuation": "If `true` , removes the following characters if they occur at the start or end of the value: `.` `!` `,` `?`",
|
|
11375
|
+
"RemoveLeadingAndTrailingQuotes": "If `true` , removes single quotes and double quotes from the beginning and end of the value.",
|
|
11376
|
+
"RemoveLeadingAndTrailingWhitespace": "If `true` , removes all whitespaces from the beginning and end of the value.",
|
|
11377
|
+
"RemoveLetters": "If `true` , removes all uppercase and lowercase alphabetic characters (A through Z; a through z).",
|
|
11378
|
+
"RemoveNumbers": "If `true` , removes all numeric characters (0 through 9).",
|
|
11379
|
+
"RemoveSourceColumn": "If `true` , the source column will be removed after un-nesting that column. (Used with nested column types, such as Map, Struct, or Array.)",
|
|
11380
|
+
"RemoveSpecialCharacters": "If `true` , removes all of the following characters: `! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~`",
|
|
11381
|
+
"RightColumns": "The columns on the right side of a join.",
|
|
11382
|
+
"SampleSize": "The number of rows in the sample.",
|
|
11383
|
+
"SampleType": "The sampling type to apply to the dataset. Valid values: `FIRST_N` | `LAST_N` | `RANDOM`",
|
|
11384
|
+
"SecondInput": "A object value to indicate the second dataset used in a join.",
|
|
11385
|
+
"SecondaryInputs": "A list of secondary inputs in a UNION transform",
|
|
11386
|
+
"SheetIndexes": "One or more sheet numbers in the Excel file, which will be included in a dataset.",
|
|
11387
|
+
"SheetNames": "Oone or more named sheets in the Excel file, which will be included in a dataset.",
|
|
11388
|
+
"SourceColumn": "A source column needed for an operation, step, or transform.",
|
|
11389
|
+
"SourceColumn1": "A source column needed for an operation, step, or transform.",
|
|
11390
|
+
"SourceColumn2": "A source column needed for an operation, step, or transform.",
|
|
11391
|
+
"SourceColumns": "A list of source columns needed for an operation, step, or transform.",
|
|
11392
|
+
"StartColumnIndex": "The index number of the first column used by an operation, step, or transform.",
|
|
11393
|
+
"StartPattern": "The starting pattern to locate.",
|
|
11394
|
+
"StartPosition": "The starting position to locate.",
|
|
11395
|
+
"StartValue": "The starting value to locate.",
|
|
11396
|
+
"StemmingMode": "Indicates this operation uses stems and lemmas (base words) for word tokenization.",
|
|
11397
|
+
"StepCount": "The total number of transforms in this recipe.",
|
|
11398
|
+
"StepIndex": "The index ID of a step.",
|
|
11399
|
+
"StopWordsMode": "Indicates this operation uses stop words as part of word tokenization.",
|
|
11400
|
+
"Strategy": "The resolution strategy to apply in resolving ambiguities.",
|
|
11401
|
+
"TargetColumn": "The column targeted by this operation.",
|
|
11402
|
+
"TargetColumnNames": "The names to give columns altered by this operation.",
|
|
11403
|
+
"TargetDateFormat": "The date format to convert to.",
|
|
11404
|
+
"TargetIndex": "The index number of an object that is targeted by this operation.",
|
|
11405
|
+
"TimeZone": "The current timezone that you want to use for dates.",
|
|
11406
|
+
"TokenizerPattern": "A regex expression to use when splitting text into terms, also called words or tokens.",
|
|
11407
|
+
"TrueString": "A value to use to represent `TRUE` .",
|
|
11408
|
+
"UdfLang": "The language that's used in the user-defined function.",
|
|
11409
|
+
"Units": "Specifies a unit of time. For example: `MINUTES` ; `SECONDS` ; `HOURS` ; etc.",
|
|
11410
|
+
"UnpivotColumn": "Cast columns as rows, so that each value is a different row in a single column.",
|
|
11411
|
+
"UpperBound": "The upper boundary for a value.",
|
|
11412
|
+
"UseNewDataFrame": "Create a new container to hold a dataset.",
|
|
11413
|
+
"Value": "A static value that can be used in a comparison, a substitution, or in another context-specific way. A `Value` can be a number, string, or other datatype, depending on the recipe action in which it's used.",
|
|
11414
|
+
"Value1": "A value that's used by this operation.",
|
|
11415
|
+
"Value2": "A value that's used by this operation.",
|
|
11416
|
+
"ValueColumn": "The column that is provided as a value that's used by this operation.",
|
|
11417
|
+
"ViewFrame": "The subset of rows currently available for viewing."
|
|
11418
|
+
}
|
|
11419
|
+
},
|
|
11420
|
+
"AWS::DataBrew::Recipe.RecipeStep": {
|
|
11421
|
+
"attributes": {},
|
|
11422
|
+
"description": "Represents a single step from a DataBrew recipe to be performed.",
|
|
11423
|
+
"properties": {
|
|
11424
|
+
"Action": "The particular action to be performed in the recipe step.",
|
|
11425
|
+
"ConditionExpressions": "One or more conditions that must be met for the recipe step to succeed.\n\n> All of the conditions in the array must be met. In other words, all of the conditions must be combined using a logical AND operation."
|
|
11426
|
+
}
|
|
11427
|
+
},
|
|
11428
|
+
"AWS::DataBrew::Recipe.S3Location": {
|
|
11429
|
+
"attributes": {},
|
|
11430
|
+
"description": "Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.",
|
|
11431
|
+
"properties": {
|
|
11432
|
+
"Bucket": "The Amazon S3 bucket name.",
|
|
11433
|
+
"Key": "The unique name of the object in the bucket."
|
|
11434
|
+
}
|
|
11435
|
+
},
|
|
11436
|
+
"AWS::DataBrew::Recipe.SecondaryInput": {
|
|
11437
|
+
"attributes": {},
|
|
11438
|
+
"description": "Represents secondary inputs in a UNION transform.",
|
|
11439
|
+
"properties": {
|
|
11440
|
+
"DataCatalogInputDefinition": "The AWS Glue Data Catalog parameters for the data.",
|
|
11441
|
+
"S3InputDefinition": "The Amazon S3 location where the data is stored."
|
|
11442
|
+
}
|
|
11443
|
+
},
|
|
11444
|
+
"AWS::DataBrew::Ruleset": {
|
|
11445
|
+
"attributes": {
|
|
11446
|
+
"Ref": "When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the resource name. For example, `{ \"Ref\": \"myRuleset\" }` .\n\nFor an AWS Glue DataBrew ruleset named `myRuleset` , `Ref` returns the name of the ruleset."
|
|
11447
|
+
},
|
|
11448
|
+
"description": "Specifies a new ruleset that can be used in a profile job to validate the data quality of a dataset.",
|
|
11449
|
+
"properties": {
|
|
11450
|
+
"Description": "The description of the ruleset.",
|
|
11451
|
+
"Name": "The name of the ruleset.",
|
|
11452
|
+
"Rules": "Contains metadata about the ruleset.",
|
|
11453
|
+
"Tags": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .",
|
|
11454
|
+
"TargetArn": "The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with."
|
|
11455
|
+
}
|
|
11456
|
+
},
|
|
11457
|
+
"AWS::DataBrew::Ruleset.ColumnSelector": {
|
|
11458
|
+
"attributes": {},
|
|
11459
|
+
"description": "Selector of a column from a dataset for profile job configuration. One selector includes either a column name or a regular expression.",
|
|
11460
|
+
"properties": {
|
|
11461
|
+
"Name": "The name of a column from a dataset.",
|
|
11462
|
+
"Regex": "A regular expression for selecting a column from a dataset."
|
|
11463
|
+
}
|
|
11464
|
+
},
|
|
11465
|
+
"AWS::DataBrew::Ruleset.Rule": {
|
|
11466
|
+
"attributes": {},
|
|
11467
|
+
"description": "Represents a single data quality requirement that should be validated in the scope of this dataset.",
|
|
11468
|
+
"properties": {
|
|
11469
|
+
"CheckExpression": "The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, `(:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2)` . Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no columnn reference in the left side of a condition, for example, `is_between :val1 and :val2` .",
|
|
11470
|
+
"ColumnSelectors": "List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.",
|
|
11471
|
+
"Disabled": "A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.",
|
|
11472
|
+
"Name": "The name of the rule.",
|
|
11473
|
+
"SubstitutionMap": "The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, `\":col1\": \"`Column A`\".`",
|
|
11474
|
+
"Threshold": "The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds."
|
|
11475
|
+
}
|
|
11476
|
+
},
|
|
11477
|
+
"AWS::DataBrew::Ruleset.SubstitutionValue": {
|
|
11478
|
+
"attributes": {},
|
|
11479
|
+
"description": "A key-value pair to associate an expression's substitution variable names with their values.",
|
|
11480
|
+
"properties": {
|
|
11481
|
+
"Value": "Value or column name.",
|
|
11482
|
+
"ValueReference": "Variable name."
|
|
11483
|
+
}
|
|
11484
|
+
},
|
|
11485
|
+
"AWS::DataBrew::Ruleset.Threshold": {
|
|
11486
|
+
"attributes": {},
|
|
11487
|
+
"description": "The threshold used with a non-aggregate check expression. The non-aggregate check expression will be applied to each row in a specific column. Then the threshold will be used to determine whether the validation succeeds.",
|
|
11488
|
+
"properties": {
|
|
11489
|
+
"Type": "The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.",
|
|
11490
|
+
"Unit": "Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.",
|
|
11491
|
+
"Value": "The value of a threshold."
|
|
11492
|
+
}
|
|
11493
|
+
},
|
|
11494
|
+
"AWS::DataBrew::Schedule": {
|
|
11495
|
+
"attributes": {
|
|
11496
|
+
"Ref": "When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:\n\n`{ \"Ref\": \"mySchedule\" }`\n\nFor an AWS Glue DataBrew schedule named `mySchedule` , `Ref` returns the name of the schedule."
|
|
11497
|
+
},
|
|
11498
|
+
"description": "Specifies a new schedule for one or more AWS Glue DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.",
|
|
11499
|
+
"properties": {
|
|
11500
|
+
"CronExpression": "The dates and times when the job is to run. For more information, see [Working with cron expressions for recipe jobs](https://docs.aws.amazon.com/databrew/latest/dg/jobs.recipe.html#jobs.cron) in the *AWS Glue DataBrew Developer Guide* .",
|
|
11501
|
+
"JobNames": "A list of jobs to be run, according to the schedule.",
|
|
11502
|
+
"Name": "The name of the schedule.",
|
|
11503
|
+
"Tags": "Metadata tags that have been applied to the schedule."
|
|
11504
|
+
}
|
|
11505
|
+
},
|
|
10444
11506
|
"AWS::DataPipeline::Pipeline": {
|
|
10445
11507
|
"attributes": {
|
|
10446
11508
|
"Ref": "`Ref` returns the pipeline ID."
|
|
@@ -11879,7 +12941,7 @@
|
|
|
11879
12941
|
"attributes": {
|
|
11880
12942
|
"Ref": "`Ref` returns the resource name."
|
|
11881
12943
|
},
|
|
11882
|
-
"description": "Associates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account
|
|
12944
|
+
"description": "Associates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account. For more information about working with Elastic IP addresses, see [Elastic IP address concepts and rules](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#vpc-eip-overview) .\n\nAn Elastic IP address can be used in EC2-Classic and EC2-VPC accounts. There are differences between an Elastic IP address that you use in a VPC and one that you use in EC2-Classic. For more information, see [Differences between instances in EC2-Classic and a VPC](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-classic-platform.html#differences-ec2-classic-vpc) .\n\n[EC2-VPC] You must specify `AllocationId` and either `InstanceId` , `NetworkInterfaceId` , or `PrivateIpAddress` .\n\n[EC2-Classic] You must specify `EIP` and `InstanceId` .",
|
|
11883
12945
|
"properties": {
|
|
11884
12946
|
"AllocationId": "[EC2-VPC] The allocation ID. This is required for EC2-VPC.",
|
|
11885
12947
|
"EIP": "[EC2-Classic] The Elastic IP address to associate with the instance. This is required for EC2-Classic.",
|
|
@@ -13683,6 +14745,7 @@
|
|
|
13683
14745
|
"description": "Specifies a target for your Traffic Mirror session.\n\nA Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.\n\nA Traffic Mirror target can be a network interface, or a Network Load Balancer.\n\nTo use the target in a Traffic Mirror session, use [AWS::EC2::TrafficMirrorSession](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html) .",
|
|
13684
14746
|
"properties": {
|
|
13685
14747
|
"Description": "The description of the Traffic Mirror target.",
|
|
14748
|
+
"GatewayLoadBalancerEndpointId": "",
|
|
13686
14749
|
"NetworkInterfaceId": "The network interface ID that is associated with the target.",
|
|
13687
14750
|
"NetworkLoadBalancerArn": "The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.",
|
|
13688
14751
|
"Tags": "The tags to assign to the Traffic Mirror target."
|
|
@@ -13711,6 +14774,7 @@
|
|
|
13711
14774
|
},
|
|
13712
14775
|
"AWS::EC2::TransitGatewayAttachment": {
|
|
13713
14776
|
"attributes": {
|
|
14777
|
+
"Id": "",
|
|
13714
14778
|
"Ref": "`Ref` returns the ID of the attachment."
|
|
13715
14779
|
},
|
|
13716
14780
|
"description": "Attaches a VPC to a transit gateway.\n\nIf you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.\n\nTo send VPC traffic to an attached transit gateway, add a route to the VPC route table using [AWS::EC2::Route](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html) .",
|
|
@@ -13891,15 +14955,16 @@
|
|
|
13891
14955
|
"DefaultNetworkAcl": "The default network ACL ID that is associated with the VPC. For example, `acl-814dafe3` .",
|
|
13892
14956
|
"DefaultSecurityGroup": "The default security group ID that is associated with the VPC. For example, `sg-b178e0d3` .",
|
|
13893
14957
|
"Ipv6CidrBlocks": "The IPv6 CIDR blocks that are associated with the VPC, such as `[ 2001:db8:1234:1a00::/56 ]` .",
|
|
13894
|
-
"Ref": "`Ref` returns the ID of the VPC."
|
|
14958
|
+
"Ref": "`Ref` returns the ID of the VPC.",
|
|
14959
|
+
"VpcId": ""
|
|
13895
14960
|
},
|
|
13896
14961
|
"description": "Specifies a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see [Overview of VPCs and subnets](https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html) in the *Amazon Virtual Private Cloud User Guide* .",
|
|
13897
14962
|
"properties": {
|
|
13898
|
-
"CidrBlock": "The
|
|
14963
|
+
"CidrBlock": "The IPv4 network range for the VPC, in CIDR notation. For example, `10.0.0.0/16` . We modify the specified CIDR block to its canonical form; for example, if you specify `100.68.0.18/18` , we modify it to `100.68.0.0/18` .\n\nYou must specify either `CidrBlock` or `Ipv4IpamPoolId` .",
|
|
13899
14964
|
"EnableDnsHostnames": "Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support) .\n\nYou can only enable DNS hostnames if you've enabled DNS support.",
|
|
13900
14965
|
"EnableDnsSupport": "Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support) .",
|
|
13901
14966
|
"InstanceTenancy": "The allowed tenancy of instances launched into the VPC.\n\n- `\"default\"` : An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.\n- `\"dedicated\"` : An instance launched into the VPC is a Dedicated Instance by default, unless you explicitly specify a tenancy of host during instance launch. You cannot specify a tenancy of default during instance launch.\n\nUpdating `InstanceTenancy` requires no replacement only if you are updating its value from `\"dedicated\"` to `\"default\"` . Updating `InstanceTenancy` from `\"default\"` to `\"dedicated\"` requires replacement.",
|
|
13902
|
-
"Ipv4IpamPoolId": "The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .",
|
|
14967
|
+
"Ipv4IpamPoolId": "The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .\n\nYou must specify either `CidrBlock` or `Ipv4IpamPoolId` .",
|
|
13903
14968
|
"Ipv4NetmaskLength": "The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide* .",
|
|
13904
14969
|
"Tags": "The tags for the VPC."
|
|
13905
14970
|
}
|
|
@@ -18027,6 +19092,34 @@
|
|
|
18027
19092
|
"LastName": "The last name of the superuser."
|
|
18028
19093
|
}
|
|
18029
19094
|
},
|
|
19095
|
+
"AWS::Forecast::Dataset": {
|
|
19096
|
+
"attributes": {
|
|
19097
|
+
"Arn": "The Amazon Resource Name (ARN) of the dataset.",
|
|
19098
|
+
"Ref": "`Ref` returns the resource name."
|
|
19099
|
+
},
|
|
19100
|
+
"description": "Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:\n\n- *`DataFrequency`* - How frequently your historical time-series data is collected.\n- *`Domain`* and *`DatasetType`* - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields.\n- *`Schema`* - A schema specifies the fields in the dataset, including the field name and data type.\n\nAfter creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see [Importing datasets](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html) .\n\nTo get a list of all your datasets, use the [ListDatasets](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html) operation.\n\nFor example Forecast datasets, see the [Amazon Forecast Sample GitHub repository](https://docs.aws.amazon.com/https://github.com/aws-samples/amazon-forecast-samples) .\n\n> The `Status` of a dataset must be `ACTIVE` before you can import training data. Use the [DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) operation to get the status.",
|
|
19101
|
+
"properties": {
|
|
19102
|
+
"DataFrequency": "The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.\n\nValid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, \"D\" indicates every day and \"15min\" indicates every 15 minutes.",
|
|
19103
|
+
"DatasetName": "The name of the dataset.",
|
|
19104
|
+
"DatasetType": "The dataset type.",
|
|
19105
|
+
"Domain": "The domain associated with the dataset.",
|
|
19106
|
+
"EncryptionConfig": "A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.",
|
|
19107
|
+
"Schema": "The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset `Domain` and `DatasetType` that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see [Dataset Domains and Dataset Types](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html) .",
|
|
19108
|
+
"Tags": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) ."
|
|
19109
|
+
}
|
|
19110
|
+
},
|
|
19111
|
+
"AWS::Forecast::DatasetGroup": {
|
|
19112
|
+
"attributes": {
|
|
19113
|
+
"DatasetGroupArn": "The Amazon Resource Name (ARN) of the dataset group."
|
|
19114
|
+
},
|
|
19115
|
+
"description": "Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the [UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) operation.\n\nAfter creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see [Dataset groups](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html) .\n\nTo get a list of all your datasets groups, use the [ListDatasetGroups](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html) operation.\n\n> The `Status` of a dataset group must be `ACTIVE` before you can use the dataset group to create a predictor. To get the status, use the [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) operation.",
|
|
19116
|
+
"properties": {
|
|
19117
|
+
"DatasetArns": "An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.",
|
|
19118
|
+
"DatasetGroupName": "The name of the dataset group.",
|
|
19119
|
+
"Domain": "The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the `Domain` parameter of the [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) operation must match.\n\nThe `Domain` and `DatasetType` that you choose determine the fields that must be present in training data that you import to a dataset. For example, if you choose the `RETAIL` domain and `TARGET_TIME_SERIES` as the `DatasetType` , Amazon Forecast requires that `item_id` , `timestamp` , and `demand` fields are present in your data. For more information, see [Dataset groups](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html) .",
|
|
19120
|
+
"Tags": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) ."
|
|
19121
|
+
}
|
|
19122
|
+
},
|
|
18030
19123
|
"AWS::FraudDetector::Detector": {
|
|
18031
19124
|
"attributes": {
|
|
18032
19125
|
"Arn": "The detector ARN.",
|
|
@@ -21258,6 +22351,109 @@
|
|
|
21258
22351
|
"ResourceGroupTags": "The tags (key and value pairs) that will be associated with the resource group.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) ."
|
|
21259
22352
|
}
|
|
21260
22353
|
},
|
|
22354
|
+
"AWS::InspectorV2::Filter": {
|
|
22355
|
+
"attributes": {
|
|
22356
|
+
"Arn": "The Amazon Resource Number (ARN) associated with this filter.",
|
|
22357
|
+
"Ref": "`Ref` returns the ARN of the filter. For example:\n\n`arn:aws:inspector2:us-east-1:012345678901:owner/012345678901/filter/c1c0fe5d28e39baa`"
|
|
22358
|
+
},
|
|
22359
|
+
"description": "Details about a filter.",
|
|
22360
|
+
"properties": {
|
|
22361
|
+
"Description": "A description of the filter.",
|
|
22362
|
+
"FilterAction": "The action that is to be applied to the findings that match the filter.",
|
|
22363
|
+
"FilterCriteria": "Details on the filter criteria associated with this filter.",
|
|
22364
|
+
"Name": "The name of the filter."
|
|
22365
|
+
}
|
|
22366
|
+
},
|
|
22367
|
+
"AWS::InspectorV2::Filter.DateFilter": {
|
|
22368
|
+
"attributes": {},
|
|
22369
|
+
"description": "Contains details on the time range used to filter findings.",
|
|
22370
|
+
"properties": {
|
|
22371
|
+
"EndInclusive": "A timestamp representing the end of the time period filtered on.",
|
|
22372
|
+
"StartInclusive": "A timestamp representing the start of the time period filtered on."
|
|
22373
|
+
}
|
|
22374
|
+
},
|
|
22375
|
+
"AWS::InspectorV2::Filter.FilterCriteria": {
|
|
22376
|
+
"attributes": {},
|
|
22377
|
+
"description": "Details on the criteria used to define the filter.",
|
|
22378
|
+
"properties": {
|
|
22379
|
+
"AwsAccountId": "Details of the AWS account IDs used to filter findings.",
|
|
22380
|
+
"ComponentId": "Details of the component IDs used to filter findings.",
|
|
22381
|
+
"ComponentType": "Details of the component types used to filter findings.",
|
|
22382
|
+
"Ec2InstanceImageId": "Details of the Amazon EC2 instance image IDs used to filter findings.",
|
|
22383
|
+
"Ec2InstanceSubnetId": "Details of the Amazon EC2 instance subnet IDs used to filter findings.",
|
|
22384
|
+
"Ec2InstanceVpcId": "Details of the Amazon EC2 instance VPC IDs used to filter findings.",
|
|
22385
|
+
"EcrImageArchitecture": "Details of the Amazon ECR image architecture types used to filter findings.",
|
|
22386
|
+
"EcrImageHash": "Details of the Amazon ECR image hashes used to filter findings.",
|
|
22387
|
+
"EcrImagePushedAt": "Details on the Amazon ECR image push date and time used to filter findings.",
|
|
22388
|
+
"EcrImageRegistry": "Details on the Amazon ECR registry used to filter findings.",
|
|
22389
|
+
"EcrImageRepositoryName": "Details on the name of the Amazon ECR repository used to filter findings.",
|
|
22390
|
+
"EcrImageTags": "The tags attached to the Amazon ECR container image.",
|
|
22391
|
+
"FindingArn": "Details on the finding ARNs used to filter findings.",
|
|
22392
|
+
"FindingStatus": "Details on the finding status types used to filter findings.",
|
|
22393
|
+
"FindingType": "Details on the finding types used to filter findings.",
|
|
22394
|
+
"FirstObservedAt": "Details on the date and time a finding was first seen used to filter findings.",
|
|
22395
|
+
"InspectorScore": "The Amazon Inspector score to filter on.",
|
|
22396
|
+
"LastObservedAt": "Details on the date and time a finding was last seen used to filter findings.",
|
|
22397
|
+
"NetworkProtocol": "Details on the ingress source addresses used to filter findings.",
|
|
22398
|
+
"PortRange": "Details on the port ranges used to filter findings.",
|
|
22399
|
+
"RelatedVulnerabilities": "Details on the related vulnerabilities used to filter findings.",
|
|
22400
|
+
"ResourceId": "Details on the resource IDs used to filter findings.",
|
|
22401
|
+
"ResourceTags": "Details on the resource tags used to filter findings.",
|
|
22402
|
+
"ResourceType": "Details on the resource types used to filter findings.",
|
|
22403
|
+
"Severity": "Details on the severity used to filter findings.",
|
|
22404
|
+
"Title": "Details on the finding title used to filter findings.",
|
|
22405
|
+
"UpdatedAt": "Details on the date and time a finding was last updated at used to filter findings.",
|
|
22406
|
+
"VendorSeverity": "Details on the vendor severity used to filter findings.",
|
|
22407
|
+
"VulnerabilityId": "Details on the vulnerability ID used to filter findings.",
|
|
22408
|
+
"VulnerabilitySource": "Details on the vulnerability score to filter findings by.",
|
|
22409
|
+
"VulnerablePackages": "Details on the vulnerable packages used to filter findings."
|
|
22410
|
+
}
|
|
22411
|
+
},
|
|
22412
|
+
"AWS::InspectorV2::Filter.MapFilter": {
|
|
22413
|
+
"attributes": {},
|
|
22414
|
+
"description": "An object that describes details of a map filter.",
|
|
22415
|
+
"properties": {
|
|
22416
|
+
"Comparison": "The operator to use when comparing values in the filter.",
|
|
22417
|
+
"Key": "The tag key used in the filter.",
|
|
22418
|
+
"Value": "The tag value used in the filter."
|
|
22419
|
+
}
|
|
22420
|
+
},
|
|
22421
|
+
"AWS::InspectorV2::Filter.NumberFilter": {
|
|
22422
|
+
"attributes": {},
|
|
22423
|
+
"description": "An object that describes the details of a number filter.",
|
|
22424
|
+
"properties": {
|
|
22425
|
+
"LowerInclusive": "The lowest number to be included in the filter.",
|
|
22426
|
+
"UpperInclusive": "The highest number to be included in the filter."
|
|
22427
|
+
}
|
|
22428
|
+
},
|
|
22429
|
+
"AWS::InspectorV2::Filter.PackageFilter": {
|
|
22430
|
+
"attributes": {},
|
|
22431
|
+
"description": "Contains information on the details of a package filter.",
|
|
22432
|
+
"properties": {
|
|
22433
|
+
"Architecture": "An object that contains details on the package architecture type to filter on.",
|
|
22434
|
+
"Epoch": "An object that contains details on the package epoch to filter on.",
|
|
22435
|
+
"Name": "An object that contains details on the name of the package to filter on.",
|
|
22436
|
+
"Release": "An object that contains details on the package release to filter on.",
|
|
22437
|
+
"SourceLayerHash": "An object that contains details on the source layer hash to filter on.",
|
|
22438
|
+
"Version": "The package version to filter on."
|
|
22439
|
+
}
|
|
22440
|
+
},
|
|
22441
|
+
"AWS::InspectorV2::Filter.PortRangeFilter": {
|
|
22442
|
+
"attributes": {},
|
|
22443
|
+
"description": "An object that describes the details of a port range filter.",
|
|
22444
|
+
"properties": {
|
|
22445
|
+
"BeginInclusive": "The port number the port range begins at.",
|
|
22446
|
+
"EndInclusive": "The port number the port range ends at."
|
|
22447
|
+
}
|
|
22448
|
+
},
|
|
22449
|
+
"AWS::InspectorV2::Filter.StringFilter": {
|
|
22450
|
+
"attributes": {},
|
|
22451
|
+
"description": "An object that describes the details of a string filter.",
|
|
22452
|
+
"properties": {
|
|
22453
|
+
"Comparison": "The operator to use when comparing values in the filter",
|
|
22454
|
+
"Value": "The value to filter on."
|
|
22455
|
+
}
|
|
22456
|
+
},
|
|
21261
22457
|
"AWS::IoT1Click::Device": {
|
|
21262
22458
|
"attributes": {
|
|
21263
22459
|
"Arn": "The ARN of the device, such as `arn:aws:iot1click:us-west-2:123456789012:devices/G030PX0312744DWM` .",
|
|
@@ -21520,7 +22716,7 @@
|
|
|
21520
22716
|
"description": "Configure logging.",
|
|
21521
22717
|
"properties": {
|
|
21522
22718
|
"AccountId": "The account ID.",
|
|
21523
|
-
"DefaultLogLevel": "The default log level.Valid Values: `DEBUG | INFO | ERROR | WARN | DISABLED`",
|
|
22719
|
+
"DefaultLogLevel": "The default log level. Valid Values: `DEBUG | INFO | ERROR | WARN | DISABLED`",
|
|
21524
22720
|
"RoleArn": "The role ARN used for the log."
|
|
21525
22721
|
}
|
|
21526
22722
|
},
|
|
@@ -21649,6 +22845,19 @@
|
|
|
21649
22845
|
"TargetType": "The target type. Valid Values: `DEFAULT | THING_GROUP`"
|
|
21650
22846
|
}
|
|
21651
22847
|
},
|
|
22848
|
+
"AWS::IoT::RoleAlias": {
|
|
22849
|
+
"attributes": {
|
|
22850
|
+
"Ref": "`Ref` returns the role alias name.",
|
|
22851
|
+
"RoleAliasArn": "The role alias ARN."
|
|
22852
|
+
},
|
|
22853
|
+
"description": "Specifies a role alias.\n\nRequires permission to access the [CreateRoleAlias](https://docs.aws.amazon.com//service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.",
|
|
22854
|
+
"properties": {
|
|
22855
|
+
"CredentialDurationSeconds": "The number of seconds for which the credential is valid.",
|
|
22856
|
+
"RoleAlias": "The role alias.",
|
|
22857
|
+
"RoleArn": "The role ARN.",
|
|
22858
|
+
"Tags": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) ."
|
|
22859
|
+
}
|
|
22860
|
+
},
|
|
21652
22861
|
"AWS::IoT::ScheduledAudit": {
|
|
21653
22862
|
"attributes": {
|
|
21654
22863
|
"Ref": "`Ref` returns the scheduled audit name.",
|
|
@@ -23445,6 +24654,193 @@
|
|
|
23445
24654
|
"Text": "The GraphQL text that defines the entity."
|
|
23446
24655
|
}
|
|
23447
24656
|
},
|
|
24657
|
+
"AWS::IoTTwinMaker::ComponentType": {
|
|
24658
|
+
"attributes": {
|
|
24659
|
+
"Arn": "The ARN of the component type.",
|
|
24660
|
+
"CreationDateTime": "The date and time when the component type was created.",
|
|
24661
|
+
"IsAbstract": "A boolean value that specifies whether the component type is abstract.",
|
|
24662
|
+
"IsSchemaInitialized": "A boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.",
|
|
24663
|
+
"Ref": "`Ref` returns the ComponentTypeID.",
|
|
24664
|
+
"UpdateDateTime": "The component type the update time."
|
|
24665
|
+
},
|
|
24666
|
+
"description": "Use the `AWS::IoTTwinMaker::ComponentType` resource to declare a component type.",
|
|
24667
|
+
"properties": {
|
|
24668
|
+
"ComponentTypeId": "The ID of the component type.",
|
|
24669
|
+
"Description": "The description of the component type.",
|
|
24670
|
+
"ExtendsFrom": "The name of the parent component type that this component type extends.",
|
|
24671
|
+
"Functions": "An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.\n\nFor information on the FunctionResponse object see the [FunctionResponse](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_FunctionResponse.html) API reference.",
|
|
24672
|
+
"IsSingleton": "A boolean value that specifies whether an entity can have more than one component of this type.",
|
|
24673
|
+
"PropertyDefinitions": "An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.\n\nFor information about the PropertyDefinitionResponse object, see the [PropertyDefinitionResponse](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_PropertyDefinitionResponse.html) API reference.",
|
|
24674
|
+
"Tags": "The ComponentType tags.",
|
|
24675
|
+
"WorkspaceId": "The ID of the workspace."
|
|
24676
|
+
}
|
|
24677
|
+
},
|
|
24678
|
+
"AWS::IoTTwinMaker::ComponentType.DataConnector": {
|
|
24679
|
+
"attributes": {},
|
|
24680
|
+
"description": "The data connector.",
|
|
24681
|
+
"properties": {
|
|
24682
|
+
"IsNative": "A boolean value that specifies whether the data connector is native to IoT TwinMaker.",
|
|
24683
|
+
"Lambda": "The Lambda function associated with the data connector."
|
|
24684
|
+
}
|
|
24685
|
+
},
|
|
24686
|
+
"AWS::IoTTwinMaker::ComponentType.DataType": {
|
|
24687
|
+
"attributes": {},
|
|
24688
|
+
"description": "An object that specifies the data type of a property.",
|
|
24689
|
+
"properties": {
|
|
24690
|
+
"AllowedValues": "The allowed values for this data type.",
|
|
24691
|
+
"NestedType": "The nested type in the data type.",
|
|
24692
|
+
"Relationship": "A relationship that associates a component with another component.",
|
|
24693
|
+
"Type": "The underlying type of the data type.\n\nValid Values: `RELATIONSHIP | STRING | LONG | BOOLEAN | INTEGER | DOUBLE | LIST | MAP`",
|
|
24694
|
+
"UnitOfMeasure": "The unit of measure used in this data type."
|
|
24695
|
+
}
|
|
24696
|
+
},
|
|
24697
|
+
"AWS::IoTTwinMaker::ComponentType.DataValue": {
|
|
24698
|
+
"attributes": {},
|
|
24699
|
+
"description": "An object that specifies a value for a property.",
|
|
24700
|
+
"properties": {
|
|
24701
|
+
"BooleanValue": "A boolean value.",
|
|
24702
|
+
"DoubleValue": "A double value.",
|
|
24703
|
+
"Expression": "An expression that produces the value.",
|
|
24704
|
+
"IntegerValue": "An integer value.",
|
|
24705
|
+
"ListValue": "A list of multiple values.",
|
|
24706
|
+
"LongValue": "A long value.",
|
|
24707
|
+
"MapValue": "An object that maps strings to multiple `DataValue` objects.",
|
|
24708
|
+
"RelationshipValue": "A value that relates a component to another component.",
|
|
24709
|
+
"StringValue": "A string value."
|
|
24710
|
+
}
|
|
24711
|
+
},
|
|
24712
|
+
"AWS::IoTTwinMaker::ComponentType.Function": {
|
|
24713
|
+
"attributes": {},
|
|
24714
|
+
"description": "The function body.",
|
|
24715
|
+
"properties": {
|
|
24716
|
+
"ImplementedBy": "The data connector.",
|
|
24717
|
+
"RequiredProperties": "The required properties of the function.",
|
|
24718
|
+
"Scope": "The scope of the function."
|
|
24719
|
+
}
|
|
24720
|
+
},
|
|
24721
|
+
"AWS::IoTTwinMaker::ComponentType.LambdaFunction": {
|
|
24722
|
+
"attributes": {},
|
|
24723
|
+
"description": "The Lambda function.",
|
|
24724
|
+
"properties": {
|
|
24725
|
+
"Arn": "The Lambda function ARN."
|
|
24726
|
+
}
|
|
24727
|
+
},
|
|
24728
|
+
"AWS::IoTTwinMaker::ComponentType.PropertyDefinition": {
|
|
24729
|
+
"attributes": {},
|
|
24730
|
+
"description": "PropertyDefinition is an object that maps strings to the property definitions in the component type.",
|
|
24731
|
+
"properties": {
|
|
24732
|
+
"Configurations": "A mapping that specifies configuration information about the property.",
|
|
24733
|
+
"DataType": "",
|
|
24734
|
+
"DefaultValue": "A boolean value that specifies whether the property ID comes from an external data store.",
|
|
24735
|
+
"IsExternalId": "A boolean value that specifies whether the property ID comes from an external data store.",
|
|
24736
|
+
"IsRequiredInEntity": "A boolean value that specifies whether the property is required in an entity.",
|
|
24737
|
+
"IsStoredExternally": "A boolean value that specifies whether the property is stored externally.",
|
|
24738
|
+
"IsTimeSeries": "A boolean value that specifies whether the property consists of time series data."
|
|
24739
|
+
}
|
|
24740
|
+
},
|
|
24741
|
+
"AWS::IoTTwinMaker::ComponentType.Relationship": {
|
|
24742
|
+
"attributes": {},
|
|
24743
|
+
"description": "An object that specifies a relationship with another component type.",
|
|
24744
|
+
"properties": {
|
|
24745
|
+
"RelationshipType": "The type of the relationship.",
|
|
24746
|
+
"TargetComponentTypeId": "The ID of the target component type associated with this relationship."
|
|
24747
|
+
}
|
|
24748
|
+
},
|
|
24749
|
+
"AWS::IoTTwinMaker::Entity": {
|
|
24750
|
+
"attributes": {
|
|
24751
|
+
"Arn": "The entity ARN.",
|
|
24752
|
+
"CreationDateTime": "The date and time the entity was created.",
|
|
24753
|
+
"HasChildEntities": "A boolean value that specifies whether the entity has child entities or not.",
|
|
24754
|
+
"Ref": "`Ref` returns The ID of the entity.",
|
|
24755
|
+
"UpdateDateTime": "The date and time when the component type was last updated."
|
|
24756
|
+
},
|
|
24757
|
+
"description": "Use the `AWS::IoTTwinMaker::Entity` resource to declare an entity.",
|
|
24758
|
+
"properties": {
|
|
24759
|
+
"Components": "An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.\n\nFor information on the component object see the [component](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_ComponentResponse.html) API reference.",
|
|
24760
|
+
"Description": "The description of the entity.",
|
|
24761
|
+
"EntityId": "The entity ID.",
|
|
24762
|
+
"EntityName": "The entity name.",
|
|
24763
|
+
"ParentEntityId": "The ID of the parent entity.",
|
|
24764
|
+
"Tags": "Metadata that you can use to manage the entity.",
|
|
24765
|
+
"WorkspaceId": "The ID of the workspace."
|
|
24766
|
+
}
|
|
24767
|
+
},
|
|
24768
|
+
"AWS::IoTTwinMaker::Entity.Component": {
|
|
24769
|
+
"attributes": {},
|
|
24770
|
+
"description": "The entity componenet.",
|
|
24771
|
+
"properties": {
|
|
24772
|
+
"ComponentName": "The name of the component.",
|
|
24773
|
+
"ComponentTypeId": "The ID of the ComponentType.",
|
|
24774
|
+
"DefinedIn": "The name of the property definition set in the request.",
|
|
24775
|
+
"Description": "The description of the component.",
|
|
24776
|
+
"Properties": "An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.",
|
|
24777
|
+
"Status": "The status of the component."
|
|
24778
|
+
}
|
|
24779
|
+
},
|
|
24780
|
+
"AWS::IoTTwinMaker::Entity.DataValue": {
|
|
24781
|
+
"attributes": {},
|
|
24782
|
+
"description": "An object that specifies a value for a property.",
|
|
24783
|
+
"properties": {
|
|
24784
|
+
"BooleanValue": "A boolean value.",
|
|
24785
|
+
"DoubleValue": "A double value.",
|
|
24786
|
+
"Expression": "An expression that produces the value.",
|
|
24787
|
+
"IntegerValue": "An integer value.",
|
|
24788
|
+
"ListValue": "A list of multiple values.",
|
|
24789
|
+
"LongValue": "A long value.",
|
|
24790
|
+
"MapValue": "An object that maps strings to multiple DataValue objects.",
|
|
24791
|
+
"RelationshipValue": "A value that relates a component to another component.",
|
|
24792
|
+
"StringValue": "A string value."
|
|
24793
|
+
}
|
|
24794
|
+
},
|
|
24795
|
+
"AWS::IoTTwinMaker::Entity.Property": {
|
|
24796
|
+
"attributes": {},
|
|
24797
|
+
"description": "An object that sets information about a property.",
|
|
24798
|
+
"properties": {
|
|
24799
|
+
"Definition": "An object that specifies information about a property.",
|
|
24800
|
+
"Value": "An object that contains information about a value for a time series property."
|
|
24801
|
+
}
|
|
24802
|
+
},
|
|
24803
|
+
"AWS::IoTTwinMaker::Entity.Status": {
|
|
24804
|
+
"attributes": {},
|
|
24805
|
+
"description": "The current status of the entity.",
|
|
24806
|
+
"properties": {
|
|
24807
|
+
"Error": "The error message.",
|
|
24808
|
+
"State": "The current state of the entity, component, component type, or workspace.\n\nValid Values: `CREATING | UPDATING | DELETING | ACTIVE | ERROR`"
|
|
24809
|
+
}
|
|
24810
|
+
},
|
|
24811
|
+
"AWS::IoTTwinMaker::Scene": {
|
|
24812
|
+
"attributes": {
|
|
24813
|
+
"Arn": "The scene ARN.",
|
|
24814
|
+
"CreationDateTime": "The date and time when the scene was created.",
|
|
24815
|
+
"Ref": "`Ref` returns the ID of the scene.",
|
|
24816
|
+
"UpdateDateTime": "The scene the update time."
|
|
24817
|
+
},
|
|
24818
|
+
"description": "Use the `AWS::IoTTwinMaker::Scene` resource to declare a scene.",
|
|
24819
|
+
"properties": {
|
|
24820
|
+
"Capabilities": "A list of capabilities that the scene uses to render.",
|
|
24821
|
+
"ContentLocation": "The relative path that specifies the location of the content definition file.",
|
|
24822
|
+
"Description": "The description of this scene.",
|
|
24823
|
+
"SceneId": "The scene ID.",
|
|
24824
|
+
"Tags": "The ComponentType tags.",
|
|
24825
|
+
"WorkspaceId": "The ID of the workspace."
|
|
24826
|
+
}
|
|
24827
|
+
},
|
|
24828
|
+
"AWS::IoTTwinMaker::Workspace": {
|
|
24829
|
+
"attributes": {
|
|
24830
|
+
"Arn": "The workspace ARN.",
|
|
24831
|
+
"CreationDateTime": "The date and time the workspace was created.",
|
|
24832
|
+
"Ref": "`Ref` returns the WorkspaceID.",
|
|
24833
|
+
"UpdateDateTime": "The date and time the workspace was updated."
|
|
24834
|
+
},
|
|
24835
|
+
"description": "Use the `AWS::IoTTwinMaker::Workspace` resource to declare a workspace.",
|
|
24836
|
+
"properties": {
|
|
24837
|
+
"Description": "The description of the workspace.",
|
|
24838
|
+
"Role": "The ARN of the execution role associated with the workspace.",
|
|
24839
|
+
"S3Location": "The ARN of the S3 bucket where resources associated with the workspace are stored.",
|
|
24840
|
+
"Tags": "Metadata that you can use to manage the workspace.",
|
|
24841
|
+
"WorkspaceId": "The ID of the workspace."
|
|
24842
|
+
}
|
|
24843
|
+
},
|
|
23448
24844
|
"AWS::IoTWireless::Destination": {
|
|
23449
24845
|
"attributes": {
|
|
23450
24846
|
"Arn": "The ARN of the destination created.",
|
|
@@ -23838,6 +25234,169 @@
|
|
|
23838
25234
|
"Tags": "Assigns one or more tags to the replica key.\n\n> Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *AWS Key Management Service Developer Guide* . \n\nTags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. AWS KMS does not synchronize this property.\n\nEach tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.\n\nWhen you assign tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) ."
|
|
23839
25235
|
}
|
|
23840
25236
|
},
|
|
25237
|
+
"AWS::KafkaConnect::Connector": {
|
|
25238
|
+
"attributes": {
|
|
25239
|
+
"ConnectorArn": "The Amazon Resource Name (ARN) of the newly created connector.",
|
|
25240
|
+
"Ref": ""
|
|
25241
|
+
},
|
|
25242
|
+
"description": "Creates a connector using the specified properties.",
|
|
25243
|
+
"properties": {
|
|
25244
|
+
"Capacity": "The connector's compute capacity settings.",
|
|
25245
|
+
"ConnectorConfiguration": "The configuration of the connector.",
|
|
25246
|
+
"ConnectorDescription": "The description of the connector.",
|
|
25247
|
+
"ConnectorName": "The name of the connector.",
|
|
25248
|
+
"KafkaCluster": "The details of the Apache Kafka cluster to which the connector is connected.",
|
|
25249
|
+
"KafkaClusterClientAuthentication": "The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.",
|
|
25250
|
+
"KafkaClusterEncryptionInTransit": "Details of encryption in transit to the Apache Kafka cluster.",
|
|
25251
|
+
"KafkaConnectVersion": "The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.",
|
|
25252
|
+
"LogDelivery": "The settings for delivering connector logs to Amazon CloudWatch Logs.",
|
|
25253
|
+
"Plugins": "Specifies which plugin to use for the connector. You must specify a single-element list. Amazon MSK Connect does not currently support specifying multiple plugins.",
|
|
25254
|
+
"ServiceExecutionRoleArn": "The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.",
|
|
25255
|
+
"WorkerConfiguration": "The worker configurations that are in use with the connector."
|
|
25256
|
+
}
|
|
25257
|
+
},
|
|
25258
|
+
"AWS::KafkaConnect::Connector.ApacheKafkaCluster": {
|
|
25259
|
+
"attributes": {},
|
|
25260
|
+
"description": "The details of the Apache Kafka cluster to which the connector is connected.",
|
|
25261
|
+
"properties": {
|
|
25262
|
+
"BootstrapServers": "The bootstrap servers of the cluster.",
|
|
25263
|
+
"Vpc": "Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster."
|
|
25264
|
+
}
|
|
25265
|
+
},
|
|
25266
|
+
"AWS::KafkaConnect::Connector.AutoScaling": {
|
|
25267
|
+
"attributes": {},
|
|
25268
|
+
"description": "Specifies how the connector scales.",
|
|
25269
|
+
"properties": {
|
|
25270
|
+
"MaxWorkerCount": "The maximum number of workers allocated to the connector.",
|
|
25271
|
+
"McuCount": "The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.",
|
|
25272
|
+
"MinWorkerCount": "The minimum number of workers allocated to the connector.",
|
|
25273
|
+
"ScaleInPolicy": "The sacle-in policy for the connector.",
|
|
25274
|
+
"ScaleOutPolicy": "The sacle-out policy for the connector."
|
|
25275
|
+
}
|
|
25276
|
+
},
|
|
25277
|
+
"AWS::KafkaConnect::Connector.Capacity": {
|
|
25278
|
+
"attributes": {},
|
|
25279
|
+
"description": "Information about the capacity of the connector, whether it is auto scaled or provisioned.",
|
|
25280
|
+
"properties": {
|
|
25281
|
+
"AutoScaling": "Information about the auto scaling parameters for the connector.",
|
|
25282
|
+
"ProvisionedCapacity": "Details about a fixed capacity allocated to a connector."
|
|
25283
|
+
}
|
|
25284
|
+
},
|
|
25285
|
+
"AWS::KafkaConnect::Connector.CloudWatchLogsLogDelivery": {
|
|
25286
|
+
"attributes": {},
|
|
25287
|
+
"description": "The settings for delivering connector logs to Amazon CloudWatch Logs.",
|
|
25288
|
+
"properties": {
|
|
25289
|
+
"Enabled": "Whether log delivery to Amazon CloudWatch Logs is enabled.",
|
|
25290
|
+
"LogGroup": "The name of the CloudWatch log group that is the destination for log delivery."
|
|
25291
|
+
}
|
|
25292
|
+
},
|
|
25293
|
+
"AWS::KafkaConnect::Connector.CustomPlugin": {
|
|
25294
|
+
"attributes": {},
|
|
25295
|
+
"description": "A plugin is an AWS resource that contains the code that defines a connector's logic.",
|
|
25296
|
+
"properties": {
|
|
25297
|
+
"CustomPluginArn": "The Amazon Resource Name (ARN) of the custom plugin.",
|
|
25298
|
+
"Revision": "The revision of the custom plugin."
|
|
25299
|
+
}
|
|
25300
|
+
},
|
|
25301
|
+
"AWS::KafkaConnect::Connector.FirehoseLogDelivery": {
|
|
25302
|
+
"attributes": {},
|
|
25303
|
+
"description": "The settings for delivering logs to Amazon Kinesis Data Firehose.",
|
|
25304
|
+
"properties": {
|
|
25305
|
+
"DeliveryStream": "The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.",
|
|
25306
|
+
"Enabled": "Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose."
|
|
25307
|
+
}
|
|
25308
|
+
},
|
|
25309
|
+
"AWS::KafkaConnect::Connector.KafkaCluster": {
|
|
25310
|
+
"attributes": {},
|
|
25311
|
+
"description": "The details of the Apache Kafka cluster to which the connector is connected.",
|
|
25312
|
+
"properties": {
|
|
25313
|
+
"ApacheKafkaCluster": "The Apache Kafka cluster to which the connector is connected."
|
|
25314
|
+
}
|
|
25315
|
+
},
|
|
25316
|
+
"AWS::KafkaConnect::Connector.KafkaClusterClientAuthentication": {
|
|
25317
|
+
"attributes": {},
|
|
25318
|
+
"description": "The client authentication information used in order to authenticate with the Apache Kafka cluster.",
|
|
25319
|
+
"properties": {
|
|
25320
|
+
"AuthenticationType": "The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used."
|
|
25321
|
+
}
|
|
25322
|
+
},
|
|
25323
|
+
"AWS::KafkaConnect::Connector.KafkaClusterEncryptionInTransit": {
|
|
25324
|
+
"attributes": {},
|
|
25325
|
+
"description": "Details of encryption in transit to the Apache Kafka cluster.",
|
|
25326
|
+
"properties": {
|
|
25327
|
+
"EncryptionType": "The type of encryption in transit to the Apache Kafka cluster."
|
|
25328
|
+
}
|
|
25329
|
+
},
|
|
25330
|
+
"AWS::KafkaConnect::Connector.LogDelivery": {
|
|
25331
|
+
"attributes": {},
|
|
25332
|
+
"description": "Details about log delivery.",
|
|
25333
|
+
"properties": {
|
|
25334
|
+
"WorkerLogDelivery": "The workers can send worker logs to different destination types. This configuration specifies the details of these destinations."
|
|
25335
|
+
}
|
|
25336
|
+
},
|
|
25337
|
+
"AWS::KafkaConnect::Connector.Plugin": {
|
|
25338
|
+
"attributes": {},
|
|
25339
|
+
"description": "A plugin is an AWS resource that contains the code that defines your connector logic.",
|
|
25340
|
+
"properties": {
|
|
25341
|
+
"CustomPlugin": "Details about a custom plugin."
|
|
25342
|
+
}
|
|
25343
|
+
},
|
|
25344
|
+
"AWS::KafkaConnect::Connector.ProvisionedCapacity": {
|
|
25345
|
+
"attributes": {},
|
|
25346
|
+
"description": "Details about a connector's provisioned capacity.",
|
|
25347
|
+
"properties": {
|
|
25348
|
+
"McuCount": "The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.",
|
|
25349
|
+
"WorkerCount": "The number of workers that are allocated to the connector."
|
|
25350
|
+
}
|
|
25351
|
+
},
|
|
25352
|
+
"AWS::KafkaConnect::Connector.S3LogDelivery": {
|
|
25353
|
+
"attributes": {},
|
|
25354
|
+
"description": "Details about delivering logs to Amazon S3.",
|
|
25355
|
+
"properties": {
|
|
25356
|
+
"Bucket": "The name of the S3 bucket that is the destination for log delivery.",
|
|
25357
|
+
"Enabled": "Specifies whether connector logs get sent to the specified Amazon S3 destination.",
|
|
25358
|
+
"Prefix": "The S3 prefix that is the destination for log delivery."
|
|
25359
|
+
}
|
|
25360
|
+
},
|
|
25361
|
+
"AWS::KafkaConnect::Connector.ScaleInPolicy": {
|
|
25362
|
+
"attributes": {},
|
|
25363
|
+
"description": "The scale-in policy for the connector.",
|
|
25364
|
+
"properties": {
|
|
25365
|
+
"CpuUtilizationPercentage": "Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered."
|
|
25366
|
+
}
|
|
25367
|
+
},
|
|
25368
|
+
"AWS::KafkaConnect::Connector.ScaleOutPolicy": {
|
|
25369
|
+
"attributes": {},
|
|
25370
|
+
"description": "The scale-out policy for the connector.",
|
|
25371
|
+
"properties": {
|
|
25372
|
+
"CpuUtilizationPercentage": "The CPU utilization percentage threshold at which you want connector scale out to be triggered."
|
|
25373
|
+
}
|
|
25374
|
+
},
|
|
25375
|
+
"AWS::KafkaConnect::Connector.Vpc": {
|
|
25376
|
+
"attributes": {},
|
|
25377
|
+
"description": "Information about the VPC in which the connector resides.",
|
|
25378
|
+
"properties": {
|
|
25379
|
+
"SecurityGroups": "The security groups for the connector.",
|
|
25380
|
+
"Subnets": "The subnets for the connector."
|
|
25381
|
+
}
|
|
25382
|
+
},
|
|
25383
|
+
"AWS::KafkaConnect::Connector.WorkerConfiguration": {
|
|
25384
|
+
"attributes": {},
|
|
25385
|
+
"description": "The configuration of the workers, which are the processes that run the connector logic.",
|
|
25386
|
+
"properties": {
|
|
25387
|
+
"Revision": "The revision of the worker configuration.",
|
|
25388
|
+
"WorkerConfigurationArn": "The Amazon Resource Name (ARN) of the worker configuration."
|
|
25389
|
+
}
|
|
25390
|
+
},
|
|
25391
|
+
"AWS::KafkaConnect::Connector.WorkerLogDelivery": {
|
|
25392
|
+
"attributes": {},
|
|
25393
|
+
"description": "Workers can send worker logs to different destination types. This configuration specifies the details of these destinations.",
|
|
25394
|
+
"properties": {
|
|
25395
|
+
"CloudWatchLogs": "Details about delivering logs to Amazon CloudWatch Logs.",
|
|
25396
|
+
"Firehose": "Details about delivering logs to Amazon Kinesis Data Firehose.",
|
|
25397
|
+
"S3": "Details about delivering logs to Amazon S3."
|
|
25398
|
+
}
|
|
25399
|
+
},
|
|
23841
25400
|
"AWS::Kendra::DataSource": {
|
|
23842
25401
|
"attributes": {
|
|
23843
25402
|
"Arn": "The Amazon Resource Name (ARN) of the data source. For example:\n\n`arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/data-source/b8cae438-6787-4091-8897-684a652bbb0a`",
|
|
@@ -25578,6 +27137,34 @@
|
|
|
25578
27137
|
"SubnetIds": "The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.\n\nThe number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here."
|
|
25579
27138
|
}
|
|
25580
27139
|
},
|
|
27140
|
+
"AWS::KinesisVideo::SignalingChannel": {
|
|
27141
|
+
"attributes": {
|
|
27142
|
+
"Arn": "The Amazon Resource Name (ARN) of the signaling channel.",
|
|
27143
|
+
"Ref": ""
|
|
27144
|
+
},
|
|
27145
|
+
"description": "Specifies a signaling channel.\n\n`CreateSignalingChannel` is an asynchronous operation.",
|
|
27146
|
+
"properties": {
|
|
27147
|
+
"MessageTtlSeconds": "The period of time a signaling channel retains undelivered messages before they are discarded.",
|
|
27148
|
+
"Name": "A name for the signaling channel that you are creating. It must be unique for each AWS account and AWS Region .",
|
|
27149
|
+
"Tags": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .",
|
|
27150
|
+
"Type": "A type of the signaling channel that you are creating. Currently, `SINGLE_MASTER` is the only supported channel type."
|
|
27151
|
+
}
|
|
27152
|
+
},
|
|
27153
|
+
"AWS::KinesisVideo::Stream": {
|
|
27154
|
+
"attributes": {
|
|
27155
|
+
"Arn": "The Amazon Resource Name (ARN) of the stream.",
|
|
27156
|
+
"Ref": ""
|
|
27157
|
+
},
|
|
27158
|
+
"description": "Specifies a new Kinesis video stream.\n\nWhen you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version.\n\n`CreateStream` is an asynchronous operation.\n\nFor information about how the service works, see [How it Works](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/how-it-works.html) .\n\nYou must have permissions for the `KinesisVideo:CreateStream` action.",
|
|
27159
|
+
"properties": {
|
|
27160
|
+
"DataRetentionInHours": "How long the stream retains data, in hours.",
|
|
27161
|
+
"DeviceName": "The name of the device that is associated with the stream.",
|
|
27162
|
+
"KmsKeyId": "The ID of the AWS Key Management Service ( AWS KMS ) key that Kinesis Video Streams uses to encrypt data on the stream.",
|
|
27163
|
+
"MediaType": "The `MediaType` of the stream.",
|
|
27164
|
+
"Name": "The name of the stream.",
|
|
27165
|
+
"Tags": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) ."
|
|
27166
|
+
}
|
|
27167
|
+
},
|
|
25581
27168
|
"AWS::LakeFormation::DataLakeSettings": {
|
|
25582
27169
|
"attributes": {},
|
|
25583
27170
|
"description": "The `AWS::LakeFormation::DataLakeSettings` resource is an AWS Lake Formation resource type that manages the data lake settings for your account. Note that the CloudFormation template only supports updating the `Admins` list. It does not support updating the [CreateDatabaseDefaultPermissions](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-settings.html#aws-lake-formation-api-aws-lake-formation-api-settings-DataLakeSettings) or [CreateTableDefaultPermissions](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-settings.html#aws-lake-formation-api-aws-lake-formation-api-settings-DataLakeSettings) . Those permissions can only be edited in the DataLakeSettings resource via the API.",
|
|
@@ -27669,6 +29256,16 @@
|
|
|
27669
29256
|
"SubnetIdList": "An array of strings containing the Amazon VPC subnet IDs (e.g., `subnet-0bb1c79de3EXAMPLE` ."
|
|
27670
29257
|
}
|
|
27671
29258
|
},
|
|
29259
|
+
"AWS::LookoutVision::Project": {
|
|
29260
|
+
"attributes": {
|
|
29261
|
+
"Arn": "Returns the Amazon Resource Name of the project.",
|
|
29262
|
+
"Ref": "`Ref` returns the resource name. For example:\n\n`{ \"Ref\": \"CircuitBoardProject\" }`\n\nFor the Amazon Lookout for Vision `CircuitBoardProject` , Ref returns the name of the project."
|
|
29263
|
+
},
|
|
29264
|
+
"description": "The `AWS::LookoutVision::Project` type creates an Amazon Lookout for Vision project. A project is a grouping of the resources needed to create and manage an Amazon Lookout for Vision model.",
|
|
29265
|
+
"properties": {
|
|
29266
|
+
"ProjectName": "The name of the project."
|
|
29267
|
+
}
|
|
29268
|
+
},
|
|
27672
29269
|
"AWS::MSK::BatchScramSecret": {
|
|
27673
29270
|
"attributes": {
|
|
27674
29271
|
"Ref": "The ARN of the cluster."
|
|
@@ -27714,7 +29311,7 @@
|
|
|
27714
29311
|
"description": "The setup to be used for brokers in the cluster.",
|
|
27715
29312
|
"properties": {
|
|
27716
29313
|
"BrokerAZDistribution": "This parameter is currently not in use.",
|
|
27717
|
-
"ClientSubnets": "The list of subnets to connect to in the client virtual private cloud (VPC). Amazon creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data.\n\nSpecify exactly two subnets if you are using the US West (N. California) Region. For other Regions where Amazon MSK is available, you can specify either two or three subnets. The subnets that you specify must be in distinct Availability Zones. When you create a cluster, Amazon MSK distributes the broker nodes evenly across the subnets that you specify.\n\nClient subnets can't
|
|
29314
|
+
"ClientSubnets": "The list of subnets to connect to in the client virtual private cloud (VPC). Amazon creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data.\n\nSpecify exactly two subnets if you are using the US West (N. California) Region. For other Regions where Amazon MSK is available, you can specify either two or three subnets. The subnets that you specify must be in distinct Availability Zones. When you create a cluster, Amazon MSK distributes the broker nodes evenly across the subnets that you specify.\n\nClient subnets can't occupy the Availability Zone with ID `use1-az3` .",
|
|
27718
29315
|
"ConnectivityInfo": "Information about the cluster's connectivity setting.",
|
|
27719
29316
|
"InstanceType": "The type of Amazon EC2 instances to use for brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.8xlarge, kafka.m5.12xlarge, kafka.m5.16xlarge, and kafka.m5.24xlarge.",
|
|
27720
29317
|
"SecurityGroups": "The security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC. If you specify security groups that were shared with you, you must ensure that you have permissions to them. Specifically, you need the `ec2:DescribeSecurityGroups` permission.",
|
|
@@ -30453,6 +32050,97 @@
|
|
|
30453
32050
|
"ObjectGroupName": "A name that allows you to refer to the object group."
|
|
30454
32051
|
}
|
|
30455
32052
|
},
|
|
32053
|
+
"AWS::MediaTailor::PlaybackConfiguration": {
|
|
32054
|
+
"attributes": {},
|
|
32055
|
+
"description": "Adds a new playback configuration to AWS Elemental MediaTailor.",
|
|
32056
|
+
"properties": {
|
|
32057
|
+
"AdDecisionServerUrl": "The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.",
|
|
32058
|
+
"AvailSuppression": "The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see [Ad Suppression](https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html) .",
|
|
32059
|
+
"Bumper": "The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see [Bumpers](https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html) .",
|
|
32060
|
+
"CdnConfiguration": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.",
|
|
32061
|
+
"ConfigurationAliases": "The player parameters and aliases used as dynamic variables during session initialization. For more information, see [Domain Variables](https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html) .",
|
|
32062
|
+
"DashConfiguration": "The configuration for DASH content.",
|
|
32063
|
+
"LivePreRollConfiguration": "The configuration for pre-roll ad insertion.",
|
|
32064
|
+
"ManifestProcessingRules": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.",
|
|
32065
|
+
"Name": "The identifier for the playback configuration.",
|
|
32066
|
+
"PersonalizationThresholdSeconds": "Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to *ad replacement* in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see [Ad Behavior in MediaTailor](https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html) .",
|
|
32067
|
+
"SessionInitializationEndpointPrefix": "",
|
|
32068
|
+
"SlateAdUrl": "The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.",
|
|
32069
|
+
"Tags": "The tags to assign to the playback configuration.",
|
|
32070
|
+
"TranscodeProfileName": "The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.",
|
|
32071
|
+
"VideoContentSourceUrl": "The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters."
|
|
32072
|
+
}
|
|
32073
|
+
},
|
|
32074
|
+
"AWS::MediaTailor::PlaybackConfiguration.AdMarkerPassthrough": {
|
|
32075
|
+
"attributes": {},
|
|
32076
|
+
"description": "For HLS, when set to `true` , MediaTailor passes through `EXT-X-CUE-IN` , `EXT-X-CUE-OUT` , and `EXT-X-SPLICEPOINT-SCTE35` ad markers from the origin manifest to the MediaTailor personalized manifest.\n\nNo logic is applied to these ad markers. For example, if `EXT-X-CUE-OUT` has a value of `60` , but no ads are filled for that ad break, MediaTailor will not set the value to `0` .",
|
|
32077
|
+
"properties": {
|
|
32078
|
+
"Enabled": "Enables ad marker passthrough for your configuration."
|
|
32079
|
+
}
|
|
32080
|
+
},
|
|
32081
|
+
"AWS::MediaTailor::PlaybackConfiguration.AvailSuppression": {
|
|
32082
|
+
"attributes": {},
|
|
32083
|
+
"description": "The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see [Ad Suppression](https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html) .",
|
|
32084
|
+
"properties": {
|
|
32085
|
+
"Mode": "Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.",
|
|
32086
|
+
"Value": "A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge."
|
|
32087
|
+
}
|
|
32088
|
+
},
|
|
32089
|
+
"AWS::MediaTailor::PlaybackConfiguration.Bumper": {
|
|
32090
|
+
"attributes": {},
|
|
32091
|
+
"description": "The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see [Bumpers](https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html) .",
|
|
32092
|
+
"properties": {
|
|
32093
|
+
"EndUrl": "The URL for the end bumper asset.",
|
|
32094
|
+
"StartUrl": "The URL for the start bumper asset."
|
|
32095
|
+
}
|
|
32096
|
+
},
|
|
32097
|
+
"AWS::MediaTailor::PlaybackConfiguration.CdnConfiguration": {
|
|
32098
|
+
"attributes": {},
|
|
32099
|
+
"description": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.",
|
|
32100
|
+
"properties": {
|
|
32101
|
+
"AdSegmentUrlPrefix": "A non-default content delivery network (CDN) to serve ad segments. By default, MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When MediaTailor serves a manifest, it reports your CDN as the source for ad segments.",
|
|
32102
|
+
"ContentSegmentUrlPrefix": "A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When MediaTailor serves a manifest, it reports your CDN as the source for content segments."
|
|
32103
|
+
}
|
|
32104
|
+
},
|
|
32105
|
+
"AWS::MediaTailor::PlaybackConfiguration.DashConfiguration": {
|
|
32106
|
+
"attributes": {},
|
|
32107
|
+
"description": "The configuration for DASH content.",
|
|
32108
|
+
"properties": {
|
|
32109
|
+
"ManifestEndpointPrefix": "The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.",
|
|
32110
|
+
"MpdLocation": "The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.",
|
|
32111
|
+
"OriginManifestType": "The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD."
|
|
32112
|
+
}
|
|
32113
|
+
},
|
|
32114
|
+
"AWS::MediaTailor::PlaybackConfiguration.DashConfigurationForPut": {
|
|
32115
|
+
"attributes": {},
|
|
32116
|
+
"description": "The configuration for DASH PUT operations.",
|
|
32117
|
+
"properties": {
|
|
32118
|
+
"MpdLocation": "The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.",
|
|
32119
|
+
"OriginManifestType": "The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD."
|
|
32120
|
+
}
|
|
32121
|
+
},
|
|
32122
|
+
"AWS::MediaTailor::PlaybackConfiguration.HlsConfiguration": {
|
|
32123
|
+
"attributes": {},
|
|
32124
|
+
"description": "The configuration for HLS content.",
|
|
32125
|
+
"properties": {
|
|
32126
|
+
"ManifestEndpointPrefix": "The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting."
|
|
32127
|
+
}
|
|
32128
|
+
},
|
|
32129
|
+
"AWS::MediaTailor::PlaybackConfiguration.LivePreRollConfiguration": {
|
|
32130
|
+
"attributes": {},
|
|
32131
|
+
"description": "The configuration for pre-roll ad insertion.",
|
|
32132
|
+
"properties": {
|
|
32133
|
+
"AdDecisionServerUrl": "The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.",
|
|
32134
|
+
"MaxDurationSeconds": "The maximum allowed duration for the pre-roll ad avail. MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns."
|
|
32135
|
+
}
|
|
32136
|
+
},
|
|
32137
|
+
"AWS::MediaTailor::PlaybackConfiguration.ManifestProcessingRules": {
|
|
32138
|
+
"attributes": {},
|
|
32139
|
+
"description": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.",
|
|
32140
|
+
"properties": {
|
|
32141
|
+
"AdMarkerPassthrough": "For HLS, when set to `true` , MediaTailor passes through `EXT-X-CUE-IN` , `EXT-X-CUE-OUT` , and `EXT-X-SPLICEPOINT-SCTE35` ad markers from the origin manifest to the MediaTailor personalized manifest.\n\nNo logic is applied to these ad markers. For example, if `EXT-X-CUE-OUT` has a value of `60` , but no ads are filled for that ad break, MediaTailor will not set the value to `0` ."
|
|
32142
|
+
}
|
|
32143
|
+
},
|
|
30456
32144
|
"AWS::MemoryDB::ACL": {
|
|
30457
32145
|
"attributes": {
|
|
30458
32146
|
"Arn": "When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the Access Control List, such as `arn:aws:memorydb:us-east-1:123456789012:acl/my-acl`",
|
|
@@ -30970,6 +32658,99 @@
|
|
|
30970
32658
|
"Masks": "The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting."
|
|
30971
32659
|
}
|
|
30972
32660
|
},
|
|
32661
|
+
"AWS::NetworkManager::ConnectAttachment": {
|
|
32662
|
+
"attributes": {
|
|
32663
|
+
"AttachmentId": "The ID of the Connect attachment.",
|
|
32664
|
+
"AttachmentPolicyRuleNumber": "The rule number associated with the attachment.",
|
|
32665
|
+
"AttachmentType": "The type of attachment. This will be `CONNECT` .",
|
|
32666
|
+
"CoreNetworkArn": "The ARN of the core network.",
|
|
32667
|
+
"CreatedAt": "The timestamp when the Connect attachment was created.",
|
|
32668
|
+
"OwnerAccountId": "The ID of the Connect attachment owner.",
|
|
32669
|
+
"Ref": "`Ref` returns the `AttachmentId` . For example, `{ \"Ref: \"attachment-02767e74104a33690\" }` .",
|
|
32670
|
+
"ResourceArn": "The resource ARN for the Connect attachment.",
|
|
32671
|
+
"SegmentName": "The name of the Connect attachment's segment.",
|
|
32672
|
+
"State": "The state of the Connect attachment. This can be: `REJECTED` | `PENDING_ATTACHMENT_ACCEPTANCE` | `CREATING` | `FAILED` | `AVAILABLE` | `UPDATING` | `PENDING_NETWORK_UPDATE` | `PENDING_TAG_ACCEPTANCE` | `DELETING` .",
|
|
32673
|
+
"UpdatedAt": "The timestamp when the Connect attachment was last updated."
|
|
32674
|
+
},
|
|
32675
|
+
"description": "Creates a core network Connect attachment from a specified core network attachment.\n\nA core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism.",
|
|
32676
|
+
"properties": {
|
|
32677
|
+
"CoreNetworkId": "The core network ID.",
|
|
32678
|
+
"EdgeLocation": "The Region where the edge is located.",
|
|
32679
|
+
"Options": "Options for creating a Connect attachment.",
|
|
32680
|
+
"Tags": "The tags associated with the Connect attachment.",
|
|
32681
|
+
"TransportAttachmentId": "The ID of the attachment between the two connections."
|
|
32682
|
+
}
|
|
32683
|
+
},
|
|
32684
|
+
"AWS::NetworkManager::ConnectAttachment.ConnectAttachmentOptions": {
|
|
32685
|
+
"attributes": {},
|
|
32686
|
+
"description": "Describes a core network Connect attachment options.",
|
|
32687
|
+
"properties": {
|
|
32688
|
+
"Protocol": "The protocol used for the attachment connection."
|
|
32689
|
+
}
|
|
32690
|
+
},
|
|
32691
|
+
"AWS::NetworkManager::ConnectPeer": {
|
|
32692
|
+
"attributes": {
|
|
32693
|
+
"ConnectPeerId": "The ID of the Connect peer.",
|
|
32694
|
+
"CoreNetworkId": "The core network ID.",
|
|
32695
|
+
"CreatedAt": "The timestamp when the Connect peer was created.",
|
|
32696
|
+
"EdgeLocation": "The Region where the edge is located.",
|
|
32697
|
+
"Ref": "`Ref` returns the `ConnectPeerId` . For example, `{ \"Ref: \"connect-peer--041e25dbc928d7e61\" }` .",
|
|
32698
|
+
"State": "The state of the Connect peer. This will be: `REJECTED` | `PENDING_ATTACHMENT_ACCEPTANCE` | `CREATING` | `FAILED` | `AVAILABLE` | `UPDATING` | `PENDING_NETWORK_UPDATE` | `PENDING_TAG_ACCEPTANCE` | `DELETING` ."
|
|
32699
|
+
},
|
|
32700
|
+
"description": "Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).",
|
|
32701
|
+
"properties": {
|
|
32702
|
+
"BgpOptions": "The BGP peer options.",
|
|
32703
|
+
"ConnectAttachmentId": "The ID of Connect peer.",
|
|
32704
|
+
"CoreNetworkAddress": "The IP address of a core network.",
|
|
32705
|
+
"InsideCidrBlocks": "The inside IP addresses used for a Connect peer configuration.",
|
|
32706
|
+
"PeerAddress": "The IP address of the Connect peer.",
|
|
32707
|
+
"Tags": "The tags associated with the Connect peer."
|
|
32708
|
+
}
|
|
32709
|
+
},
|
|
32710
|
+
"AWS::NetworkManager::ConnectPeer.BgpOptions": {
|
|
32711
|
+
"attributes": {},
|
|
32712
|
+
"description": "Describes the BGP options.",
|
|
32713
|
+
"properties": {
|
|
32714
|
+
"PeerAsn": "The Peer ASN of the BGP."
|
|
32715
|
+
}
|
|
32716
|
+
},
|
|
32717
|
+
"AWS::NetworkManager::CoreNetwork": {
|
|
32718
|
+
"attributes": {
|
|
32719
|
+
"CoreNetworkArn": "The ARN of the core network.",
|
|
32720
|
+
"CoreNetworkId": "The core network ID.",
|
|
32721
|
+
"CreatedAt": "The timestamp when the core network was created.",
|
|
32722
|
+
"Edges": "",
|
|
32723
|
+
"OwnerAccount": "",
|
|
32724
|
+
"Ref": "`Ref` returns the CoreNetworkId. For example, `{ \"Ref: \"core-network-060ea2740fe60fd38\" }` .",
|
|
32725
|
+
"Segments": "",
|
|
32726
|
+
"State": "The current state of the core network. These states are: `CREATING` | `UPDATING` | `AVAILABLE` | `DELETING` ."
|
|
32727
|
+
},
|
|
32728
|
+
"description": "Describes a core network within a global network.",
|
|
32729
|
+
"properties": {
|
|
32730
|
+
"Description": "The description of a core network.",
|
|
32731
|
+
"GlobalNetworkId": "The ID of the global network that your core network is a part of.",
|
|
32732
|
+
"PolicyDocument": "Describes a core network policy. If you update the policy document, CloudFormation will apply the core network change set generated from the updated policy document, and then set it as the LIVE policy.",
|
|
32733
|
+
"Tags": "The tags associated with a core network."
|
|
32734
|
+
}
|
|
32735
|
+
},
|
|
32736
|
+
"AWS::NetworkManager::CoreNetwork.CoreNetworkEdge": {
|
|
32737
|
+
"attributes": {},
|
|
32738
|
+
"description": "Describes a core network edge.",
|
|
32739
|
+
"properties": {
|
|
32740
|
+
"Asn": "The ASN of a core network edge.",
|
|
32741
|
+
"EdgeLocation": "The Region where a core network edge is located.",
|
|
32742
|
+
"InsideCidrBlocks": "The inside IP addresses used for core network edges."
|
|
32743
|
+
}
|
|
32744
|
+
},
|
|
32745
|
+
"AWS::NetworkManager::CoreNetwork.CoreNetworkSegment": {
|
|
32746
|
+
"attributes": {},
|
|
32747
|
+
"description": "Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.",
|
|
32748
|
+
"properties": {
|
|
32749
|
+
"EdgeLocations": "The Regions where the edges are located.",
|
|
32750
|
+
"Name": "The name of a core network segment.",
|
|
32751
|
+
"SharedSegments": "The shared segments of a core network."
|
|
32752
|
+
}
|
|
32753
|
+
},
|
|
30973
32754
|
"AWS::NetworkManager::CustomerGatewayAssociation": {
|
|
30974
32755
|
"attributes": {
|
|
30975
32756
|
"Ref": "`Ref` returns the ID of the global network and the Amazon Resource Name (ARN) of the customer gateway. For example: `global-network-01231231231231231|arn:aws:ec2:eu-central-1:123456789012:customer-gateway/cgw-00112233aabbcc112` ."
|
|
@@ -31081,6 +32862,28 @@
|
|
|
31081
32862
|
"Longitude": "The longitude."
|
|
31082
32863
|
}
|
|
31083
32864
|
},
|
|
32865
|
+
"AWS::NetworkManager::SiteToSiteVpnAttachment": {
|
|
32866
|
+
"attributes": {
|
|
32867
|
+
"AttachmentId": "The ID of the site-to-site VPN attachment.",
|
|
32868
|
+
"AttachmentPolicyRuleNumber": "The policy rule number associated with the attachment.",
|
|
32869
|
+
"AttachmentType": "The type of attachment. This will be `SITE_TO_SITE_VPN` .",
|
|
32870
|
+
"CoreNetworkArn": "The ARN of the core network.",
|
|
32871
|
+
"CreatedAt": "The timestamp when the site-to-site VPN attachment was created.",
|
|
32872
|
+
"EdgeLocation": "The Region where the core network edge is located.",
|
|
32873
|
+
"OwnerAccountId": "The ID of the site-to-site VPN attachment owner.",
|
|
32874
|
+
"Ref": "`Ref` returns the `AttachmentId` . For example, `{ \"Ref: \"attachment-05467e74104d33861\" }` .",
|
|
32875
|
+
"ResourceArn": "The resource ARN for the site-to-site VPN attachment.",
|
|
32876
|
+
"SegmentName": "The name of the site-to-site VPN attachment's segment.",
|
|
32877
|
+
"State": "The state of the site-to-site VPN attachment. This can be: `REJECTED` | `PENDING_ATTACHMENT_ACCEPTANCE` | `CREATING` | `FAILED` | `AVAILABLE` | `UPDATING` | `PENDING_NETWORK_UPDATE` | `PENDING_TAG_ACCEPTANCE` | `DELETING` .",
|
|
32878
|
+
"UpdatedAt": "The timestamp when the site-to-site VPN attachment was last updated."
|
|
32879
|
+
},
|
|
32880
|
+
"description": "Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.",
|
|
32881
|
+
"properties": {
|
|
32882
|
+
"CoreNetworkId": "The core network ID.",
|
|
32883
|
+
"Tags": "The tags associated with the site-to-site VPN attachment.",
|
|
32884
|
+
"VpnConnectionArn": "The ARN of the site-to-site VPN attachment."
|
|
32885
|
+
}
|
|
32886
|
+
},
|
|
31084
32887
|
"AWS::NetworkManager::TransitGatewayRegistration": {
|
|
31085
32888
|
"attributes": {
|
|
31086
32889
|
"Ref": "`Ref` returns the ID of the global network and the ARN of the transit gateway. For example: `global-network-01231231231231231|arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc` ."
|
|
@@ -31091,6 +32894,37 @@
|
|
|
31091
32894
|
"TransitGatewayArn": "The Amazon Resource Name (ARN) of the transit gateway."
|
|
31092
32895
|
}
|
|
31093
32896
|
},
|
|
32897
|
+
"AWS::NetworkManager::VpcAttachment": {
|
|
32898
|
+
"attributes": {
|
|
32899
|
+
"AttachmentId": "The ID of the VPC attachment.",
|
|
32900
|
+
"AttachmentPolicyRuleNumber": "The policy rule number associated with the attachment.",
|
|
32901
|
+
"AttachmentType": "The type of attachment. This will be `VPC` .",
|
|
32902
|
+
"CoreNetworkArn": "The ARN of the core network.",
|
|
32903
|
+
"CreatedAt": "The timestamp when the VPC attachment was created.",
|
|
32904
|
+
"EdgeLocation": "The Region where the core network edge is located.",
|
|
32905
|
+
"OwnerAccountId": "The ID of the VPC attachment owner.",
|
|
32906
|
+
"Ref": "`Ref` returns the `AttachmentId` . For example, `{ \"Ref: \"attachment-00067e74104d33769\" }` .",
|
|
32907
|
+
"ResourceArn": "The resource ARN for the VPC attachment.",
|
|
32908
|
+
"SegmentName": "The name of the attachment's segment.",
|
|
32909
|
+
"State": "The state of the attachment. This can be: `REJECTED` | `PENDING_ATTACHMENT_ACCEPTANCE` | `CREATING` | `FAILED` | `AVAILABLE` | `UPDATING` | `PENDING_NETWORK_UPDATE` | `PENDING_TAG_ACCEPTANCE` | `DELETING` .",
|
|
32910
|
+
"UpdatedAt": "The timestamp when the VPC attachment was last updated."
|
|
32911
|
+
},
|
|
32912
|
+
"description": "Creates a VPC attachment on an edge location of a core network.",
|
|
32913
|
+
"properties": {
|
|
32914
|
+
"CoreNetworkId": "The core network ID.",
|
|
32915
|
+
"Options": "Options for creating the VPC attachment.",
|
|
32916
|
+
"SubnetArns": "The subnet ARNs.",
|
|
32917
|
+
"Tags": "The tags associated with the VPC attachment.",
|
|
32918
|
+
"VpcArn": "The ARN of the VPC attachment."
|
|
32919
|
+
}
|
|
32920
|
+
},
|
|
32921
|
+
"AWS::NetworkManager::VpcAttachment.VpcOptions": {
|
|
32922
|
+
"attributes": {},
|
|
32923
|
+
"description": "Describes the VPC options.",
|
|
32924
|
+
"properties": {
|
|
32925
|
+
"Ipv6Support": "Indicates whether IPv6 is supported."
|
|
32926
|
+
}
|
|
32927
|
+
},
|
|
31094
32928
|
"AWS::NimbleStudio::LaunchProfile": {
|
|
31095
32929
|
"attributes": {
|
|
31096
32930
|
"LaunchProfileId": "The unique identifier for the launch profile resource."
|
|
@@ -31840,6 +33674,83 @@
|
|
|
31840
33674
|
"UpdatedLatestPatchVersion": "If the version was marked latest, the new version to maker as latest."
|
|
31841
33675
|
}
|
|
31842
33676
|
},
|
|
33677
|
+
"AWS::Personalize::Dataset": {
|
|
33678
|
+
"attributes": {
|
|
33679
|
+
"DatasetArn": "The Amazon Resource Name (ARN) of the dataset.",
|
|
33680
|
+
"Ref": "`Ref` returns the name of the resource."
|
|
33681
|
+
},
|
|
33682
|
+
"description": "Creates an empty dataset and adds it to the specified dataset group. Use [CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html) to import your training data to a dataset.\n\nThere are three types of datasets:\n\n- Interactions\n- Items\n- Users\n\nEach dataset type has an associated schema with required field types. Only the `Interactions` dataset is required in order to train a model (also referred to as creating a solution).\n\nA dataset can be in one of the following states:\n\n- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED\n- DELETE PENDING > DELETE IN_PROGRESS\n\nTo get the status of the dataset, call [DescribeDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html) .\n\n**Related APIs** - [CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html)\n- [ListDatasets](https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasets.html)\n- [DescribeDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html)\n- [DeleteDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDataset.html)",
|
|
33683
|
+
"properties": {
|
|
33684
|
+
"DatasetGroupArn": "The Amazon Resource Name (ARN) of the dataset group.",
|
|
33685
|
+
"DatasetImportJob": "Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset.",
|
|
33686
|
+
"DatasetType": "One of the following values:\n\n- Interactions\n- Items\n- Users",
|
|
33687
|
+
"Name": "The name of the dataset.",
|
|
33688
|
+
"SchemaArn": "The ARN of the associated schema."
|
|
33689
|
+
}
|
|
33690
|
+
},
|
|
33691
|
+
"AWS::Personalize::Dataset.DatasetImportJob": {
|
|
33692
|
+
"attributes": {},
|
|
33693
|
+
"description": "Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. For more information, see [CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html) .\n\nA dataset import job can be in one of the following states:\n\n- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED",
|
|
33694
|
+
"properties": {
|
|
33695
|
+
"DataSource": "The Amazon S3 bucket that contains the training data to import.",
|
|
33696
|
+
"DatasetArn": "The Amazon Resource Name (ARN) of the dataset that receives the imported data.",
|
|
33697
|
+
"DatasetImportJobArn": "The ARN of the dataset import job.",
|
|
33698
|
+
"JobName": "The name of the import job.",
|
|
33699
|
+
"RoleArn": "The ARN of the IAM role that has permissions to read from the Amazon S3 data source."
|
|
33700
|
+
}
|
|
33701
|
+
},
|
|
33702
|
+
"AWS::Personalize::DatasetGroup": {
|
|
33703
|
+
"attributes": {
|
|
33704
|
+
"DatasetGroupArn": "The Amazon Resource Name (ARN) of the dataset group.",
|
|
33705
|
+
"Ref": "`Ref` returns the name of the resource."
|
|
33706
|
+
},
|
|
33707
|
+
"description": "A dataset group is a collection of related datasets (Interactions, User, and Item). You create a dataset group by calling [CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html) . You then create a dataset and add it to a dataset group by calling [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) . The dataset group is used to create and train a solution by calling [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) . A dataset group can contain only one of each type of dataset.\n\nYou can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group.",
|
|
33708
|
+
"properties": {
|
|
33709
|
+
"Domain": "The domain of a Domain dataset group.",
|
|
33710
|
+
"KmsKeyArn": "The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the datasets.",
|
|
33711
|
+
"Name": "The name of the dataset group.",
|
|
33712
|
+
"RoleArn": "The ARN of the IAM role that has permissions to create the dataset group."
|
|
33713
|
+
}
|
|
33714
|
+
},
|
|
33715
|
+
"AWS::Personalize::Schema": {
|
|
33716
|
+
"attributes": {
|
|
33717
|
+
"Ref": "`Ref` returns the name of the resource.",
|
|
33718
|
+
"SchemaArn": "The Amazon Resource Name (ARN) of the schema."
|
|
33719
|
+
},
|
|
33720
|
+
"description": "Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.\n\nAmazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) .\n\nFor more information on schemas, see [Datasets and schemas](https://docs.aws.amazon.com/personalize/latest/dg/how-it-works-dataset-schema.html) .\n\n**Related APIs** - [ListSchemas](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSchemas.html)\n- [DescribeSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html)\n- [DeleteSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSchema.html)",
|
|
33721
|
+
"properties": {
|
|
33722
|
+
"Domain": "The domain of a schema that you created for a dataset in a Domain dataset group.",
|
|
33723
|
+
"Name": "The name of the schema.",
|
|
33724
|
+
"Schema": "The schema."
|
|
33725
|
+
}
|
|
33726
|
+
},
|
|
33727
|
+
"AWS::Personalize::Solution": {
|
|
33728
|
+
"attributes": {
|
|
33729
|
+
"Ref": "`Ref` returns the name of the resource.",
|
|
33730
|
+
"SolutionArn": "The Amazon Resource Name (ARN) of the solution."
|
|
33731
|
+
},
|
|
33732
|
+
"description": "An object that provides information about a solution. A solution is a trained model that can be deployed as a campaign.",
|
|
33733
|
+
"properties": {
|
|
33734
|
+
"DatasetGroupArn": "The Amazon Resource Name (ARN) of the dataset group that provides the training data.",
|
|
33735
|
+
"EventType": "The event type (for example, 'click' or 'like') that is used for training the model. If no `eventType` is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.",
|
|
33736
|
+
"Name": "The name of the solution.",
|
|
33737
|
+
"PerformAutoML": "When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration ( `recipeArn` must not be specified). When false (the default), Amazon Personalize uses `recipeArn` for training.",
|
|
33738
|
+
"PerformHPO": "Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is `false` .",
|
|
33739
|
+
"RecipeArn": "The ARN of the recipe used to create the solution.",
|
|
33740
|
+
"SolutionConfig": "Describes the configuration properties for the solution."
|
|
33741
|
+
}
|
|
33742
|
+
},
|
|
33743
|
+
"AWS::Personalize::Solution.SolutionConfig": {
|
|
33744
|
+
"attributes": {},
|
|
33745
|
+
"description": "Describes the configuration properties for the solution.",
|
|
33746
|
+
"properties": {
|
|
33747
|
+
"AlgorithmHyperParameters": "Lists the hyperparameter names and ranges.",
|
|
33748
|
+
"AutoMLConfig": "The [AutoMLConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html) object containing a list of recipes to search when AutoML is performed.",
|
|
33749
|
+
"EventValueThreshold": "Only events with a value greater than or equal to this threshold are used for training a model.",
|
|
33750
|
+
"FeatureTransformationParameters": "Lists the feature transformation parameters.",
|
|
33751
|
+
"HpoConfig": "Describes the properties for hyperparameter optimization (HPO)."
|
|
33752
|
+
}
|
|
33753
|
+
},
|
|
31843
33754
|
"AWS::Pinpoint::ADMChannel": {
|
|
31844
33755
|
"attributes": {
|
|
31845
33756
|
"Ref": "`Ref` returns the unique identifier ( `ApplicationId` ) for the Amazon Pinpoint application that the channel is associated with."
|
|
@@ -34485,7 +36396,7 @@
|
|
|
34485
36396
|
"KmsKeyId": "The identifier for your Amazon Key Management Service key (Amazon KMS key). Optional parameter for connected home stream processors used to encrypt results and data published to your Amazon S3 bucket. For more information, see the KMSKeyId section of [CreateStreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor) .",
|
|
34486
36397
|
"Name": "The Name attribute specifies the name of the stream processor and it must be within the constraints described in the Name section of [StreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessor) . If you don't specify a name, Amazon CloudFormation generates a unique ID and uses that ID for the stream processor name.",
|
|
34487
36398
|
"NotificationChannel": "The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation. Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. Amazon Rekognition also publishes an end-of-session notification with a summary when the stream processing session is complete. For more information, see [StreamProcessorNotificationChannel](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorNotificationChannel) .",
|
|
34488
|
-
"PolygonRegionsOfInterest": "A set of ordered lists of [Point](https://docs.aws.amazon.com/
|
|
36399
|
+
"PolygonRegionsOfInterest": "A set of ordered lists of [Point](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_Point) objects. Each entry of the set contains a polygon denoting a region of interest on the screen. Each polygon is an ordered list of [Point](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_Point) objects. For more information, see the Polygon field of [RegionOfInterest](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RegionOfInterest) .",
|
|
34489
36400
|
"RoleArn": "The ARN of the IAM role that allows access to the stream processor. The IAM role provides Rekognition read permissions to the Kinesis stream. It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a connected home stream processor. This is required for both face search and connected home stream processors. For information about constraints, see the RoleArn section of [CreateStreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor) .",
|
|
34490
36401
|
"S3Destination": "The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation. For more information, see the S3Destination section of [StreamProcessorOutput](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorOutput) .",
|
|
34491
36402
|
"Tags": "A set of tags (key-value pairs) that you want to attach to the stream processor. For more information, see the Tags section of [CreateStreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor) ."
|
|
@@ -36535,6 +38446,7 @@
|
|
|
36535
38446
|
"ReceiveMessageWaitTimeSeconds": "Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Amazon SQS Developer Guide* .",
|
|
36536
38447
|
"RedriveAllowPolicy": "The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:\n\n- `redrivePermission` : The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:\n\n- `allowAll` : (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.\n- `denyAll` : No source queues can specify this queue as the dead-letter queue.\n- `byQueue` : Only queues specified by the `sourceQueueArns` parameter can specify this queue as the dead-letter queue.\n- `sourceQueueArns` : The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the `redrivePermission` parameter is set to `byQueue` . You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the `redrivePermission` parameter to `allowAll` .",
|
|
36537
38448
|
"RedrivePolicy": "The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:\n\n- `deadLetterTargetArn` : The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of `maxReceiveCount` is exceeded.\n- `maxReceiveCount` : The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the `ReceiveCount` for a message exceeds the `maxReceiveCount` for a queue, Amazon SQS moves the message to the dead-letter-queue.\n\n> The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. \n\n*JSON*\n\n`{ \"deadLetterTargetArn\" : *String* , \"maxReceiveCount\" : *Integer* }`\n\n*YAML*\n\n`deadLetterTargetArn : *String*`\n\n`maxReceiveCount : *Integer*`",
|
|
38449
|
+
"SqsManagedSseEnabled": "",
|
|
36538
38450
|
"Tags": "The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .",
|
|
36539
38451
|
"VisibilityTimeout": "The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue.\n\nValues must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.\n\nFor more information about Amazon SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Amazon SQS Developer Guide* ."
|
|
36540
38452
|
}
|
|
@@ -36566,6 +38478,7 @@
|
|
|
36566
38478
|
"OutputLocation": "An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.",
|
|
36567
38479
|
"Parameters": "The parameters for the runtime configuration of the document.",
|
|
36568
38480
|
"ScheduleExpression": "A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).",
|
|
38481
|
+
"ScheduleOffset": "Number of days to wait after the scheduled day to run an association.",
|
|
36569
38482
|
"SyncCompliance": "The mode for generating association compliance. You can specify `AUTO` or `MANUAL` . In `AUTO` mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is `COMPLIANT` . If the association execution doesn't run successfully, the association is `NON-COMPLIANT` .\n\nIn `MANUAL` mode, you must specify the `AssociationId` as a parameter for the PutComplianceItems API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.\n\nBy default, all associations use `AUTO` mode.",
|
|
36570
38483
|
"Targets": "The targets for the association. You must specify the `InstanceId` or `Targets` property. You can target all instances in an AWS account by specifying the `InstanceIds` key with a value of `*` . To view a JSON and a YAML example that targets all instances, see \"Create an association for all managed instances in an AWS account \" on the Examples page.",
|
|
36571
38484
|
"WaitForSuccessTimeoutSeconds": "The number of seconds the service should wait for the association status to show \"Success\" before proceeding with the stack execution. If the association status doesn't show \"Success\" after the specified number of seconds, then stack creation fails."
|
|
@@ -36609,7 +38522,7 @@
|
|
|
36609
38522
|
"Requires": "A list of SSM documents required by a document. This parameter is used exclusively by AWS AppConfig . When a user creates an AWS AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an `ApplicationConfiguration` document requires an `ApplicationConfigurationSchema` document for validation purposes. For more information, see [What is AWS AppConfig ?](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the *AWS AppConfig User Guide* .",
|
|
36610
38523
|
"Tags": "AWS CloudFormation resource tags to apply to the document. Use tags to help you identify and categorize resources.",
|
|
36611
38524
|
"TargetType": "Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: `/AWS::EC2::Instance` . If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see [AWS resource and property types reference](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the *AWS CloudFormation User Guide* .",
|
|
36612
|
-
"UpdateMethod": "",
|
|
38525
|
+
"UpdateMethod": "If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced. `Replace` is the default method. If you specify `NewVersion` for the `UpdateMethod` parameter, and the `Name` of the document does not match an existing resource, a new document is created. When you specify `NewVersion` , the default version of the document is changed to the newly created version.",
|
|
36613
38526
|
"VersionName": "An optional field specifying the version of the artifact you are creating with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and can't be changed."
|
|
36614
38527
|
}
|
|
36615
38528
|
},
|
|
@@ -39264,6 +41177,7 @@
|
|
|
39264
41177
|
"ArtifactConfig": "A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.",
|
|
39265
41178
|
"ArtifactS3Location": "The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files. Specify the full location path, including `s3://` at the beginning of the path.",
|
|
39266
41179
|
"Code": "Use this structure to input your script code for the canary. This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script is passed into the canary directly, the script code is contained in the value of `Script` .",
|
|
41180
|
+
"DeleteLambdaResourcesOnCanaryDeletion": "Specifies whether AWS CloudFormation is to also delete the Lambda functions and layers used by this canary, when the canary is deleted. The default is false.",
|
|
39267
41181
|
"ExecutionRoleArn": "The ARN of the IAM role to be used to run the canary. This role must already exist, and must include `lambda.amazonaws.com` as a principal in the trust policy. The role must also have the following permissions:\n\n- `s3:PutObject`\n- `s3:GetBucketLocation`\n- `s3:ListAllMyBuckets`\n- `cloudwatch:PutMetricData`\n- `logs:CreateLogGroup`\n- `logs:CreateLogStream`\n- `logs:PutLogEvents`",
|
|
39268
41182
|
"FailureRetentionPeriod": "The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.",
|
|
39269
41183
|
"Name": "The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.\n\nDo not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see [Security Considerations for Synthetics Canaries](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html) .",
|
|
@@ -39633,6 +41547,26 @@
|
|
|
39633
41547
|
"Type": "Currently, the following step types are supported.\n\n- *COPY* : copy the file to another location\n- *CUSTOM* : custom step with a lambda target\n- *DELETE* : delete the file\n- *TAG* : add a tag to the file"
|
|
39634
41548
|
}
|
|
39635
41549
|
},
|
|
41550
|
+
"AWS::VoiceID::Domain": {
|
|
41551
|
+
"attributes": {
|
|
41552
|
+
"DomainId": "The identifier of the domain.",
|
|
41553
|
+
"Ref": "`Ref` returns the `DomainId` of the domain."
|
|
41554
|
+
},
|
|
41555
|
+
"description": "Creates a domain that contains all Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.",
|
|
41556
|
+
"properties": {
|
|
41557
|
+
"Description": "The client-provided description of the domain.",
|
|
41558
|
+
"Name": "The client-provided name for the domain.",
|
|
41559
|
+
"ServerSideEncryptionConfiguration": "The server-side encryption configuration containing the KMS Key Identifier you want VoiceID to use to encrypt your data.",
|
|
41560
|
+
"Tags": "The tags used to organize, track, or control access for this resource."
|
|
41561
|
+
}
|
|
41562
|
+
},
|
|
41563
|
+
"AWS::VoiceID::Domain.ServerSideEncryptionConfiguration": {
|
|
41564
|
+
"attributes": {},
|
|
41565
|
+
"description": "The configuration containing information about the customer-managed KMS Key used for encrypting customer data.",
|
|
41566
|
+
"properties": {
|
|
41567
|
+
"KmsKeyId": "The identifier of the KMS Key you want VoiceID to use to encrypt your data."
|
|
41568
|
+
}
|
|
41569
|
+
},
|
|
39636
41570
|
"AWS::WAF::ByteMatchSet": {
|
|
39637
41571
|
"attributes": {
|
|
39638
41572
|
"Ref": "`Ref` returns the resource physical ID, such as 1234a1a-a1b1-12a1-abcd-a123b123456."
|
|
@@ -41072,6 +43006,44 @@
|
|
|
41072
43006
|
"ServiceType": "Matches the `origin` that the service uses to identify its type in segments.",
|
|
41073
43007
|
"URLPath": "Matches the path from a request URL."
|
|
41074
43008
|
}
|
|
43009
|
+
},
|
|
43010
|
+
"Alexa::ASK::Skill": {
|
|
43011
|
+
"attributes": {
|
|
43012
|
+
"Ref": "`Ref` returns the skill ID, such as amzn1.ask.skill.a3103cee-c48c-40a0-a2c9-251141888863."
|
|
43013
|
+
},
|
|
43014
|
+
"description": "The `Alexa::ASK::Skill` resource creates an Alexa skill that enables customers to access new abilities. For more information about developing a skill, see the .",
|
|
43015
|
+
"properties": {
|
|
43016
|
+
"AuthenticationConfiguration": "Login with Amazon (LWA) configuration used to authenticate with the Alexa service. Only Login with Amazon clients created through the are supported. The client ID, client secret, and refresh token are required.",
|
|
43017
|
+
"SkillPackage": "Configuration for the skill package that contains the components of the Alexa skill. Skill packages are retrieved from an Amazon S3 bucket and key and used to create and update the skill. For more information about the skill package format, see the .",
|
|
43018
|
+
"VendorId": "The vendor ID associated with the Amazon developer account that will host the skill. Details for retrieving the vendor ID are in . The provided LWA credentials must be linked to the developer account associated with this vendor ID."
|
|
43019
|
+
}
|
|
43020
|
+
},
|
|
43021
|
+
"Alexa::ASK::Skill.AuthenticationConfiguration": {
|
|
43022
|
+
"attributes": {},
|
|
43023
|
+
"description": "The `AuthenticationConfiguration` property type specifies the Login with Amazon (LWA) configuration used to authenticate with the Alexa service. Only Login with Amazon security profiles created through the are supported for authentication. A client ID, client secret, and refresh token are required. You can generate a client ID and client secret by creating a new on the Amazon Developer Portal or you can retrieve them from an existing profile. You can then retrieve the refresh token using the Alexa Skills Kit CLI. For instructions, see in the .\n\n`AuthenticationConfiguration` is a property of the `Alexa::ASK::Skill` resource.",
|
|
43024
|
+
"properties": {
|
|
43025
|
+
"ClientId": "Client ID from Login with Amazon (LWA).",
|
|
43026
|
+
"ClientSecret": "Client secret from Login with Amazon (LWA).",
|
|
43027
|
+
"RefreshToken": "Refresh token from Login with Amazon (LWA). This token is secret."
|
|
43028
|
+
}
|
|
43029
|
+
},
|
|
43030
|
+
"Alexa::ASK::Skill.Overrides": {
|
|
43031
|
+
"attributes": {},
|
|
43032
|
+
"description": "The `Overrides` property type provides overrides to the skill package to apply when creating or updating the skill. Values provided here do not modify the contents of the original skill package. Currently, only overriding values inside of the skill manifest component of the package is supported.\n\n`Overrides` is a property of the `Alexa::ASK::Skill SkillPackage` property type.",
|
|
43033
|
+
"properties": {
|
|
43034
|
+
"Manifest": "Overrides to apply to the skill manifest inside of the skill package. The skill manifest contains metadata about the skill. For more information, see ."
|
|
43035
|
+
}
|
|
43036
|
+
},
|
|
43037
|
+
"Alexa::ASK::Skill.SkillPackage": {
|
|
43038
|
+
"attributes": {},
|
|
43039
|
+
"description": "The `SkillPackage` property type contains configuration details for the skill package that contains the components of the Alexa skill. Skill packages are retrieved from an Amazon S3 bucket and key and used to create and update the skill. More details about the skill package format are located in the .\n\n`SkillPackage` is a property of the `Alexa::ASK::Skill` resource.",
|
|
43040
|
+
"properties": {
|
|
43041
|
+
"Overrides": "Overrides to the skill package to apply when creating or updating the skill. Values provided here do not modify the contents of the original skill package. Currently, only overriding values inside of the skill manifest component of the package is supported.",
|
|
43042
|
+
"S3Bucket": "The name of the Amazon S3 bucket where the .zip file that contains the skill package is stored.",
|
|
43043
|
+
"S3BucketRole": "ARN of the IAM role that grants the Alexa service ( `alexa-appkit.amazon.com` ) permission to access the bucket and retrieve the skill package. This property is optional. If you do not provide it, the bucket must be publicly accessible or configured with a policy that allows this access. Otherwise, AWS CloudFormation cannot create the skill.",
|
|
43044
|
+
"S3Key": "The location and name of the skill package .zip file.",
|
|
43045
|
+
"S3ObjectVersion": "If you have S3 versioning enabled, the version ID of the skill package.zip file."
|
|
43046
|
+
}
|
|
41075
43047
|
}
|
|
41076
43048
|
}
|
|
41077
43049
|
}
|