Skip to content

Commit

Permalink
docs(cfnspec): update CloudFormation documentation (#23293)
Browse files Browse the repository at this point in the history
  • Loading branch information
@aws-cdk-automation
aws-cdk-automation authored Dec 9, 2022
1 parent fdabadc commit de21651
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions packages/@aws-cdk/cfnspec/spec-source/cfn-docs/cfn-docs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14574,7 +14574,7 @@
"CapacityReservationSpecification": "The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to `open` , which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).",
"CpuOptions": "The CPU options for the instance. For more information, see [Optimizing CPU Options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon Elastic Compute Cloud User Guide* .",
"CreditSpecification": "The credit option for CPU usage of the instance. Valid only for T instances.",
"DisableApiStop": "Indicates whether to enable the instance for stop protection. For more information, see [Stop Protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) .",
"DisableApiStop": "Indicates whether to enable the instance for stop protection. For more information, see [Stop protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) in the *Amazon Elastic Compute Cloud User Guide* .",
"DisableApiTermination": "If you set this parameter to `true` , you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use [ModifyInstanceAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html) . Alternatively, if you set `InstanceInitiatedShutdownBehavior` to `terminate` , you can terminate the instance by running the shutdown command from the instance.",
"EbsOptimized": "Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.",
"ElasticGpuSpecifications": "An elastic GPU to associate with the instance.",
Expand Down Expand Up @@ -17388,8 +17388,8 @@
"attributes": {},
"description": "An object representing the remote access configuration for the managed node group.",
"properties": {
"Ec2SshKey": "The Amazon EC2 SSH key that provides access for SSH communication with the nodes in the managed node group. 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 Elastic Compute Cloud User Guide for Linux Instances* .",
"SourceSecurityGroups": "The security groups that are allowed SSH access (port 22) to the nodes. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the nodes is opened to the internet (0.0.0.0/0). For more information, see [Security Groups for Your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide* ."
"Ec2SshKey": "The Amazon EC2 SSH key name that provides access for SSH communication with the nodes in the managed node group. 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 Elastic Compute Cloud User Guide for Linux Instances* .",
"SourceSecurityGroups": "The security group ids that are allowed SSH access (port 22) to the nodes. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the nodes is opened to the internet (0.0.0.0/0). For more information, see [Security Groups for Your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide* ."
}
},
"AWS::EKS::Nodegroup.ScalingConfig": {
Expand Down Expand Up @@ -17611,7 +17611,7 @@
"MasterInstanceGroup": "Describes the EC2 instances and instance configurations for the master instance group when using clusters with the uniform instance group configuration.",
"Placement": "The Availability Zone in which the cluster runs.",
"ServiceAccessSecurityGroup": "The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.",
"TaskInstanceFleets": "Describes the EC2 instances and instance configurations for the task instance fleets when using clusters with the instance fleet configuration. These task instance fleets are added to the cluster as part of the cluster launch. Each task instance fleet must have a unique name specified so that CloudFormation can differentiate between the task instance fleets.\n\n> You can currently specify only one task instance fleet for a cluster. After creating the cluster, you can only modify the mutable properties of `InstanceFleetConfig` , which are `TargetOnDemandCapacity` and `TargetSpotCapacity` . Modifying any other property results in cluster replacement.",
"TaskInstanceFleets": "Describes the EC2 instances and instance configurations for the task instance fleets when using clusters with the instance fleet configuration. These task instance fleets are added to the cluster as part of the cluster launch. Each task instance fleet must have a unique name specified so that CloudFormation can differentiate between the task instance fleets.\n\n> You can currently specify only one task instance fleet for a cluster. After creating the cluster, you can only modify the mutable properties of `InstanceFleetConfig` , which are `TargetOnDemandCapacity` and `TargetSpotCapacity` . Modifying any other property results in cluster replacement. > To allow a maximum of 30 Amazon EC2 instance types per fleet, include `TaskInstanceFleets` when you create your cluster. If you create your cluster without `TaskInstanceFleets` , Amazon EMR uses its default allocation strategy, which allows for a maximum of five Amazon EC2 instance types.",
"TaskInstanceGroups": "Describes the EC2 instances and instance configurations for task instance groups when using clusters with the uniform instance group configuration. These task instance groups are added to the cluster as part of the cluster launch. Each task instance group must have a unique name specified so that CloudFormation can differentiate between the task instance groups.\n\n> After creating the cluster, you can only modify the mutable properties of `InstanceGroupConfig` , which are `AutoScalingPolicy` and `InstanceCount` . Modifying any other property results in cluster replacement.",
"TerminationProtected": "Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error."
}
Expand Down Expand Up @@ -18046,7 +18046,7 @@
"attributes": {},
"description": "The information about the container used for a job run or a managed endpoint.",
"properties": {
"EksInfo": "The information about the EKS cluster."
"EksInfo": "The information about the Amazon EKS cluster."
}
},
"AWS::EMRContainers::VirtualCluster.ContainerProvider": {
Expand All @@ -18055,12 +18055,12 @@
"properties": {
"Id": "The ID of the container cluster.\n\n*Minimum* : 1\n\n*Maximum* : 100\n\n*Pattern* : `^[0-9A-Za-z][A-Za-z0-9\\-_]*`",
"Info": "The information about the container cluster.",
"Type": "The type of the container provider. EKS is the only supported type as of now."
"Type": "The type of the container provider. Amazon EKS is the only supported type as of now."
}
},
"AWS::EMRContainers::VirtualCluster.EksInfo": {
"attributes": {},
"description": "The information about the EKS cluster.",
"description": "The information about the Amazon EKS cluster.",
"properties": {
"Namespace": "The namespaces of the EKS cluster.\n\n*Minimum* : 1\n\n*Maximum* : 63\n\n*Pattern* : `[a-z0-9]([-a-z0-9]*[a-z0-9])?`"
}
Expand Down Expand Up @@ -37821,7 +37821,7 @@
"attributes": {},
"description": "The parameters for using a Lambda function as a target.",
"properties": {
"InvocationType": "Choose from the following options.\n\n- `RequestResponse` (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.\n- `Event` - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if it's configured). The API response only includes a status code.\n- `DryRun` - Validate parameter values and verify that the user or role has permission to invoke the function."
"InvocationType": "Choose from the following options.\n\n- `REQUEST_RESPONSE` (default) - Invoke synchronously.\n- `FIRE_AND_FORGET` - Invoke asynchronously.\n\nFor more information, see [Invocation types](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation) in the *Amazon EventBridge User Guide* ."
}
},
"AWS::Pipes::Pipe.PipeTargetParameters": {
Expand All @@ -37836,19 +37836,19 @@
"InputTemplate": "Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see [The JavaScript Object Notation (JSON) Data Interchange Format](https://docs.aws.amazon.com/http://www.rfc-editor.org/rfc/rfc7159.txt) .",
"KinesisStreamParameters": "The parameters for using a Kinesis stream as a source.",
"LambdaFunctionParameters": "The parameters for using a Lambda function as a target.",
"RedshiftDataParameters": "These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.",
"RedshiftDataParameters": "These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.",
"SageMakerPipelineParameters": "The parameters for using a SageMaker pipeline as a target.",
"SqsQueueParameters": "The parameters for using a Amazon SQS stream as a source.",
"StepFunctionStateMachineParameters": "The parameters for using a Step Functions state machine as a target."
}
},
"AWS::Pipes::Pipe.PipeTargetRedshiftDataParameters": {
"attributes": {},
"description": "These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.",
"description": "These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.",
"properties": {
"Database": "The name of the database. Required when authenticating using temporary credentials.",
"DbUser": "The database user name. Required when authenticating using temporary credentials.",
"SecretManagerArn": "The name or ARN of the secret that enables access to the database. Required when authenticating using SageMaker .",
"SecretManagerArn": "The name or ARN of the secret that enables access to the database. Required when authenticating using Secrets Manager .",
"Sqls": "The SQL statement text to run.",
"StatementName": "The name of the SQL statement. You can name the SQL statement when you create it to identify the query.",
"WithEvent": "Indicates whether to send an event back to EventBridge after the SQL statement runs."
Expand All @@ -37873,7 +37873,7 @@
"attributes": {},
"description": "The parameters for using a Step Functions state machine as a target.",
"properties": {
"InvocationType": "Specify whether to wait for the state machine to finish or not."
"InvocationType": "Specify whether to wait for the state machine to finish or not.\n\nChoose from the following options.\n\n- `REQUEST_RESPONSE` (default) - Invoke synchronously.\n- `FIRE_AND_FORGET` - Invoke asynchronously.\n\nFor more information, see [Invocation types](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation) in the *Amazon EventBridge User Guide* ."
}
},
"AWS::Pipes::Pipe.PlacementConstraint": {
Expand Down Expand Up @@ -42191,7 +42191,7 @@
"AWS::SNS::Topic": {
"attributes": {
"Ref": "`Ref` returns the topic ARN, for example: `arn:aws:sns:us-east-1:123456789012:mystack-mytopic-NZJ5JSMVGFIE` .",
"TopicArn": "",
"TopicArn": "Returns the ARN of an Amazon SNS topic.",
"TopicName": "Returns the name of an Amazon SNS topic."
},
"description": "The `AWS::SNS::Topic` resource creates a topic to which notifications can be published.\n\n> One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [Amazon SNS endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *AWS General Reference* .",
Expand Down

0 comments on commit de21651

Please sign in to comment.