--- timestamp: 2017-12-11 12:24:30.058700000 +01:00 resources: AWS::ApiGateway::Account: description: |- The `AWS::ApiGateway::Account` resource specifies the AWS Identity and Access Management (IAM) role that Amazon API Gateway (API Gateway) uses to write API logs to Amazon CloudWatch Logs (CloudWatch Logs). Important If an API Gateway resource has never been created in your AWS account, you must add a dependency on another API Gateway resource, such as an [AWS::ApiGateway::RestApi](aws-resource-apigateway-restapi.html) or [AWS::ApiGateway::ApiKey](aws-resource-apigateway-apikey.html) resource. If an API Gateway resource has been created in your AWS account, no dependency is required (even if the resource was deleted). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html properties: CloudWatchRoleArn: description: |+ The Amazon Resource Name (ARN) of an IAM role that has write access to CloudWatch Logs in your account. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the ID of the resource, such as `mysta-accou-01234b567890example`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ApiGateway::ApiKey: description: The `AWS::ApiGateway::ApiKey` resource creates a unique key that you can distribute to clients who are executing Amazon API Gateway (API Gateway) `Method` resources that require an API key. To specify which API key clients must use, map the API key with the `RestApi` and `Stage` resources that include the methods that require a key. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html properties: CustomerId: description: |+ An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Description: description: |+ A description of the purpose of the API key. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Enabled: description: |+ Indicates whether the API key can be used by clients. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption GenerateDistinctId: description: |+ Specifies whether the key identifier is distinct from the created API key value. _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement Name: description: |+ A name for the API key. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement StageKeys: description: |+ A list of stages to associate with this API key. _Required:_ No _Type_: List of [Amazon API Gateway ApiKey StageKey](aws-properties-apitgateway-apikey-stagekey.html) property types _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the API key ID, such as `m2m1k7sybf`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ApiGateway::Authorizer: description: The `AWS::ApiGateway::Authorizer` resource creates an authorization layer that Amazon API Gateway (API Gateway) activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html properties: AuthType: description: |+ An optional customer-defined field that's used in Swagger imports and exports without functional impact. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption AuthorizerCredentials: description: |+ The credentials that are required for the authorizer. To specify an AWS Identity and Access Management (IAM) role that API Gateway assumes, specify the role's Amazon Resource Name (ARN). To use resource-based permissions on the AWS Lambda (Lambda) function, specify null. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption AuthorizerResultTtlInSeconds: description: |+ The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches authorizer results. If you specify a value greater than `0`, API Gateway caches the authorizer responses. By default, API Gateway sets this property to `300`. The maximum value is `3600`, or 1 hour. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption AuthorizerUri: description: |+ The authorizer's Uniform Resource Identifier (URI). If you specify `TOKEN` for the authorizer's `Type` property, specify a Lambda function URI that has the form `arn:aws:apigateway:region:lambda:path/path`. The path usually has the form `/2015-03-31/functions/LambdaFunctionARN/invocations`. _Required:_ Conditional. Specify this property for Lambda functions only. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption IdentitySource: description: |+ The source of the identity in an incoming request. If you specify `TOKEN` for the authorizer's `Type` property, specify a mapping expression. The custom header mapping expression has the form `method.request.header.name`, where _`name`_ is the name of a custom authorization header that clients submit as part of their requests. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption IdentityValidationExpression: description: |+ A validation expression for the incoming identity. If you specify `TOKEN` for the authorizer's `Type` property, specify a regular expression. API Gateway uses the expression to attempt to match the incoming client token, and proceeds if the token matches. If the token doesn't match, API Gateway responds with a 401 (unauthorized request) error code. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Name: description: |+ The name of the authorizer. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption ProviderARNs: description: |+ A list of the Amazon Cognito user pool Amazon Resource Names (ARNs) to associate with this authorizer. For more information, see [Use Amazon Cognito Your User Pool](http://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html#apigateway-enable-cognito-user-pool) in the _API Gateway Developer Guide_. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption RestApiId: description: |+ The ID of the `RestApi` resource that API Gateway creates the authorizer in. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Type: description: "The type of authorizer:\n\n- \n\nFor a custom authorizer that uses a Lambda function, use `TOKEN`.\n\n- \n\nFor an authorizer that uses Amazon Cognito user pools, use `COGNITO_USER_POOLS`.\n\n_Required:_ Yes\n\n_Type_: String\n\n_Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n\n" required: 'yes' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the authorizer's ID, such as `abcde1`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ApiGateway::BasePathMapping: description: The `AWS::ApiGateway::BasePathMapping` resource creates a base path that clients who call your Amazon API Gateway API must use in the invocation URL. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html properties: BasePath: description: |+ The base path name that callers of the API must provide in the URL after the domain name. If you specify this property, it can't be an empty string. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement DomainName: description: |+ The domain name of a `DomainName` resource. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement RestApiId: description: |+ The name of the API. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Stage: description: |+ The name of the API's stage. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::ApiGateway::ClientCertificate: description: The `AWS::ApiGateway::ClientCertificate` resource creates a client certificate that Amazon API Gateway (API Gateway) uses to configure client-side SSL authentication for sending requests to the integration endpoint. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html properties: Description: description: |+ A description of the client certificate. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the client certificate name, such as `abc123`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ApiGateway::Deployment: description: The `AWS::ApiGateway::Deployment` resource deploys an Amazon API Gateway (API Gateway) `RestApi` resource to a stage so that clients can call the API over the Internet. The stage acts as an environment. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html properties: Description: description: |+ A description of the purpose of the API Gateway deployment. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption RestApiId: description: |+ The ID of the [RestApi](aws-resource-apigateway-restapi.html) resource to deploy. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement StageDescription: description: |+ Configures the stage that API Gateway creates with this deployment. _Required:_ No _Type_: [Amazon API Gateway Deployment StageDescription](aws-properties-apigateway-deployment-stagedescription.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon API Gateway Deployment StageDescription update_requires: no_interruption StageName: description: |+ A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the deployment ID, such as `123abc`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ApiGateway::DocumentationPart: description: The `AWS::ApiGateway::DocumentationPart` resource creates a documentation part for an Amazon API Gateway API entity. For more information, see [Representation of API Documentation in API Gateway](http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the _API Gateway Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html properties: Location: description: |+ The location of the API entity that the documentation applies to. _Required_: Yes _Type_: [Amazon API Gateway DocumentationPart Location](aws-properties-apigateway-documentationpart-location.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: Amazon API Gateway DocumentationPart Location update_requires: replacement Properties: description: |+ The documentation content map of the targeted API entity. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption RestApiId: description: |+ The identifier of the targeted API entity. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When you pass the logical ID of an `AWS::ApiGateway::DocumentationPart` resource to the intrinsic `Ref` function, the function returns the ID of the documentation part, such as `abc123`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ApiGateway::DocumentationVersion: description: The `AWS::ApiGateway::DocumentationVersion` resource creates a snapshot of the documentation for an Amazon API Gateway API entity. For more information, see [Representation of API Documentation in API Gateway](http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the _API Gateway Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html properties: Description: description: |+ The description of the API documentation snapshot. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption DocumentationVersion: description: |+ The version identifier of the API documentation snapshot. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement RestApiId: description: |+ The identifier of the targeted API entity. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: '' examples: {} AWS::ApiGateway::DomainName: description: |- The `AWS::ApiGateway::DomainName` resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway). You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Use Custom Domain Name as API Gateway API Host Name](http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the _API Gateway Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html properties: CertificateArn: description: |+ The reference to an AWS-managed certificate for use by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source. For requirements and additional information about setting up certificates, see [Get Certificates Ready in AWS Certificate Manager](http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html#how-to-custom-domains-prerequisites) in the _API Gateway Developer Guide_. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption DomainName: description: |+ The custom domain name for your API in Amazon API Gateway. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement EndpointConfiguration: description: |+ A list of the endpoint types of the domain name. _Required_: No _Type_: [API Gateway DomainName EndpointConfiguration](aws-properties-apigateway-domainname-endpointconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: API Gateway DomainName EndpointConfiguration update_requires: no_interruption RegionalCertificateArn: description: |+ The reference to an AWS-managed certificate for use by the regional endpoint for the domain name. AWS Certificate Manager is the only supported source. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the domain name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). DistributionDomainName: description: |+ The Amazon CloudFront distribution domain name that's mapped to the custom domain name. Example: `d111111abcdef8.cloudfront.net` examples: {} AWS::ApiGateway::GatewayResponse: description: The `AWS::ApiGateway::GatewayResponse` resource creates a custom response for your API Gateway API. For more information, see [API Gateway Responses](http://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html#api-gateway-gatewayResponse-definition) in the _API Gateway Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html properties: ResponseParameters: description: |+ The response parameters (paths, query strings, and headers) for the response. Duplicates not allowed. _Required_: No _Type_: String to string map _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String to string map update_requires: no_interruption ResponseTemplates: description: |+ The response templates for the response. Duplicates not allowed. _Required_: No _Type_: String to string map _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String to string map update_requires: no_interruption ResponseType: description: |+ The response type. For valid values, see [GatewayResponse](http://docs.aws.amazon.com/apigateway/api-reference/resource/gateway-response/) in the _API Gateway API Reference_. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement RestApiId: description: |+ The identifier of the targeted API entity. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement StatusCode: description: |+ The HTTP status code for the response. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::ApiGateway::Method: description: The `AWS::ApiGateway::Method` resource creates Amazon API Gateway (API Gateway) methods that define the parameters and body that clients must send in their requests. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html properties: ApiKeyRequired: description: |+ Indicates whether the method requires clients to submit a valid API key. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption AuthorizationType: description: |+ The method's authorization type. _Required:_ Yes. If you specify the `AuthorizerId` property, specify `CUSTOM` for this property. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption AuthorizerId: description: |+ The identifier of the [authorizer](aws-resource-apigateway-authorizer.html) to use on this method. If you specify this property, specify `CUSTOM` for the `AuthorizationType` property. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption HttpMethod: description: |+ The HTTP method that clients use to call this method. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Integration: description: |+ The backend system that the method calls when it receives a request. _Required:_ No _Type_: [Amazon API Gateway Method Integration](aws-properties-apitgateway-method-integration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon API Gateway Method Integration update_requires: no_interruption MethodResponses: description: |+ The responses that can be sent to the client who calls the method. _Required:_ No _Type_: List of [Amazon API Gateway Method MethodResponse](aws-properties-apitgateway-method-methodresponse.html) property types. _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption OperationName: description: |+ A friendly operation name for the method. For example, you can assign the `OperationName` of _ListPets_ for the `GET /pets` method. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption RequestModels: description: |+ The resources that are used for the response's content type. Specify response models as key-value pairs (string-to-string mapping), with a content type as the key and a `Model` resource name as the value. _Required:_ No _Type_: Mapping of key-value pairs _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List> update_requires: no_interruption RequestParameters: description: |+ The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value. The Boolean specifies whether a parameter is required. A source must match the format `method.request.location.name`, where the _`location`_ is `querystring`, `path`, or `header`, and _`name`_ is a valid, unique parameter name. _Required:_ No _Type_: Mapping of key-value pairs _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List> update_requires: no_interruption RequestValidatorId: description: |+ The ID of the associated request validator. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption ResourceId: description: |+ The ID of an API Gateway [resource](aws-resource-apigateway-resource.html). For root resource methods, specify the RestApi root resource ID, such as `{ "Fn::GetAtt": ["MyRestApi", "RootResourceId"] }`. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption RestApiId: description: |+ The ID of the [RestApi](aws-resource-apigateway-restapi.html) resource in which API Gateway creates the method. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the method ID, such as `mysta-metho-01234b567890example`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ApiGateway::Model: description: The `AWS::ApiGateway::Model` resource defines the structure of a request or response payload for an Amazon API Gateway (API Gateway) method. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html properties: ContentType: description: |+ The content type for the model. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Description: description: |+ A description that identifies this model. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Name: description: |+ A name for the model. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement RestApiId: description: |+ The ID of a REST API with which to associate this model. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Schema: description: |+ The schema to use to transform data to one or more output formats. Specify null (`{}`) if you don't want to specify a schema. _Required:_ Yes _Type_: JSON object _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: JSON update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the model name, such as `myModel`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ApiGateway::RequestValidator: description: The `AWS::ApiGateway::RequestValidator` resource sets up basic validation rules for incoming requests to your API Gateway API. For more information, see [Enable Basic Request Validation for an API in API Gateway](http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) in the _API Gateway Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html properties: Name: description: |+ The name of this request validator. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement RestApiId: description: |+ The identifier of the targeted API entity. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement ValidateRequestBody: description: |+ Indicates whether to validate the request body according to the configured schema for the targeted API and method. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption ValidateRequestParameters: description: |+ Indicates whether to validate request parameters. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the ID of the request validator, such as `abc123`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ApiGateway::Resource: description: The `AWS::ApiGateway::Resource` resource creates a resource in an Amazon API Gateway (API Gateway) API. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html properties: ParentId: description: |+ If you want to create a child resource, the ID of the parent resource. For resources without a parent, specify the RestApi root resource ID, such as `{ "Fn::GetAtt": ["MyRestApi", "RootResourceId"] }`. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement PathPart: description: |+ A path name for the resource. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement RestApiId: description: |+ The ID of the `RestApi` resource in which you want to create this resource. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource ID, such as `abc123`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ApiGateway::RestApi: description: |- The `AWS::ApiGateway::RestApi` resource contains a collection of Amazon API Gateway resources and methods that can be invoked through HTTPS endpoints. For more information, see [restapi:create](http://docs.aws.amazon.com//apigateway/api-reference/link-relation/restapi-create/) in the _Amazon API Gateway REST API Reference_. Note On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://www.openapis.org/), becoming the foundation of the OpenAPI Specification. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html properties: BinaryMediaTypes: description: |+ The list of binary media types that are supported by the `RestApi` resource, such as `image/png` or `application/octet-stream`. By default, `RestApi` supports only UTF-8-encoded text payloads. For more information, see [Enable Support for Binary Payloads in API Gateway](http://docs.aws.amazon.com//apigateway/latest/developerguide/api-gateway-payload-encodings.html) in the _API Gateway Developer Guide_. Duplicates are not allowed. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Body: description: |+ An OpenAPI specification that defines a set of RESTful APIs in the JSON format. For YAML templates, you can also provide the specification in the YAML format. _Required:_ No _Type_: JSON object _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: JSON update_requires: no_interruption BodyS3Location: description: |+ The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. _Required:_ No _Type_: [Amazon API Gateway RestApi S3Location](aws-properties-apitgateway-restapi-bodys3location.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon API Gateway RestApi S3Location update_requires: no_interruption CloneFrom: description: |+ The ID of the API Gateway `RestApi` resource that you want to clone. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Description: description: |+ A description of the purpose of this API Gateway `RestApi` resource. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption EndpointConfiguration: description: |+ A list of the endpoint types of the API. _Required_: No _Type_: [API Gateway RestApi EndpointConfiguration](aws-properties-apigateway-restapi-endpointconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: API Gateway RestApi EndpointConfiguration update_requires: no_interruption FailOnWarnings: description: |+ Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the `RestApi` resource. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption Name: description: |+ A name for the API Gateway `RestApi` resource. _Required:_ Conditional. Required if you don't specify a OpenAPI definition. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption Parameters: description: |+ Custom header parameters for the request. _Required:_ No _Type_: String to String map _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String to String map update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the `RestApi` ID, such as `a1bcdef2gh`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). RootResourceId: description: |+ The root resource ID for a `RestApi` resource, such as `a0bc123d4e`. examples: {} AWS::ApiGateway::Stage: description: The `AWS::ApiGateway::Stage` resource creates a stage for an Amazon API Gateway (API Gateway) deployment. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html properties: CacheClusterEnabled: description: |+ Indicates whether cache clustering is enabled for the stage. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption CacheClusterSize: description: |+ The stage's cache cluster size. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption ClientCertificateId: description: |+ The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption DeploymentId: description: |+ The ID of the deployment that the stage points to. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Description: description: |+ A description of the stage's purpose. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption DocumentationVersion: description: |+ The version identifier of the API documentation snapshot. _Required:_ No _Type_: String required: 'no' type: String update_requires: MethodSettings: description: |+ Settings for all methods in the stage. _Required:_ No _Type_: List of [API Gateway Stage MethodSetting](aws-properties-apigateway-stage-methodsetting.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption RestApiId: description: |+ The ID of the `RestApi` resource that you're deploying with this stage. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement StageName: description: |+ The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI). _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Variables: description: |+ A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: `[A-Za-z0-9-._~:/?#&=,]+`. _Required:_ No _Type_: Mapping of key-value pairs _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List> update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the name of the stage, such as `MyTestStage`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ApiGateway::UsagePlan: description: The `AWS::ApiGateway::UsagePlan` resource specifies a usage plan for deployed Amazon API Gateway (API Gateway) APIs. A usage plan enforces throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the _API Gateway Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html properties: ApiStages: description: |+ The API stages to associate with this usage plan. _Required:_ No _Type_: List of [Amazon API Gateway UsagePlan ApiStage](aws-properties-apigateway-usageplan-apistage.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Description: description: |+ The purpose of this usage plan. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Quota: description: |+ Configures the number of requests that users can make within a given interval. _Required:_ No _Type_: [Amazon API Gateway UsagePlan QuotaSettings](aws-properties-apigateway-usageplan-quotasettings.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon API Gateway UsagePlan QuotaSettings update_requires: no_interruption Throttle: description: |+ Configures the overall request rate (average requests per second) and burst capacity. _Required:_ No _Type_: [Amazon API Gateway UsagePlan ThrottleSettings](aws-properties-apigateway-usageplan-throttlesettings.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon API Gateway UsagePlan ThrottleSettings update_requires: no_interruption UsagePlanName: description: |+ A name for this usage plan. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the usage plan ID, such as `MyUsagePlan`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ApiGateway::UsagePlanKey: description: The `AWS::ApiGateway::UsagePlanKey` resource associates an Amazon API Gateway API key with an API Gateway usage plan. This association determines which users the usage plan is applied to. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html properties: KeyId: description: |+ The ID of the usage plan key. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement KeyType: description: |+ The type of usage plan key. Currently, the valid key type is `API_KEY`. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement UsagePlanId: description: |+ The value of the usage plan key. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For example: Copy{ "Ref": "MyProfile" } For the `IAM::InstanceProfile` with the logical ID `MyProfile`, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ApplicationAutoScaling::ScalableTarget: description: "The `AWS::ApplicationAutoScaling::ScalableTarget` resource specifies a resource that Application Auto Scaling can scale up or down. For more information, see the [RegisterScalableTarget](http://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_RegisterScalableTarget.html) action in the _Application Auto Scaling API Reference_.\n\nUpdates to `AWS::DynamoDB::Table` resources that are associated with `AWS::ApplicationAutoScaling::ScalableTarget` resources will always result in an update failure and then an update rollback failure. The following `ScalableDimension` attributes cause this problem when associated with the table:\n\n- \n\ndynamodb:table:ReadCapacityUnits\n\n- \n\ndynamodb:table:WriteCapacityUnits\n\n- \n\ndynamodb:index:ReadCapacityUnits\n\n- \n\ndynamodb:index:WriteCapacityUnits\n\nAs a workaround, please deregister scalable targets before performing updates to `AWS::DynamoDB::Table` resources." url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html properties: MaxCapacity: description: |+ The maximum value that Application Auto Scaling can use to scale a target during a scaling activity. _Required:_ Yes _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Number update_requires: no_interruption MinCapacity: description: |+ The minimum value that Application Auto Scaling can use to scale a target during a scaling activity. _Required:_ Yes _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Number update_requires: no_interruption ResourceId: description: |+ The resource identifier to associate with this scalable target. This string consists of the resource type and unique identifier. For more information, see the `ResourceId` parameter for the [RegisterScalableTarget](http://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_RegisterScalableTarget.html) action in the _Application Auto Scaling API Reference_, or see the [`ScalableTarget` examples](aws-resource-applicationautoscaling-scalabletarget.html#aws-resource-applicationautoscaling-scalabletarget-examples). _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement RoleARN: description: |+ The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that allows Application Auto Scaling to modify your scalable target. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption ScalableDimension: description: |+ The scalable dimension that's associated with the scalable target. Specify the service namespace, resource type, and scaling property—for example, `ecs:service:DesiredCount` for the desired task count of an Amazon Elastic Container Service service. For valid values, see the `ScalableDimension` content for the [ScalingPolicy](http://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_ScalingPolicy.html) data type in the _Application Auto Scaling API Reference_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement ScheduledActions: description: |+ The scheduled actions for the scalable target. Duplicates aren't allowed. _Required_: No _Type_: List of [Application Auto Scaling ScalableTarget ScheduledAction](aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html) property types _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption ServiceNamespace: description: |+ The AWS service namespace of the scalable target. For a list of service namespaces, see [AWS Service Namespaces](http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the _AWS General Reference_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the AWS CloudFormation-generated ID of the resource, such as `service/ecsStack-MyECSCluster-AB12CDE3F4GH/ecsStack-MyECSService-AB12CDE3F4GH|ecs:service:DesiredCount|ecs`. AWS CloudFormation uses the following format to generate the ID: `service/resource_ID|scalable_dimension|service_namespace`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ApplicationAutoScaling::ScalingPolicy: description: The `AWS::ApplicationAutoScaling::ScalingPolicy` resource defines an Application Auto Scaling scaling policy that Application Auto Scaling uses to adjust your application resources. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html properties: PolicyName: description: |+ A name for the scaling policy. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement PolicyType: description: |+ An Application Auto Scaling policy type. Note For DynamoDB, only `TargetTrackingScaling` is supported. For any other service, only `StepScaling` is supported. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption ResourceId: description: |+ The unique resource identifier for the scalable target that this scaling policy applies to. For more information, see the `ResourceId` parameter for the [PutScalingPolicy](http://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_PutScalingPolicy.html) action in the _Application Auto Scaling API Reference_. _Required:_ Conditional. You must specify either the `ScalingTargetId` property or the `ResourceId`, `ScalableDimension`, and `ServiceNamespace` properties. If you specify the `ResourceId`, `ScalableDimension`, and `ServiceNamespace` properties, don't specify the `ScalingTargetId` property. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement ScalableDimension: description: |+ The scalable dimension of the scalable target that this scaling policy applies to. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service. _Required:_ Conditional. You must specify either the `ScalingTargetId` property or the `ResourceId`, `ScalableDimension`, and `ServiceNamespace` properties. If you specify the `ResourceId`, `ScalableDimension`, and `ServiceNamespace` properties, don't specify the `ScalingTargetId` property. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement ServiceNamespace: description: |+ The AWS service namespace of the scalable target that this scaling policy applies to. For a list of service namespaces, see [AWS Service Namespaces](http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the _AWS General Reference_. _Required:_ Conditional. You must specify either the `ScalingTargetId` property or the `ResourceId`, `ScalableDimension`, and `ServiceNamespace` properties. If you specify the `ResourceId`, `ScalableDimension`, and `ServiceNamespace` properties, don't specify the `ScalingTargetId` property. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement ScalingTargetId: description: |+ The AWS CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the [AWS::ApplicationAutoScaling::ScalableTarget](aws-resource-applicationautoscaling-scalabletarget.html) resource. _Required:_ Conditional. You must specify either the `ScalingTargetId` property or the `ResourceId`, `ScalableDimension`, and `ServiceNamespace` properties. If you specify this property, don't specify the `ResourceId`, `ScalableDimension`, and `ServiceNamespace` properties. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement StepScalingPolicyConfiguration: description: |+ A step policy that configures when Application Auto Scaling scales resources up or down, and by how much. _Required:_ No _Type_: [Application Auto Scaling ScalingPolicy StepScalingPolicyConfiguration](aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Application Auto Scaling ScalingPolicy StepScalingPolicyConfiguration update_requires: no_interruption TargetTrackingScalingPolicyConfiguration: description: |+ Configures a target tracking scaling policy. This parameter is required if you are creating a new policy and the policy type is `TargetTrackingScaling`. _Required:_ No _Type_: [Application Auto Scaling ScalingPolicy TargetTrackingScalingPolicyConfiguration](aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Application Auto Scaling ScalingPolicy TargetTrackingScalingPolicyConfiguration update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the Application Auto Scaling scaling policy Amazon Resource Name (ARN), such as `arn:aws:autoscaling:``us-east-2``:123456789012:scalingPolicy:12ab3c4d-56789-0ef1-2345-6ghi7jk8lm90:resource/ecs/service/ecsStack-MyECSCluster-AB12CDE3F4GH/ecsStack-MyECSService-AB12CDE3F4GH:policyName/MyStepPolicy`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Athena::NamedQuery: description: The `AWS::Athena::NamedQuery` resource creates an Amazon Athena query. For more information, see [CreateNamedQuery](http://docs.aws.amazon.com/athena/latest/APIReference/API_CreateNamedQuery.html) in the _Amazon Athena Documentation_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html properties: Description: description: |+ A brief description of the query. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption QueryString: description: |+ The SQL query statements that comprise the query. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Database: description: |+ The database to which the query belongs. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Name: description: |+ The plain-language name of the query. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::AutoScaling::AutoScalingGroup: description: |- The `AWS::AutoScaling::AutoScalingGroup` type creates an Auto Scaling group. You can add an [UpdatePolicy](aws-attribute-updatepolicy.html) attribute to your Auto Scaling group to control how rolling updates are performed when a change has been made to the Auto Scaling group's [launch configuration](aws-properties-as-launchconfig.html) or [subnet group membership](aws-properties-as-group.html#cfn-as-group-vpczoneidentifier). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html properties: AvailabilityZones: description: |+ Contains a list of availability zones for the group. _Required:_ Conditional. If you don't specify the `VPCZoneIdentifier` property, you must specify this property. _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: List update_requires: no_interruption Cooldown: description: |+ The number of seconds after a scaling activity is completed before any further scaling activities can start. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption DesiredCapacity: description: |+ Specifies the desired capacity for the Auto Scaling group. If `SpotPrice` is not set in the [AWS::AutoScaling::LaunchConfiguration](aws-properties-as-launchconfig.html) for this Auto Scaling group, then Auto Scaling will begin to bring instances online based on `DesiredCapacity`. CloudFormation will not mark the Auto Scaling group as successful (by setting its status to CREATE\_COMPLETE) until the desired capacity is reached. If `SpotPrice`_is_ set, then `DesiredCapacity` will not be used as a criteria for success, since instances will only be started when the spot price has been matched. After the spot price has been matched, however, Auto Scaling uses `DesiredCapacity` as the target capacity for the group. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption HealthCheckGracePeriod: description: |+ The length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking its health. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption HealthCheckType: description: |+ The service you want the health status from, Amazon EC2 or Elastic Load Balancer. Valid values are `EC2` or `ELB`. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption InstanceId: description: |+ The ID of the Amazon EC2 instance you want to use to create the Auto Scaling group. Use this property if you want to create an Auto Scaling group that uses an existing Amazon EC2 instance instead of a launch configuration. When you use an Amazon EC2 instance to create an Auto Scaling group, a new launch configuration is first created and then associated with the Auto Scaling group. The new launch configuration derives all its properties from the instance, with the exception of `BlockDeviceMapping` and `AssociatePublicIpAddress`. _Required:_ Conditional. You must specify this property if you don't specify the `LaunchConfigurationName` property. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement LaunchConfigurationName: description: |+ Specifies the name of the associated [AWS::AutoScaling::LaunchConfiguration](aws-properties-as-launchconfig.html) resource. Note If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the `DependsOn` attribute to declare a dependency on the VPC-gateway attachment. For more information, see [DependsOn Attribute](aws-attribute-dependson.html). _Required_: Conditional; you must specify this property if you don't specify the `InstanceId` property. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) Important When you update the `LaunchConfigurationName`, existing Amazon EC2 instances continue to run with the configuration that they were originally launched with. To update existing instances, specify an update policy attribute for this Auto Scaling group. For more information, see [UpdatePolicy](aws-attribute-updatepolicy.html). required: conditional type: String update_requires: no_interruption LifecycleHookSpecificationList: description: |+ The lifecycle hooks for the group, which specify actions to perform when Auto Scaling launches or terminates instances. For more information, see [Auto Scaling Lifecycle Hooks](http://docs.aws.amazon.com/autoscaling/latest/userguide/lifecycle-hooks.html) in the _Auto Scaling User Guide_. _Required:_ No _Type_: List of [Auto Scaling AutoScalingGroup LifecycleHookSpecification](aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption LoadBalancerNames: description: |+ A list of Classic load balancers associated with this Auto Scaling group. To specify Application load balancers, use `TargetGroupARNs`. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption MaxSize: description: |+ The maximum size of the Auto Scaling group. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption MetricsCollection: description: |+ Enables the monitoring of group metrics of an Auto Scaling group. _Required:_ No _Type_: A list of [Auto Scaling AutoScalingGroup MetricsCollection](aws-properties-as-metricscollection.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: A list of Auto Scaling AutoScalingGroup MetricsCollection update_requires: no_interruption MinSize: description: |+ The minimum size of the Auto Scaling group. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption NotificationConfigurations: description: |+ An embedded property that configures an Auto Scaling group to send notifications when specified events take place. _Required:_ No _Type_: List of [Auto Scaling AutoScalingGroup NotificationConfiguration](aws-properties-as-notificationconfigurations.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption PlacementGroup: description: |+ The name of an existing cluster placement group into which you want to launch your instances. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Tags: description: |+ The Auto Scaling tags to attach to this resource. For more information about Auto Scaling tags, see [Tagging Auto Scaling Groups and Amazon EC2 Instances](http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASTagging.html) in the _Auto Scaling User Guide_. _Required:_ No _Type_: List of [Auto Scaling AutoScalingGroup TagProperty](aws-properties-as-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption TargetGroupARNs: description: |+ A list of Amazon Resource Names (ARN) of target groups to associate with the Auto Scaling group. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption TerminationPolicies: description: |+ A policy or a list of policies that are used to select the instances to terminate. The policies are executed in the order that you list them. For more information on configuring a termination policy for your Auto Scaling group, see [Instance Termination Policy for Your Auto Scaling Group](http://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-termination.html) in the _Auto Scaling User Guide_. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption VPCZoneIdentifier: description: |+ A list of subnet identifiers of Amazon Virtual Private Cloud (Amazon VPCs). If you specify the `AvailabilityZones` property, the subnets that you specify for this property must reside in those Availability Zones. For more information, go to [Using EC2 Dedicated Instances Within Your VPC](http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/autoscalingsubnets.html) in the _Auto Scaling User Guide_. _Required:_ Conditional. If you don't specify the `AvailabilityZones` property, you must specify this property. _Type_: List of String values _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) Note When you update VPCZoneIdentifier, the instances are replaced, but not the Auto Scaling group. required: conditional type: List update_requires: some_interruptions return_values: Ref: description: '' examples: {} AWS::AutoScaling::LaunchConfiguration: description: |- The `AWS::AutoScaling::LaunchConfiguration` type creates an Auto Scaling launch configuration that can be used by an Auto Scaling group to configure Amazon EC2 instances in the Auto Scaling group. Important When you update a property of the `LaunchConfiguration` resource, AWS CloudFormation deletes that resource and creates a new launch configuration with the updated properties and a new name. This update action does not deploy any change across the running Amazon EC2 instances in the auto scaling group. In other words, an update simply replaces the `LaunchConfiguration` so that when the auto scaling group launches new instances, they will get the updated configuration, but existing instances continue to run with the configuration that they were originally launched with. This works the same way as if you made similar changes manually to an auto scaling group. If you want to update existing instances when you update the `LaunchConfiguration` resource, you must specify an update policy attribute for the `AWS::AutoScaling::AutoScalingGroup` resource. For more information, see [UpdatePolicy](aws-attribute-updatepolicy.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html properties: AssociatePublicIpAddress: description: |+ For Amazon EC2 instances in a VPC, indicates whether instances in the Auto Scaling group receive public IP addresses. If you specify `true`, each instance in the Auto Scaling receives a unique public IP address. Note If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the `DependsOn` attribute to declare a dependency on the VPC-gateway attachment. For more information, see [DependsOn Attribute](aws-attribute-dependson.html). _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement BlockDeviceMappings: description: |+ Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. _Required:_ No _Type_: A list of [BlockDeviceMappings](aws-properties-as-launchconfig-blockdev-mapping.html). _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: A list of BlockDeviceMappings. update_requires: replacement ClassicLinkVPCId: description: |+ The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. You can specify this property only for EC2-Classic instances. For more information, see [ClassicLink](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) in the _Amazon Elastic Compute Cloud User Guide_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement ClassicLinkVPCSecurityGroups: description: |+ The IDs of one or more security groups for the VPC that you specified in the `ClassicLinkVPCId` property. _Required:_ Conditional. If you specified the `ClassicLinkVPCId` property, you must specify this property. _Type_: List of String values _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: List update_requires: replacement EbsOptimized: description: |+ Specifies whether the launch configuration is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. Additional fees are incurred when using EBS-optimized instances. For more information about fees and supported instance types, see [EBS-Optimized Instances](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) in the _Amazon EC2 User Guide for Linux Instances_. _Required:_ No If this property is not specified, "false" is used. _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement IamInstanceProfile: description: |+ Provides 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. _Required:_ No _Type_: String (1–1600 chars) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String (1–1600 chars) update_requires: replacement ImageId: description: |+ Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement InstanceId: description: |+ The ID of the Amazon EC2 instance you want to use to create the launch configuration. Use this property if you want the launch configuration to use settings from an existing Amazon EC2 instance. 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. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement InstanceMonitoring: description: |+ Indicates whether detailed instance monitoring is enabled for the Auto Scaling group. By default, this property is set to `true` (enabled). When detailed monitoring is enabled, Amazon CloudWatch (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 [Monitor Your Auto Scaling Instances](http://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html) in the _Auto Scaling Developer Guide_. _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement InstanceType: description: |+ Specifies the instance type of the EC2 instance. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement KernelId: description: |+ Provides the ID of the kernel associated with the EC2 AMI. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement KeyName: description: |+ Provides the name of the EC2 key pair. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement PlacementTenancy: description: |+ The tenancy of the instance. An instance with a tenancy of `dedicated` runs on single-tenant hardware and can only be launched in a VPC. You must set the value of this parameter to `dedicated` if want to launch dedicated instances in a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default). For more information, see [CreateLaunchConfiguration](http://docs.aws.amazon.com/AutoScaling/latest/APIReference/API_CreateLaunchConfiguration.html) in the _Auto Scaling API Reference_. If you specify this property, you must specify at least one subnet in the VPCZoneIdentifier property of the [AWS::AutoScaling::AutoScalingGroup](aws-properties-as-group.html) resource. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement RamDiskId: description: |+ The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the AWS Resource Center and search for the kernel ID. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement SecurityGroups: description: |+ A list that contains the EC2 security groups to assign to the Amazon EC2 instances in the Auto Scaling group. The list can contain the name of existing EC2 security groups or references to `AWS::EC2::SecurityGroup` resources created in the template. If your instances are launched within VPC, specify Amazon VPC security group IDs. _Required:_ No _Type_: A list of EC2 security groups. _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: A list of EC2 security groups. update_requires: replacement SpotPrice: description: |+ The spot price for this autoscaling group. If a spot price is set, then the autoscaling group will launch when the current spot price is less than the amount specified in the template. When you have specified a spot price for an auto scaling group, the group will only launch when the spot price has been met, regardless of the setting in the autoscaling group's `DesiredCapacity`. For more information about configuring a spot price for an autoscaling group, see [Using Auto Scaling to Launch Spot Instances](http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US-SpotInstances.html) in the _AutoScaling Developer Guide_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) Note When you change your bid price by creating a new launch configuration, running instances will continue to run as long as the bid price for those running instances is higher than the current Spot price. required: 'no' type: String update_requires: replacement UserData: description: |+ The user data available to the launched EC2 instances. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: '' examples: {} AWS::AutoScaling::LifecycleHook: description: Use `AWS::AutoScaling::LifecycleHook` to control the state of an instance in an Auto Scaling group after it is launched or terminated. When you use a lifecycle hook, the Auto Scaling group either pauses the instance after it is launched (before it is put into service) or pauses the instance as it is terminated (before it is fully terminated). For more information, see [Examples of How to Use Lifecycle Hooks](http://docs.aws.amazon.com/autoscaling/latest/userguide/lifecycle-hooks.html) in the _Auto Scaling User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html properties: AutoScalingGroupName: description: |+ The name of the Auto Scaling group for the lifecycle hook. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement DefaultResult: description: |+ The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. Valid values are `CONTINUE` (default) and `ABANDON`. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption HeartbeatTimeout: description: |+ The amount of time that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action that you specified in the DefaultResult property. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption LifecycleTransition: description: |+ The state of the Amazon EC2 instance to which you want to attach the lifecycle hook. For valid values, see the `LifecycleTransition` content for the [LifecycleHook](http://docs.aws.amazon.com/AutoScaling/latest/APIReference/API_LifecycleHook.html) data type in the _Auto Scaling API Reference_. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption NotificationMetadata: description: |+ Additional information that you want to include when Auto Scaling sends a message to the notification target. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption NotificationTargetARN: description: |+ The Amazon resource name (ARN) of the notification target that Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption RoleARN: description: |+ The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. The role requires permissions to Amazon SNS and Amazon SQS. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::AutoScaling::ScalingPolicy: description: |- The `AWS::AutoScaling::ScalingPolicy` resource adds a scaling policy to an auto scaling group. A scaling policy specifies whether to scale the auto scaling group up or down, and by how much. For more information on scaling policies, see [Scaling by Policy](http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/scaling_plan.html#scaling_policies) in the Auto Scaling Developer Guide. You can use a scaling policy together with a CloudWatch alarm. A CloudWatch alarm can automatically initiate actions on your behalf, based on parameters you specify. A scaling policy is one type of action that an alarm can initiate. For a snippet showing how to create an Auto Scaling policy that is triggered by a CloudWatch alarm, see [Auto Scaling Policy Triggered by CloudWatch Alarm](quickref-autoscaling.html#scenario-as-policy). Note that you can only associate one scaling policy with an alarm. This type supports updates. For more information about updating this resource, see [PutScalingPolicy](http://docs.aws.amazon.com/AutoScaling/latest/APIReference/API_PutScalingPolicy.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html properties: AdjustmentType: description: |+ Specifies whether the `ScalingAdjustment` is an absolute number or a percentage of the current capacity. Valid values are `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption AutoScalingGroupName: description: |+ The name or Amazon Resource Name (ARN) of the Auto Scaling Group that you want to attach the policy to. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Cooldown: description: |+ The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start. Do not specify this property if you are using the `StepScaling` policy type. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption EstimatedInstanceWarmup: description: |+ The estimated time, in seconds, until a newly launched instance can send metrics to CloudWatch. By default, Auto Scaling uses the cooldown period, as specified in the `Cooldown` property. Do not specify this property if you are using the `SimpleScaling` policy type. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption MetricAggregationType: description: |+ The aggregation type for the CloudWatch metrics. You can specify `Minimum`, `Maximum`, or `Average`. By default, AWS CloudFormation specifies `Average`. Do not specify this property if you are using the `SimpleScaling` policy type. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption MinAdjustmentMagnitude: description: |+ For the `PercentChangeInCapacity` adjustment type, the minimum number of instances to scale. The scaling policy changes the desired capacity of the Auto Scaling group by a minimum of this many instances. This property replaces the `MinAdjustmentStep` property. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption PolicyType: description: |+ An Auto Scaling policy type. You can specify `SimpleScaling`, `StepScaling`, or `TargetTrackingScaling`. By default, AWS CloudFormation specifies `SimpleScaling`. For more information, see [Scaling Policy Types](http://docs.aws.amazon.com/autoscaling/latest/userguide/as-scale-based-on-demand.html#as-scaling-types) in the _Auto Scaling User Guide_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption ScalingAdjustment: description: |+ The number of instances by which to scale. The `AdjustmentType` property determines if AWS CloudFormation interprets this number as an absolute number (when the `ExactCapacity` value is specified), increase or decrease capacity by a specified number (when the `ChangeInCapacity` value is specified), or increase or decrease capacity as a percentage of the existing Auto Scaling group size (when the `PercentChangeInCapacity` value is specified). A positive value adds to the current capacity and a negative value subtracts from the current capacity. For exact capacity, you must specify a positive value. _Required:_ Conditional. This property is required if the policy type is `SimpleScaling`. This property is not supported with any other policy type. _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: Number update_requires: no_interruption StepAdjustments: description: |+ A set of adjustments that enable you to scale based on the size of the alarm breach. _Required:_ Conditional. This property is required if the policy type is `StepScaling`. This property is not supported with any other policy type. _Type_: List of [Auto Scaling ScalingPolicy StepAdjustments](aws-properties-autoscaling-scalingpolicy-stepadjustments.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: List update_requires: no_interruption TargetTrackingConfiguration: description: |+ Configures a target tracking scaling policy. _Required:_ Conditional. This property is required if the policy type is `TargetTrackingScaling`. This property is not supported with any other policy type. _Type_: [Auto Scaling ScalingPolicy TargetTrackingConfiguration](aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: |- Auto Scaling ScalingPolicy TargetTrackingConfiguration update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::AutoScaling::ScheduledAction: description: "Creates a scheduled scaling action for an Auto Scaling group, changing the number of servers available for your application in response to predictable load changes.\n\nImportant\n\nNote the following:\n\n- \n\nIf you have rolling updates enabled, you must suspend scheduled actions before you can update the Auto Scaling group. You can suspend processes by using the [UpdatePolicy attribute](aws-attribute-updatepolicy.html) for the `AWS::AutoScaling::AutoScalingGroup` resource (recommended), the AWS CLI, or the Auto Scaling API. For more information about suspending scheduled actions, see [Suspending and Resuming Auto Scaling Processes](http://docs.aws.amazon.com/autoscaling/latest/userguide/as-suspend-resume-processes.html) in the _Auto Scaling User Guide_.\n\n- \n\nWhen you update a stack with an Auto Scaling group and scheduled action, AWS CloudFormation always sets the min size, max size, and desired capacity properties of your Auto Scaling group to the values that are defined in the `AWS::AutoScaling::AutoScalingGroup` resource of your template, even if a scheduled action is in effect. However, you might not want AWS CloudFormation to change any of the group size property values, such as when you have a scheduled action in effect. You can use an [UpdatePolicy attribute](aws-attribute-updatepolicy.html) to prevent AWS 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." url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-scheduledaction.html properties: AutoScalingGroupName: description: |+ The name or ARN of the Auto Scaling group. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement DesiredCapacity: description: |+ The number of Amazon EC2 instances that should be running in the Auto Scaling group. At least one of `MaxSize`, `MinSize`, or `DesiredCapacity` must be specified. _Required:_ Conditional _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: Number update_requires: no_interruption EndTime: description: |+ The time in UTC for this schedule to end. For example, `2010-06-01T00:00:00Z`. _Required:_ No _Type_: Time stamp _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Timestamp update_requires: no_interruption MaxSize: description: |+ The maximum number of Amazon EC2 instances in the Auto Scaling group. At least one of `MaxSize`, `MinSize`, or `DesiredCapacity` must be specified. _Required:_ Conditional _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: Number update_requires: no_interruption MinSize: description: |+ The minimum number of Amazon EC2 instances in the Auto Scaling group. At least one of `MaxSize`, `MinSize`, or `DesiredCapacity` must be specified. _Required:_ Conditional _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: Number update_requires: no_interruption Recurrence: description: |+ The time in UTC when recurring future actions will start. You specify the start time by following the Unix cron syntax format. For more information about cron syntax, go to [http://en.wikipedia.org/wiki/Cron](http://en.wikipedia.org/wiki/Cron). Specifying the `StartTime` and `EndTime` properties with `Recurrence` property forms the start and stop boundaries of the recurring action. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption StartTime: description: |+ The time in UTC for this schedule to start. For example, `2010-06-01T00:00:00Z`. _Required:_ No _Type_: Time stamp _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Timestamp update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::Batch::ComputeEnvironment: description: The `AWS::Batch::ComputeEnvironment` resource to define your AWS Batch compute environment. For more information, see [Compute Environments](http://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) in the _AWS Batch User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html properties: Type: description: |+ The type of the compute environment. _Required_: yes _Type_: String _Update requires_: Replacement required: 'yes' type: String update_requires: replacement ServiceRole: description: |+ The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf. _Required_: yes _Type_: String _Update requires_: No Interruption required: 'yes' type: String update_requires: no_interruption ComputeEnvironmentName: description: |+ The name of the compute environment. _Required_: no _Type_: String _Update requires_: Replacement required: 'no' type: String update_requires: replacement ComputeResources: description: |+ The compute resources defined for the compute environment. _Required_: yes _Type_: [AWS Batch ComputeEnvironment ComputeResources](aws-properties-batch-computeenvironment-computeresources.html) _Update requires_: No Interruption required: 'yes' type: |- AWS Batch ComputeEnvironment ComputeResources update_requires: no_interruption State: description: |+ The state of the compute environment. The valid values are `ENABLED` or `DISABLED`. An `ENABLED` state indicates that you can register instances with the compute environment and that the associated instances can accept jobs. _Required_: no _Type_: String _Update requires_: No Interruption required: 'no' type: String update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::Batch::ComputeEnvironment` resource to the intrinsic `Ref` function, the function returns the compute environment ARN, such as `arn:aws:batch:us-east-1:555555555555:compute-environment/M4OnDemand`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Batch::JobDefinition: description: The `AWS::Batch::JobDefinition` resource specifies the parameters for an AWS Batch job definition. For more information, see [Job Definitions](http://docs.aws.amazon.com/batch/latest/userguide/job_definitions.html) in the _AWS Batch User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html properties: Type: description: |+ The type of job definition. _Required_: yes _Type_: String _Update requires_: No Interruption required: 'yes' type: String update_requires: no_interruption Parameters: description: |+ Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. _Required_: yes _Type_: JSON object _Update requires_: No Interruption required: 'yes' type: JSON update_requires: no_interruption JobDefinitionName: description: |+ The name of the job definition. _Required_: no _Type_: String _Update requires_: Replacement required: 'no' type: String update_requires: replacement ContainerProperties: description: |+ An object with various properties specific to container-based jobs. _Required_: yes _Type_: [AWS Batch JobDefinition ContainerProperties](aws-properties-batch-jobdefinition-containerproperties.html) _Update requires_: No Interruption required: 'yes' type: |- AWS Batch JobDefinition ContainerProperties update_requires: no_interruption RetryStrategy: description: |+ The retry strategy to use for failed jobs that are submitted with this job definition. _Required_: no _Type_: [AWS Batch JobDefinition RetryStrategy](aws-properties-batch-jobdefinition-retrystrategy.html) _Update requires_: No Interruption required: 'no' type: |- AWS Batch JobDefinition RetryStrategy update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::Batch::JobDefinition` resource to the intrinsic `Ref` function, the function returns the job definition ARN, such as `arn:aws:batch:us-east-1:111122223333:job-definition/test-gpu:2`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Batch::JobQueue: description: The `AWS::Batch::JobQueue` resource defines your AWS Batch job queue. For more information, see [Job Queues](http://docs.aws.amazon.com/batch/latest/userguide/job_queues.html) in the _AWS Batch User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html properties: ComputeEnvironmentOrder: description: |+ The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order. _Required_: yes _Type_: List of [AWS Batch JobQueue ComputeEnvironmentOrder](aws-properties-batch-jobqueue-computeenvironmentorder.html) _Update requires_: No Interruption required: 'yes' type: List update_requires: no_interruption State: description: |+ The status of the job queue (for example, `CREATING` or `VALID`). _Required_: no _Type_: String _Update requires_: No Interruption required: 'no' type: String update_requires: no_interruption Priority: description: |+ The priority of the job queue. _Required_: yes _Type_: Integer _Update requires_: No Interruption required: 'yes' type: Number update_requires: no_interruption JobQueueName: description: |+ The name of the job queue. _Required_: no _Type_: String _Update requires_: Replacement required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When you pass the logical ID of an `AWS::Batch::JobQueue` resource to the intrinsic `Ref` function, the function returns the job queue ARN, such as `arn:aws:batch:us-east-1:111122223333:job-queue/HighPriority`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::CertificateManager::Certificate: description: |- The `AWS::CertificateManager::Certificate` resource requests an AWS Certificate Manager (ACM) certificate that you can use with AWS services to enable secure connections. For example, you can deploy an ACM certificate to an Elastic Load Balancing load balancer to enable HTTPS support. For more information, see the `RequestCertificate` action in the _AWS Certificate Manager API Reference_. Important When you use the `AWS::CertificateManager::Certificate` resource in an AWS CloudFormation stack, the stack will remain in the `CREATE_IN_PROGRESS` state and any further stack operations will be delayed until you act upon the instructions in the certificate validation email. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html properties: DomainName: description: |+ Fully qualified domain name (FQDN), such as `www.example.com`, of the site that you want to secure with the ACM certificate. To protect several sites in the same domain, use an asterisk (`*`) to specify a wildcard. For example, `*.example.com` protects `www.example.com`, `site.example.com`, and `images.example.com`. For constraints, see the `DomainName` parameter for the [RequestCertificate](http://docs.aws.amazon.com/acm/latest/APIReference/API_RequestCertificate.html) action in the _AWS Certificate Manager API Reference_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement DomainValidationOptions: description: |+ Domain information that domain name registrars use to verify your identity. For more information and the default values, see [Configure Email for Your Domain](http://docs.aws.amazon.com/acm/latest/userguide/setup-email.html) and [Validate Domain Ownership](http://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate.html) in the _AWS Certificate Manager User Guide_. _Required:_ No _Type_: List of [AWS Certificate Manager Certificate DomainValidationOption](aws-properties-certificatemanager-certificate-domainvalidationoption.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement SubjectAlternativeNames: description: |+ FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, you can add `www.example.net` to a certificate for the `www.example.com` domain name so that users can reach your site by using either name. _Required:_ No _Type_: List of String values _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement Tags: description: |+ An arbitrary set of tags (key–value pairs) for this ACM certificate. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the certificate Amazon Resource Name (ARN), such as `arn:aws:acm:us-east-1:123456789012:certificate/12ab3c4d-56789-0ef1-2345-3dab6fa3ee50`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Cloud9::EnvironmentEC2: description: The `AWS::Cloud9::EnvironmentEC2` resource creates an Amazon EC2 development environment in AWS Cloud9. For more information, see [Creating an Environment](http://docs.aws.amazon.com/cloud9/latest/user-guide/create-environment.html) in the _AWS Cloud9 User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html properties: Repositories: description: |+ Any AWS CodeCommit source code repositories to be cloned into the development environment. _Required_: No _Type_: List of [AWS Cloud9 EnvironmentEC2 Repository](aws-properties-cloud9-environmentec2-repository.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption OwnerArn: description: |+ The Amazon Resource Name (ARN) of the environment owner. If this value is not specified, the ARN defaults to this environment's creator. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Description: description: |+ The description of the environment to create. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement AutomaticStopTimeMinutes: description: |+ The number of minutes until the running instance is shut down after the environment has last been used. _Required_: No _Type_: Integer _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Number update_requires: replacement InstanceType: description: |+ The type of instance to host the environment on (for example, `t2.micro`). _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Name: description: |+ The name of the environment to create. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When you pass the logical ID of an `AWS::Cloud9::EnvironmentEC2` resource to the intrinsic `Ref` function, the function returns the ID of the development environment, such as `2bc3642873c342e485f7e0c561234567`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ The Amazon Resource Name (ARN) of the development environment, such as `arn:aws:cloud9:us-east-2:123456789012:environment:2bc3642873c342e485f7e0c561234567`. Name: description: |+ The name of the development environment, such as `my-demo-environment`. examples: {} AWS::CloudFormation::Authentication: description: "Use the AWS::CloudFormation::Authentication resource to specify authentication credentials for files or sources that you specify with the [AWS::CloudFormation::Init](aws-resource-init.html) resource.\n\nTo include authentication information for a file or source that you specify with AWS::CloudFormation::Init, use the `uris` property if the source is a URI or the `buckets` property if the source is an Amazon S3 bucket. For more information about files, see [Files](aws-resource-init.html#aws-resource-init-files). For more information about sources, see [Sources](aws-resource-init.html#aws-resource-init-sources).\n\nYou can also specify authentication information for files directly in the AWS::CloudFormation::Init resource. The files key of the resource contains a property named `authentication`. You can use the `authentication` property to associate authentication information defined in an AWS::CloudFormation::Authentication resource directly with a file.\n\nFor files, AWS CloudFormation looks for authentication information in the following order:\n\n1. \n\nThe `authentication` property of the AWS::CloudFormation::Init `files` key.\n\n2. \n\nThe `uris` or `buckets` property of the AWS::CloudFormation::Authentication resource.\n\nFor sources, AWS CloudFormation looks for authentication information in the `uris` or `buckets` property of the AWS::CloudFormation::Authentication resource." url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-authentication.html properties: accessKeyId: description: |+ Specifies the access key ID for S3 authentication. _Required:_ Conditional Can be specified only if the `type` property is set to `"S3"`. _Type_: String required: conditional type: String update_requires: buckets: description: |+ A comma-delimited list of Amazon S3 buckets to be associated with the S3 authentication credentials. _Required:_ Conditional Can be specified only if the `type` property is set to `"S3"`. _Type_: List of String values required: conditional type: List update_requires: password: description: |+ Specifies the password for basic authentication. _Required:_ Conditional Can be specified only if the type property is set to `"basic"`. _Type_: String required: conditional type: String update_requires: secretKey: description: |+ Specifies the secret key for S3 authentication. _Required:_ Conditional Can be specified only if the `type` property is set to `"S3"`. _Type_: String required: conditional type: String update_requires: type: description: |+ Specifies whether the authentication scheme uses a user name and password ("basic") or an access key ID and secret key ("S3"). If you specify `"basic"`, specify the `username`, `password`, and `uris` properties. If you specify `"S3"`, specify the `accessKeyId`, `secretKey`, and `buckets` (optional) properties. _Required:_ Yes _Type_: String Valid values are "basic" or "S3" required: 'yes' type: String Valid values are "basic" or "S3" update_requires: uris: description: |+ A comma-delimited list of URIs to be associated with the basic authentication credentials. The authorization applies to the specified URIs and any more specific URI. For example, if you specify `http://www.example.com`, the authorization will also apply to `http://www.example.com/test`. _Required:_ Conditional Can be specified only if the `type` property is set to `"basic"`. _Type_: List of String values required: conditional type: List update_requires: username: description: |+ Specifies the user name for basic authentication. _Required:_ Conditional Can be specified only if the type property is set to `"basic"`. _Type_: String required: conditional type: String update_requires: roleName: description: |+ Describes the role for role-based authentication. Important The EC2 instance must be able to access this role using an instance profile. _Required:_ Conditional Can be specified only if the `type` property is set to `"S3"`. _Type_: String. required: conditional type: String. update_requires: return_values: Ref: description: '' examples: {} AWS::CloudFormation::CustomResource: description: |- In an AWS CloudFormation template, you use the `AWS::CloudFormation::CustomResource` or [`Custom::String`](aws-resource-cfn-customresource.html#aws-cfn-resource-type-name) resource type to specify custom resources. Custom resources provide a way for you to write custom provisioning logic in AWS CloudFormation template and have AWS CloudFormation run it during a stack operation, such as when you create, update or delete a stack. For more information, see [Custom Resources](template-custom-resources.html). Note If you use the [VPC endpoint](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-endpoints.html) feature, custom resources in the VPC must have access to AWS CloudFormation-specific Amazon Simple Storage Service (Amazon S3) buckets. Custom resources must send responses to a pre-signed Amazon S3 URL. If they can't send responses to Amazon S3, AWS CloudFormation won't receive a response and the stack operation fails. For more information, see [AWS CloudFormation and VPC Endpoints](cfn-vpce-bucketnames.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html properties: ServiceToken: description: |+ The service token that was given to the template developer by the service provider to access the service, such as an Amazon SNS topic ARN or Lambda function ARN. The service token must be from the same region in which you are creating the stack. _Required:_ Yes _Type_: String _Update requires_: Updates are not supported. required: 'yes' type: String update_requires: return_values: Ref: description: '' examples: {} AWS::CloudFormation::Init: description: |- Use the AWS::CloudFormation::Init type to include metadata on an Amazon EC2 instance for the cfn-init helper script. If your template calls the cfn-init script, the script looks for resource metadata rooted in the AWS::CloudFormation::Init metadata key. For more information about cfn-init, see [cfn-init](cfn-init.html). cfn-init supports all metadata types for Linux systems. It supports metadata types for Windows with conditions that are described in the sections that follow. For an example of using AWS::CloudFormation::Init and the cfn-init helper script, see [Deploying Applications on Amazon EC2 with AWS CloudFormation](deploying.applications.html). For an example that shows how to use cfn-init to create a Windows stack, see [Bootstrapping AWS CloudFormation Windows Stacks](cfn-windows-stacks-bootstrapping.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-init.html properties: {} return_values: Ref: description: '' examples: {} AWS::CloudFormation::Interface: description: |- `AWS::CloudFormation::Interface` is a metadata key that defines how parameters are grouped and sorted in the AWS CloudFormation console. When you create or update stacks in the console, the console lists input parameters in alphabetical order by their logical IDs. By using this key, you can define your own parameter grouping and ordering so that users can efficiently specify parameter values. For example, you could group all EC2-related parameters in one group and all VPC-related parameters in another group. In addition to grouping and ordering parameters, you can define labels for parameters. A label is a friendly name or description that the console displays instead of a parameter's logical ID. Labels are useful for helping users understand the values to specify for each parameter. For example, you could label a `KeyPair` parameter `Select an EC2 key pair`. Note Only the AWS CloudFormation console uses the `AWS::CloudFormation::Interface` metadata key. AWS CloudFormation CLI and API calls do not use this key. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-interface.html properties: ParameterGroups: description: |+ A list of parameter group types, where you specify group names, the parameters in each group, and the order in which the parameters are shown. _Required:_ No _Type_: [AWS CloudFormation Interface ParameterGroup](aws-properties-cloudformation-interface-parametergroup.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- AWS CloudFormation Interface ParameterGroup update_requires: no_interruption ParameterLabels: description: |+ A mapping of parameters and their friendly names that the AWS CloudFormation console shows when a stack is created or updated. _Required:_ No _Type_: [AWS CloudFormation Interface ParameterLabel](aws-properties-cloudformation-interface-parameterlabel.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- AWS CloudFormation Interface ParameterLabel update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::CloudFormation::Stack: description: |- The `AWS::CloudFormation::Stack` type nests a stack as a resource in a top-level template. You can add output values from a nested stack within the containing template. You use the [GetAtt](intrinsic-function-reference-getatt.html) function with the nested stack's logical name and the name of the output value in the nested stack in the format `Outputs.NestedStackOutputName`. Important We strongly recommend that updates to nested stacks are run from the parent stack. When you apply template changes to update a top-level stack, AWS CloudFormation updates the top-level stack and initiates an update to its nested stacks. AWS CloudFormation updates the resources of modified nested stacks, but does not update the resources of unmodified nested stacks. For more information, see [AWS CloudFormation Stacks Updates](using-cfn-updating-stacks.html). Note You must acknowledge IAM capabilities for nested stacks that contain IAM resources. Also, verify that you have cancel update stack permissions, which is required if an update rolls back. For more information about IAM and AWS CloudFormation, see [Controlling Access with AWS Identity and Access Management](using-iam-template.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html properties: NotificationARNs: description: |+ A list of existing Amazon SNS topics where notifications about stack events are sent. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Parameters: description: |+ The set of parameters passed to AWS CloudFormation when this nested stack is created. Note If you use the `Ref` function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type `String`. In other words, you cannot pass values that are of type `CommaDelimitedList` to nested stacks. _Required_: Conditional (required if the nested stack requires input parameters). _Type_: [AWS CloudFormation Stack Parameters](aws-properties-stack-parameters.html) _Update requires_: Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced. required: conditional type: AWS CloudFormation Stack Parameters update_requires: Tags: description: |+ An arbitrary set of tags (key–value pairs) to describe this stack. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption TemplateURL: description: |+ The URL of a template that specifies the stack that you want to create as a resource. The template must be stored on an Amazon S3 bucket, so the URL must have the form: `https://s3.amazonaws.com/.../TemplateName.template` _Required:_ Yes _Type_: String _Update requires_: Whether an update causes interruptions depends on the resources that are being update. An update never causes a nested stack to be replaced. required: 'yes' type: String update_requires: TimeoutInMinutes: description: |+ The length of time, in minutes, that AWS CloudFormation waits for the nested stack to reach the `CREATE_COMPLETE` state. The default is no timeout. When AWS CloudFormation detects that the nested stack has reached the `CREATE_COMPLETE` state, it marks the nested stack resource as `CREATE_COMPLETE` in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches `CREATE_COMPLETE`, AWS CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack. _Required:_ No _Type_: Integer _Update requires_: Updates are not supported. required: 'no' type: Number update_requires: return_values: Ref: description: |- For `AWS::CloudFormation::Stack`, `Ref` returns the Stack ID. For example: `arn:aws:cloudformation:``us-east-2``:123456789012:stack/mystack-mynestedstack-sggfrhxhum7w/f449b250-b969-11e0-a185-5081d0136786` For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Outputs.NestedStackOutputName: description: |+ _Returns_: The output value from the specified nested stack where _`NestedStackOutputName`_ is the name of the output value. examples: {} AWS::CloudFormation::WaitCondition: description: "Important\n\nFor Amazon EC2 and Auto Scaling resources, we recommend that you use a CreationPolicy attribute instead of wait conditions. Add a CreationPolicy attribute to those resources, and use the cfn-signal helper script to signal when an instance creation process has completed successfully.\n\nYou can use a wait condition for situations like the following:\n\n- \n\nTo coordinate stack resource creation with configuration actions that are external to the stack creation\n\n- \n\nTo track the status of a configuration process\n\nFor these situations, we recommend that you associate a [CreationPolicy](aws-attribute-creationpolicy.html) attribute with the wait condition so that you don't have to use a wait condition handle. For more information and an example, see [Creating Wait Conditions in a Template](using-cfn-waitcondition.html). If you use a CreationPolicy with a wait condition, do not specify any of the wait condition's properties.\n\nNote\n\nIf you use the [VPC endpoint](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-endpoints.html) feature, resources in the VPC that respond to wait conditions must have access to AWS CloudFormation-specific Amazon Simple Storage Service (Amazon S3) buckets. Resources must send wait condition responses to a pre-signed Amazon S3 URL. If they can't send responses to Amazon S3, AWS CloudFormation won't receive a response and the stack operation fails. For more information, see [AWS CloudFormation and VPC Endpoints](cfn-vpce-bucketnames.html)." url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html properties: Count: description: |+ The number of success signals that AWS CloudFormation must receive before it continues the stack creation process. When the wait condition receives the requisite number of success signals, AWS CloudFormation resumes the creation of the stack. If the wait condition does not receive the specified number of success signals before the Timeout period expires, AWS CloudFormation assumes that the wait condition has failed and rolls the stack back. _Required:_ No _Type_: Integer _Update requires_: Updates are not supported. required: 'no' type: Number update_requires: Handle: description: |+ A reference to the wait condition handle used to signal this wait condition. Use the `Ref` intrinsic function to specify an [AWS::CloudFormation::WaitConditionHandle](aws-properties-waitconditionhandle.html) resource. Anytime you add a WaitCondition resource during a stack update, you must associate the wait condition with a new WaitConditionHandle resource. Do not reuse an old wait condition handle that has already been defined in the template. If you reuse a wait condition handle, the wait condition might evaluate old signals from a previous create or update stack command. _Required:_ Yes _Type_: String _Update requires_: Updates are not supported. required: 'yes' type: String update_requires: Timeout: description: |+ The length of time (in seconds) to wait for the number of signals that the `Count` property specifies. `Timeout` is a minimum-bound property, meaning the timeout occurs no sooner than the time you specify, but can occur shortly thereafter. The maximum time that can be specified for this property is 12 hours (43200 seconds). _Required:_ Yes _Type_: String _Update requires_: Updates are not supported. required: 'yes' type: String update_requires: return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Data: description: |+ _Returns_: A JSON object that contains the `UniqueId` and `Data` values from the wait condition signal(s) for the specified wait condition. For more information about wait condition signals, see [Wait Condition Signal JSON Format](using-cfn-waitcondition.html#using-cfn-waitcondition-signaljson). Example return value for a wait condition with 2 signals: Copy { "Signal1" : "Step 1 complete." , "Signal2" : "Step 2 complete." } examples: {} AWS::CloudFormation::WaitConditionHandle: description: |- Important For Amazon EC2 and Auto Scaling resources, we recommend that you use a CreationPolicy attribute instead of wait conditions. Add a CreationPolicy attribute to those resources, and use the cfn-signal helper script to signal when an instance creation process has completed successfully. For more information, see [Deploying Applications on Amazon EC2 with AWS CloudFormation](deploying.applications.html). The AWS::CloudFormation::WaitConditionHandle type has no properties. When you reference the WaitConditionHandle resource by using the `Ref` function, AWS CloudFormation returns a presigned URL. You pass this URL to applications or scripts that are running on your Amazon EC2 instances to send signals to that URL. An associated [AWS::CloudFormation::WaitCondition](aws-properties-waitcondition.html) resource checks the URL for the required number of success signals or for a failure signal. Important Anytime you add a `WaitCondition` resource during a stack update or update a resource with a wait condition, you must associate the wait condition with a new `WaitConditionHandle` resource. Do not reuse an old wait condition handle that has already been defined in the template. If you reuse a wait condition handle, the wait condition might evaluate old signals from a previous create or update stack command. Note Updates are not supported for this resource. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitconditionhandle.html properties: {} return_values: Ref: description: '' examples: {} AWS::CloudFront::Distribution: description: Creates an Amazon CloudFront web distribution. For general information about CloudFront distributions, see the [Introduction to Amazon CloudFront](http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Introduction.html) in the _Amazon CloudFront Developer Guide_. For specific information about creating CloudFront web distributions, see [CreateDistribution](http://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CreateDistribution.html) in the _Amazon CloudFront API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution.html properties: DistributionConfig: description: |+ The distribution's configuration information. _Required:_ Yes _Type_: [DistributionConfig](aws-properties-cloudfront-distributionconfig.html) type _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: DistributionConfig type update_requires: no_interruption Tags: description: |+ An arbitrary set of tags (key–value pairs) to associate with a CloudFront distribution. _Required_: No _Type_: List of _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) Duplicates not allowed. required: 'no' type: List of update_requires: no_interruption return_values: Ref: description: |- _Returns_: The CloudFront distribution ID. For example: `E27LVI50CSW06W`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). DomainName: description: |+ _Returns_: The domain name of the resource. For example: `d2fadu0nynjpfn.cloudfront.net`. examples: {} AWS::CloudFront::CloudFrontOriginAccessIdentity: description: The `AWS::CloudFront::CloudFrontOriginAccessIdentity` resource specifies the CloudFront origin access identity to associate with the origin of a CloudFront distribution. For more information, see [OriginAccessIdentity](http://docs.aws.amazon.com/cloudfront/latest/APIReference/API_S3OriginConfig.html#cloudfront-Type-S3OriginConfig-OriginAccessIdentity) in the _Amazon CloudFront API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cloudfrontoriginaccessidentity.html properties: CloudFrontOriginAccessIdentityConfig: description: |+ The configuration of the CloudFront origin access identity. _Required_: Yes _Type_: [CloudFrontOriginAccessIdentityConfig](aws-properties-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: CloudFrontOriginAccessIdentityConfig update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::CloudFront::CloudFrontOriginAccessIdentity` resource to the intrinsic `Ref` function, the function returns the origin access identity, such as `E15MNIMTCFKK4C`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). S3CanonicalUserId: description: |+ The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3. For example: `b970b42360b81c8ddbd79d2f5df0069ba9033c8a79655752abe380cd6d63ba8bcf23384d568fcf89fc49700b5e11a0fd`. examples: {} AWS::CloudFront::StreamingDistribution: description: The `AWS::CloudFront::StreamingDistribution` resource specifies an RMTP distribution for Amazon CloudFront. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP. For more information, see [CreateStreamingDistribution](http://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CreateStreamingDistribution.html) in the _Amazon CloudFront API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-streamingdistribution.html properties: StreamingDistributionConfig: description: |+ Information about the configuration of the RMTP streaming distribution. _Required_: Yes _Type_: [CloudFront StreamingDistribution StreamingDistributionConfig](aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: CloudFront StreamingDistribution StreamingDistributionConfig update_requires: no_interruption Tags: description: |+ Key-value tags to assign to this streaming distribution. _Required_: Yes _Type_: List of [CloudFront StreamingDistribution Tag](aws-properties-cloudfront-streamingdistribution-tag.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) Duplicates not allowed. required: 'yes' type: List update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::CloudFront::StreamingDistribution` resource to the intrinsic `Ref` function, the function returns the streaming distribution ID, such as `E1E7FEN9T35R9W`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). DomainName: description: |+ The domain name of the resource, such as `sct27g85mgx04.cloudfront.net`. examples: {} AWS::CloudTrail::Trail: description: Use the `AWS::CloudTrail::Trail` resource to create a trail and specify where logs are published. An AWS CloudTrail (CloudTrail) trail can capture AWS API calls made by your AWS account and publish the logs to an Amazon S3 bucket. For more information, see [What is AWS CloudTrail?](http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html) in the _AWS CloudTrail User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html properties: CloudWatchLogsLogGroupArn: description: |+ The Amazon Resource Name (ARN) of a log group to which CloudTrail logs will be delivered. _Required:_ Conditional. This property is required if you specify the `CloudWatchLogsRoleArn` property. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption CloudWatchLogsRoleArn: description: |+ The role ARN that Amazon CloudWatch Logs (CloudWatch Logs) assumes to write logs to a log group. For more information, see [Role Policy Document for CloudTrail to Use CloudWatch Logs for Monitoring](http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-required-policy-for-cloudwatch-logs.html) in the _AWS CloudTrail User Guide_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption EnableLogFileValidation: description: |+ Indicates whether CloudTrail validates the integrity of log files. By default, AWS CloudFormation sets this value to `false`. When you disable log file integrity validation, CloudTrail stops creating digest files. For more information, see [CreateTrail](http://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_CreateTrail.html) in the _AWS CloudTrail API Reference_. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption EventSelectors: description: |+ Configures logging for management and data events. _Required:_ No _Type_: List of [CloudTrail Trail EventSelector](aws-properties-cloudtrail-trail-eventselector.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption IncludeGlobalServiceEvents: description: |+ Indicates whether the trail is publishing events from global services, such as IAM, to the log files. By default, AWS CloudFormation sets this value to `false`. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption IsLogging: description: |+ Indicates whether the CloudTrail trail is currently logging AWS API calls. _Required:_ Yes _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Boolean update_requires: no_interruption IsMultiRegionTrail: description: |+ Indicates whether the CloudTrail trail is created in the region in which you create the stack (`false`) or in all regions (`true`). By default, AWS CloudFormation sets this value to `false`. For more information, see [How Does CloudTrail Behave Regionally and Globally?](http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-regional-and-global-services) in the _AWS CloudTrail User Guide_. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption KMSKeyId: description: |+ The AWS Key Management Service (AWS KMS) key ID that you want to use to encrypt CloudTrail logs. You can specify an alias name (prefixed with `alias/`), an alias ARN, a key ARN, or a globally unique identifier. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption S3BucketName: description: |+ The name of the Amazon S3 bucket where CloudTrail publishes log files. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption S3KeyPrefix: description: |+ An Amazon S3 object key prefix that precedes the name of all log files. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption SnsTopicName: description: |+ The name of an Amazon SNS topic that is notified when new log files are published. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Tags: description: |+ An arbitrary set of tags (key–value pairs) for this trail. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption TrailName: description: |+ The name of the trail. For constraint information, see [CreateTrail](http://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_CreateTrail.html) in the _AWS CloudTrail API Reference_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ The ARN of the CloudTrail trail, such as `arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail`. SnsTopicArn: description: |+ The ARN of the Amazon SNS topic that's associated with the CloudTrail trail, such as `arn:aws:sns:us-east-2:123456789012:mySNSTopic`. examples: {} AWS::CloudWatch::Alarm: description: |- The `AWS::CloudWatch::Alarm` type creates a CloudWatch alarm. This type supports updates. For more information about updating this resource, see [PutMetricAlarm](http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html). For more information about updating stacks, see [AWS CloudFormation Stacks Updates](using-cfn-updating-stacks.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html properties: ActionsEnabled: description: |+ Indicates whether actions should be executed during changes to the CloudWatch alarm's state. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption AlarmActions: description: |+ The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the _Amazon CloudWatch API Reference_ and [Creating Amazon CloudWatch Alarms](http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/AlarmThatSendsEmail.html) in the _Amazon CloudWatch User Guide_. Note For Auto Scaling scaling polices, you can specify only one policy. If you associate more than one policy, Amazon CloudWatch executes only the first scaling policy. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption AlarmDescription: description: |+ The description of the alarm. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption AlarmName: description: |+ A name for the alarm. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the alarm name. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement ComparisonOperator: description: |+ The arithmetic operation to use when comparing the specified `Statistic` and `Threshold`. AWS CloudFormation uses the value of `Statistic` as the first operand. You can specify the following values: `GreaterThanOrEqualToThreshold` , `GreaterThanThreshold`, `LessThanThreshold`, or `LessThanOrEqualToThreshold`. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Dimensions: description: |+ The dimensions of the metric for the alarm. _Required:_ No _Type_: List of [Metric Dimension](aws-properties-cw-dimension.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption EvaluateLowSampleCountPercentile: description: |+ Used only for alarms that are based on percentiles. Specifies whether to evaluate the data and potentially change the alarm state if there are too few data points to be statistically significant. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption EvaluationPeriods: description: |+ The number of periods over which data is compared to the specified threshold. _Required:_ Yes _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Number update_requires: no_interruption ExtendedStatistic: description: |+ The percentile statistic for the metric. Specify a value between p0.0 and p100. _Required:_ Conditional. You must specify either the `ExtendedStatistic` or the `Statistic` property. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption InsufficientDataActions: description: |+ The list of actions to execute when this alarm transitions into an INSUFFICIENT\_DATA state. Specify each action as an Amazon Resource Number (ARN). Currently, the only action supported is publishing to an Amazon SNS topic or an Auto Scaling policy. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption MetricName: description: |+ The name of the metric associated with the alarm. For more information about the metrics that you can specify, see [Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference](http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html) in the _Amazon CloudWatch User Guide_. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Namespace: description: |+ The namespace of the metric that is associated with the alarm. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption OKActions: description: |+ The list of actions to execute when this alarm transitions into an OK state. Specify each action as an Amazon Resource Number (ARN). Currently, the only action supported is publishing to an SNS topic or an Auto Scaling policy. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Period: description: |+ The time over which the specified statistic is applied. Specify time in seconds, in multiples of 60. _Required:_ Yes _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Number update_requires: no_interruption Statistic: description: |+ The statistic to apply to the alarm's associated metric. You can specify the following values: `SampleCount`, `Average`, `Sum`, `Minimum`, or `Maximum`. _Required:_ Conditional. You must specify either the `ExtendedStatistic` or the `Statistic` property. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption Threshold: description: |+ The value against which the specified statistic is compared. _Required:_ Yes _Type_: Double _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Double update_requires: no_interruption TreatMissingData: description: |+ Sets how this alarm is to handle missing data points. If `TreatMissingData` is omitted, the default behavior of `missing` is used. For more information, see [PutMetricAlarm](http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the _Amazon CloudWatch API Reference_ and [Configuring How CloudWatch Alarms Treats Missing Data](http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the _Amazon CloudWatch User Guide_. _Valid values_: `breaching`, `notBreaching`, `ignore`, `missing` _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Unit: description: |+ The unit for the metric that is associated with the alarm. You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes , Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits,| Percent , Count,Bytes/Second , Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second , Bits/Second, Kilobits/Second , Megabits/Second , Gigabits/Second , Terabits/Second, Count/Second , or None. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: |- When you specify an `AWS::CloudWatch::Alarm` type as an argument to the `Ref` function, AWS CloudFormation returns the value of the `AlarmName`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ The Amazon Resource Name (ARN) of the CloudWatch alarm, such as `arn:aws:cloudwatch:us-east-2:123456789012:alarm:myCloudWatchAlarm-CPUAlarm-UXMMZK36R55Z`. examples: {} AWS::CloudWatch::Dashboard: description: |- The `AWS::CloudWatch::Dashboard` resource creates an Amazon CloudWatch dashboard. A dashboard is a customizable home page in the CloudWatch console that you can use to monitor your AWS resources in a single view. Each metric, graph, alarm, or text block on a dashboard is called a widget. This resource supports updates. For more information about updating this resource, see [PutDashboard](http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutDashboard.html) in the _Amazon CloudWatch API Reference_. For more information about updating stacks, see [AWS CloudFormation Stacks Updates](using-cfn-updating-stacks.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dashboard.html properties: DashboardName: description: |+ A name for the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement DashboardBody: description: |+ A JSON string that defines the widgets contained in the dashboard and their location. For information about how to format this string, see [Dashboard Body Structure and Syntax](http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html). _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption return_values: Ref: description: |- When you specify an `AWS::CloudWatch::Dashboard` resource as an argument to the `Ref` function, AWS CloudFormation returns the value of the `Name`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::CodeBuild::Project: description: The `AWS::CodeBuild::Project` resource configures how AWS CodeBuild builds your source code. For example, it tells AWS CodeBuild where to get the source code and which build environment to use. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html properties: Artifacts: description: |+ The output settings for artifacts that the project generates during a build. _Required:_ Yes _Type_: [AWS CodeBuild Project Artifacts](aws-properties-codebuild-project-artifacts.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: AWS CodeBuild Project Artifacts update_requires: no_interruption BadgeEnabled: description: |+ Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge. For more information, see [Build Badges Sample](http://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-badges.html) in the _AWS CodeBuild User Guide_. _Required_: No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption Cache: description: |+ Settings that AWS CodeBuild uses to store and reuse build dependencies. _Required_: No _Type_: [AWS CodeBuild Project ProjectCache](aws-properties-codebuild-project-projectcache.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CodeBuild Project ProjectCache update_requires: no_interruption Description: description: |+ A description of the project. Use the description to identify the purpose of the project. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption EncryptionKey: description: |+ The alias or Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that AWS CodeBuild uses to encrypt the build output. If you don't specify a value, AWS CodeBuild uses the AWS-managed CMK for Amazon Simple Storage Service. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Environment: description: |+ The build environment settings for the project, such as the environment type or the environment variables to use for the build environment. _Required:_ Yes _Type_: [AWS CodeBuild Project Environment](aws-properties-codebuild-project-environment.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: AWS CodeBuild Project Environment update_requires: no_interruption Name: description: |+ A name for the project. The name must be unique across all of the projects in your AWS account. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement ServiceRole: description: |+ The ARN of the service role that AWS CodeBuild uses to interact with services on your behalf. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Source: description: |+ The source code settings for the project, such as the source code's repository type and location. _Required:_ Yes _Type_: [AWS CodeBuild Project Source](aws-properties-codebuild-project-source.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: AWS CodeBuild Project Source update_requires: no_interruption Tags: description: |+ An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption TimeoutInMinutes: description: |+ The number of minutes after which AWS CodeBuild stops the build if it's not complete. For valid values, see the [`timeoutInMinutes`](http://docs.aws.amazon.com/codebuild/latest/userguide/create-project.html#create-project-cli) field in the _AWS CodeBuild User Guide_. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption VpcConfig: description: |+ Settings that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see [Use AWS CodeBuild with Amazon Virtual Private Cloud](http://docs.aws.amazon.com/codebuild/latest/userguide/vpc-support.html) in the _AWS CodeBuild User Guide_. _Required_: No _Type_: [AWS CodeBuild Project VpcConfig](aws-properties-codebuild-project-vpcconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CodeBuild Project VpcConfig update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the name of the AWS CodeBuild project, such as `myProjectName`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ The ARN of the AWS CodeBuild project, such as `arn:aws:codebuild:us-west-2:123456789012:project/myProjectName`. examples: {} AWS::CodeCommit::Repository: description: The `AWS::CodeCommit::Repository` resource creates an AWS CodeCommit repository that is hosted by Amazon Web Services. For more information, see [Create an AWS CodeCommit Repository](http://docs.aws.amazon.com/codecommit/latest/userguide/how-to-create-repository.html) in the _AWS CodeCommit User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html properties: RepositoryDescription: description: |+ A description about the AWS CodeCommit repository. For constraints, see the [CreateRepository](http://docs.aws.amazon.com/codecommit/latest/APIReference/API_CreateRepository.html) action in the _AWS CodeCommit API Reference_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption RepositoryName: description: |+ A name for the AWS CodeCommit repository. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Triggers: description: |+ Defines the actions to take in response to events that occur in the repository. For example, you can send email notifications when someone pushes to the repository. _Required:_ No _Type_: List of [AWS CodeCommit Repository Trigger](aws-properties-codecommit-repository-triggers.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the repository ID, such as `12a345b6-bbb7-4bb6-90b0-8c9577a2d2b9`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ The Amazon Resource Name (ARN) of the repository, such as `arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo`. CloneUrlHttp: description: |+ The URL to use for cloning the repository over HTTPS, such as `https://codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo`. CloneUrlSsh: description: |+ The URL to use for cloning the repository over SSH, such as `ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos//v1/repos/MyDemoRepo`. Name: description: |+ The name of the repository, such `MyDemoRepo`. examples: {} AWS::CodeDeploy::Application: description: The `AWS::CodeDeploy::Application` resource creates an AWS CodeDeploy application. In AWS CodeDeploy, an application is a name that functions as a container to ensure that the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment. You can use the `AWS::CodeDeploy::DeploymentGroup` resource to associate the application with an AWS CodeDeploy deployment group. For more information, see [AWS CodeDeploy Deployments](http://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-steps.html) in the _AWS CodeDeploy User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html properties: ApplicationName: description: |+ A name for the application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name. For more information, see [Name Type](aws-properties-name.html). _Required_: No _Type_: String _Update requires_: Updates are not supported. required: 'no' type: String update_requires: ComputePlatform: description: |+ The compute platform that AWS CodeDeploy deploys the application to. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When you pass the logical ID of an `AWS::CodeDeploy::Application` resource to the intrinsic `Ref` function, the function returns the application name, such as `myapplication-a123d0d1`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::CodeDeploy::DeploymentConfig: description: The `AWS::CodeDeploy::DeploymentConfig` resource creates a set of deployment rules, deployment success conditions, and deployment failure conditions that AWS CodeDeploy uses during a deployment. The deployment configuration specifies, through the use of a `MinimumHealthyHosts` value, the number or percentage of instances that must remain available at any time during a deployment. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html properties: DeploymentConfigName: description: |+ A name for the deployment configuration. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment configuration name. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement MinimumHealthyHosts: description: |+ The minimum number of healthy instances that must be available at any time during an AWS CodeDeploy deployment. For example, for a fleet of nine instances, if you specify a minimum of six healthy instances, AWS CodeDeploy deploys your application up to three instances at a time so that you always have six healthy instances. The deployment succeeds if your application successfully deploys to six or more instances; otherwise, the deployment fails. For more information about instance health, see [AWS CodeDeploy Instance Health](http://docs.aws.amazon.com/codedeploy/latest/userguide/host-health.html) in the _AWS CodeDeploy User Guide_. _Required:_ Yes _Type_: [AWS CodeDeploy DeploymentConfig MinimumHealthyHosts](aws-properties-codedeploy-deploymentconfig-minimumhealthyhosts.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: |- AWS CodeDeploy DeploymentConfig MinimumHealthyHosts update_requires: replacement return_values: Ref: description: |- When you pass the logical ID of an `AWS::CodeDeploy::DeploymentConfig` resource to the intrinsic `Ref` function, the function returns the deployment configuration name, such as `mydeploymentconfig-a123d0d1`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::CodeDeploy::DeploymentGroup: description: The `AWS::CodeDeploy::DeploymentGroup` resource creates an AWS CodeDeploy deployment group that specifies which instances your application revisions are deployed to, along with other deployment options. For more information, see [CreateDeploymentGroup](http://docs.aws.amazon.com//codedeploy/latest/APIReference/API_CreateDeploymentGroup.html) in the _AWS CodeDeploy API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html properties: AlarmConfiguration: description: |+ Information about the Amazon CloudWatch alarms that are associated with the deployment group. _Required:_ No _Type_: [AWS CodeDeploy DeploymentGroup AlarmConfiguration](aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CodeDeploy DeploymentGroup AlarmConfiguration update_requires: no_interruption ApplicationName: description: |+ The name of an existing AWS CodeDeploy application to associate this deployment group with. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement AutoRollbackConfiguration: description: |+ Information about the automatic rollback configuration that is associated with the deployment group. If you specify this property, don't specify the `Deployment` property. _Required_: No _Type_: [AWS CodeDeploy DeploymentGroup AutoRollbackConfiguration](aws-properties-codedeploy-deploymentgroup-autorollbackconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CodeDeploy DeploymentGroup AutoRollbackConfiguration update_requires: no_interruption AutoScalingGroups: description: |+ A list of associated Auto Scaling groups that AWS CodeDeploy automatically deploys revisions to when new instances are created. Duplicates are not allowed. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Deployment: description: |+ The application revision to deploy to this deployment group. If you specify this property, your target application revision will be deployed as soon as the provisioning process is complete. If you specify this property, don't specify the `AutoRollbackConfiguration` property. _Required:_ No _Type_: [AWS CodeDeploy DeploymentGroup Deployment](aws-properties-codedeploy-deploymentgroup-deployment.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- AWS CodeDeploy DeploymentGroup Deployment update_requires: no_interruption DeploymentConfigName: description: |+ A deployment configuration name or a predefined configuration name. With predefined configurations, you can deploy application revisions to one instance at a time, half of the instances at a time, or all the instances at once. For more information and valid values, see [Working with Deployment Configurations](http://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html) in the _AWS CodeDeploy User Guide_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption DeploymentGroupName: description: |+ A name for the deployment group. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment group name. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement DeploymentStyle: description: |+ Attributes that determine the type of deployment to run and whether to route deployment traffic behind a load balancer. If you specify this property with a blue/green deployment type, don't specify the `AutoScalingGroups`, `LoadBalancerInfo`, or `Deployment` properties. Note For blue/green deployments, AWS CloudFormation supports deployments on AWS Lambda compute platforms only. _Required_: No _Type_: [AWS CodeDeploy DeploymentGroup DeploymentStyle](aws-properties-codedeploy-deploymentgroup-deploymentstyle.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CodeDeploy DeploymentGroup DeploymentStyle update_requires: no_interruption Ec2TagFilters: description: |+ The EC2 tags that are already applied to EC2 instances that you want to include in the deployment group. AWS CodeDeploy includes all EC2 instances identified by any of the tags you specify in this deployment group. Duplicates are not allowed. _Required:_ No _Type_: List of [AWS CodeDeploy DeploymentGroup Ec2TagFilters](aws-properties-codedeploy-deploymentgroup-ec2tagfilters.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption LoadBalancerInfo: description: |+ Information about the load balancer used in the deployment. For more information, see [Integrating AWS CodeDeploy with Elastic Load Balancing](http://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-elastic-load-balancing.html) in the _AWS CodeDeploy User Guide_. _Required_: No _Type_: [AWS CodeDeploy DeploymentGroup LoadBalancerInfo](aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CodeDeploy DeploymentGroup LoadBalancerInfo update_requires: no_interruption OnPremisesInstanceTagFilters: description: |+ The on-premises instance tags already applied to on-premises instances that you want to include in the deployment group. AWS CodeDeploy includes all on-premises instances identified by any of the tags you specify in this deployment group. To register on-premises instances with AWS CodeDeploy, see [Working with On-Premises Instances for AWS CodeDeploy](http://docs.aws.amazon.com/codedeploy/latest/userguide/instances-on-premises.html) in the _AWS CodeDeploy User Guide_. Duplicates are not allowed. _Required:_ No _Type_: List of [AWS CodeDeploy DeploymentGroup OnPremisesInstanceTagFilters](aws-properties-codedeploy-deploymentgroup-onpremisesinstancetagfilters.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption ServiceRoleArn: description: |+ A service role Amazon Resource Name (ARN) that grants AWS CodeDeploy permission to make calls to AWS services on your behalf. For more information, see [Create a Service Role for AWS CodeDeploy](http://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-create-service-role.html) in the _AWS CodeDeploy User Guide._ Note In some cases, you might need to add a dependency on the service role's policy. For more information, see IAM role policy in [DependsOn Attribute](aws-attribute-dependson.html). _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption TriggerConfigurations: description: |+ Information about the notification triggers for the deployment group. Duplicates are not allowed. _Required:_ No _Type_: List of [AWS CodeDeploy DeploymentGroup TriggerConfig](aws-properties-codedeploy-deploymentgroup-triggerconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::CodeDeploy::DeploymentGroup` resource to the intrinsic `Ref` function, the function returns the deployment group name, such as `mydeploymentgroup-a123d0d1`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::CodePipeline::CustomActionType: description: The `AWS::CodePipeline::CustomActionType` resource creates a custom action for activities that aren't included in the AWS CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a [pipeline](aws-resource-codepipeline-pipeline.html). For more information, see [Create and Add a Custom Action in AWS CodePipeline](http://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html) in the _AWS CodePipeline User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html properties: Category: description: |+ The category of the custom action, such as a source action or a build action. For valid values, see [CreateCustomActionType](http://docs.aws.amazon.com/codepipeline/latest/APIReference/API_CreateCustomActionType.html) in the _AWS CodePipeline API Reference_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement ConfigurationProperties: description: |+ The configuration properties for the custom action. _Required:_ No _Type_: List of [AWS CodePipeline CustomActionType ConfigurationProperties](aws-resource-codepipeline-customactiontype-configurationproperties.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement InputArtifactDetails: description: |+ The input artifact details for this custom action. _Required:_ Yes _Type_: [AWS CodePipeline CustomActionType ArtifactDetails](aws-resource-codepipeline-customactiontype-artifactdetails.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: |- AWS CodePipeline CustomActionType ArtifactDetails update_requires: replacement OutputArtifactDetails: description: |+ The output artifact details for this custom action. _Required:_ Yes _Type_: [AWS CodePipeline CustomActionType ArtifactDetails](aws-resource-codepipeline-customactiontype-artifactdetails.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: |- AWS CodePipeline CustomActionType ArtifactDetails update_requires: replacement Provider: description: |+ The name of the service provider that AWS CodePipeline uses for this custom action. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Settings: description: |+ URLs that provide users information about this custom action. _Required:_ No _Type_: [AWS CodePipeline CustomActionType Settings](aws-resource-codepipeline-customactiontype-settings.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: |- AWS CodePipeline CustomActionType Settings update_requires: replacement Version: description: |+ The version number of this custom action. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When you pass the logical ID of an `AWS::CodePipeline::CustomActionType` resource to the intrinsic `Ref` function, the function returns the custom action name, such as `custo-MyCus-A1BCDEFGHIJ2`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::CodePipeline::Pipeline: description: The `AWS::CodePipeline::Pipeline` resource creates an AWS CodePipeline pipeline that describes how software changes go through a release process. For more information, see [What Is AWS CodePipeline?](http://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html) in the _AWS CodePipeline User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html properties: ArtifactStore: description: |+ The Amazon Simple Storage Service (Amazon S3) location where AWS CodePipeline stores pipeline artifacts. For more information, see [Create an Amazon S3 Bucket for Your Application](http://docs.aws.amazon.com/codepipeline/latest/userguide/getting-started-w.html) in the _AWS CodePipeline User Guide_. _Required:_ Yes _Type_: [AWS CodePipeline Pipeline ArtifactStore](aws-properties-codepipeline-pipeline-artifactstore.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: |- AWS CodePipeline Pipeline ArtifactStore update_requires: no_interruption DisableInboundStageTransitions: description: |+ Prevents artifacts in a pipeline from transitioning to the stage that you specified. This enables you to manually control transitions. _Required:_ No _Type_: List of [AWS CodePipeline Pipeline DisableInboundStageTransitions](aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Name: description: |+ The name of your AWS CodePipeline pipeline. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement RestartExecutionOnUpdate: description: |+ Indicates whether to rerun the AWS CodePipeline pipeline after you update it. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption RoleArn: description: |+ A service role Amazon Resource Name (ARN) that grants AWS CodePipeline permission to make calls to AWS services on your behalf. For more information, see [AWS CodePipeline Access Permissions Reference](http://docs.aws.amazon.com/codepipeline/latest/userguide/access-permissions.html) in the _AWS CodePipeline User Guide_. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Stages: description: |+ Defines the AWS CodePipeline pipeline stages. _Required:_ Yes _Type_: [AWS CodePipeline Pipeline Stages](aws-properties-codepipeline-pipeline-stages.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: AWS CodePipeline Pipeline Stages update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::CodePipeline::Pipeline` resource to the intrinsic `Ref` function, the function returns the pipeline name, such as `mysta-MyPipeline-A1BCDEFGHIJ2`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Cognito::IdentityPool: description: The `AWS::Cognito::IdentityPool` resource creates an Amazon Cognito identity pool. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html properties: IdentityPoolName: description: |+ The name of your Amazon Cognito identity pool. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) MinLength: 1 MaxLength: 128 required: 'no' type: String update_requires: no_interruption AllowUnauthenticatedIdentities: description: |+ Specifies whether the identity pool supports unauthenticated logins. _Required:_ Yes _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Boolean update_requires: no_interruption DeveloperProviderName: description: |+ The "domain" by which Amazon Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Amazon Cognito service to communicate about the developer provider. For the `DeveloperProviderName`, you can use letters and periods (`.`), underscores (`_`), and dashes (`-`). _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) MinLength: 1 MaxLength: 100 required: 'no' type: String update_requires: no_interruption SupportedLoginProviders: description: |+ Key-value pairs that map provider names to provider app IDs. _Required:_ No _Type_: String to String map _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String to String map update_requires: no_interruption CognitoIdentityProviders: description: |+ An array of Amazon Cognito user pools and their client IDs. _Required:_ No _Type_: An array of [Amazon Cognito IdentityPool CognitoIdentityProvider](aws-properties-cognito-identitypool-cognitoidentityprovider.html). _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: An array of Amazon Cognito IdentityPool CognitoIdentityProvider. update_requires: no_interruption SamlProviderARNs: description: |+ A list of Amazon Resource Names (ARNs) of Security Assertion Markup Language (SAML) providers. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption OpenIdConnectProviderARNs: description: |+ A list of ARNs for the OpendID Connect provider. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption CognitoStreams: description: |+ Configuration options for configuring Amazon Cognito streams. _Required:_ No _Type_: [Amazon Cognito IdentityPool CognitoStreams](aws-properties-cognito-identitypool-cognitostreams.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon Cognito IdentityPool CognitoStreams update_requires: no_interruption PushSync: description: |+ Configuration options to be applied to the identity pool. _Required:_ No _Type_: [Amazon Cognito IdentityPool PushSync](aws-properties-cognito-identitypool-pushsync.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon Cognito IdentityPool PushSync update_requires: no_interruption CognitoEvents: description: |+ The events to configure. _Required:_ No _Type:_ String to String map _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String to String map update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the `IdentityPoolId`, such as `us-east-2:0d01f4d7-1305-4408-b437-12345EXAMPLE`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Name: description: |+ The name of the Amazon Cognito identity pool, returned as a string. examples: {} AWS::Cognito::IdentityPoolRoleAttachment: description: The `AWS::Cognito::IdentityPoolRoleAttachment` resource manages the role configuration for an Amazon Cognito identity pool. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html properties: IdentityPoolId: description: |+ An identity pool ID in the format `REGION:GUID`. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement RoleMappings: description: |+ How users for a specific identity provider are to mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp-east-1.amazonaws.com/us-east-1\_abcdefghi:app\_client\_id" _Required:_ No _Type_: String to [Amazon Cognito IdentityPoolRoleAttachment RoleMapping](aws-properties-cognito-identitypoolroleattachment-rolemapping.html) object map. _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String to Amazon Cognito IdentityPoolRoleAttachment RoleMapping object map. update_requires: no_interruption Roles: description: |+ The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN. _Required:_ No _Type:_ String to string map _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String to string map update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns a generated ID, such as `IdentityPoolRoleAttachment-EXAMPLEwnOR3n`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Cognito::UserPool: description: The `AWS::Cognito::UserPool` resource creates an Amazon Cognito user pool. For more information on working with Amazon Cognito user pools, see [Amazon Cognito User Pools](http://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html) and [CreateUserPool](http://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html properties: AdminCreateUserConfig: description: |+ The type of configuration for creating a new user profile. _Required:_ No _Type_: [Amazon Cognito UserPool AdminCreateUserConfig](aws-properties-cognito-userpool-admincreateuserconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon Cognito UserPool AdminCreateUserConfig update_requires: no_interruption AliasAttributes: description: |+ Attributes supported as an alias for this user pool. Possible values: `phone_number`, `email`, and/or `preferred_username`. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption AutoVerifiedAttributes: description: |+ The attributes to be auto-verified. Possible values: `email` and/or `phone_number`. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption DeviceConfiguration: description: |+ The type of configuration for the user pool's device tracking. _Required:_ No _Type_: [Amazon Cognito UserPool DeviceConfiguration](aws-properties-cognito-userpool-deviceconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon Cognito UserPool DeviceConfiguration update_requires: no_interruption EmailConfiguration: description: |+ The email configuration. _Required:_ No _Type_: [Amazon Cognito UserPool EmailConfiguration](aws-properties-cognito-userpool-emailconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon Cognito UserPool EmailConfiguration update_requires: no_interruption EmailVerificationMessage: description: |+ A string representing the email verification message. Must contain `{####}` in the description. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption EmailVerificationSubject: description: |+ A string representing the email verification subject. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption LambdaConfig: description: |+ The AWS Lambda trigger configuration information for the Amazon Cognito user pool. _Required:_ No _Type_: [Amazon Cognito UserPool LambdaConfig](aws-properties-cognito-userpool-lambdaconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon Cognito UserPool LambdaConfig update_requires: no_interruption MfaConfiguration: description: |+ Specifies multi-factor authentication (MFA) configuration details. Can be one of the following values: `OFF` - MFA tokens are not required and cannot be specified during user registration. `ON` - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool. `OPTIONAL` - Users have the option when registering to create an MFA token. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Policies: description: |+ The policies associated with the Amazon Cognito user pool. _Required:_ No _Type_: [Amazon Cognito UserPool Policies](aws-properties-cognito-userpool-policies.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon Cognito UserPool Policies update_requires: no_interruption UserPoolName: description: |+ A string used to name the user pool. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Schema: description: |+ A list of schema attributes for the new user pool. These attributes can be standard or custom attributes. _Required:_ No _Type_: List of [SchemaAttribute](aws-properties-cognito-userpool-schemaattribute.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement SmsAuthenticationMessage: description: |+ A string representing the SMS authentication message. Must contain `{####}` in the message. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption SmsConfiguration: description: |+ The Short Message Service (SMS) configuration. _Required:_ No _Type_: [Amazon Cognito UserPool SmsConfiguration](aws-properties-cognito-userpool-smsconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon Cognito UserPool SmsConfiguration update_requires: no_interruption SmsVerificationMessage: description: |+ A string representing the SMS verification message. Must contain `{####}` in the message. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption UserPoolTags: description: |+ The cost allocation tags for the user pool. For more information, see [Adding Cost Allocation Tags to Your User Pool](http://docs.aws.amazon.com//cognito/latest/developerguide/cognito-user-pools-cost-allocation-tagging.html) in the _Amazon Cognito Developer Guide_. _Required:_ No _Type_: String to String map _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String to String map update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns a generated ID, such as `us-east-2_zgaEXAMPLE`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). ProviderName: description: |+ The provider name of the Amazon Cognito user pool, specified as a `String`. ProviderURL: description: |+ The URL of the provider of the Amazon Cognito user pool, specified as a `String`. Arn: description: |+ The Amazon Resource Name (ARN) of the user pool, such as `arn:aws:cognito-idp:``us-east-2``:123412341234:userpool/us-east-1 _123412341`. examples: {} AWS::Cognito::UserPoolClient: description: The `AWS::Cognito::UserPoolClient` resource creates an Amazon Cognito user pool client. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html properties: ClientName: description: |+ The client name for the user pool client that you want to create. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) MinLength: 1 MaxLength: 128 required: 'no' type: String update_requires: no_interruption ExplicitAuthFlows: description: |+ The explicit authentication flows, which can be one of the following: `ADMIN_NO_SRP_AUTH` or `CUSTOM_AUTH_FLOW_ONLY`. _Required:_ No _Type_: List of Strings _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption GenerateSecret: description: |+ Specifies whether you want to generate a secret for the user pool client being created. _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement ReadAttributes: description: |+ The read attributes. _Required:_ No _Type_: List of Strings _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption RefreshTokenValidity: description: |+ The time limit, in days, after which the refresh token is no longer valid. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption UserPoolId: description: |+ The user pool ID for the user pool where you want to create a client. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement WriteAttributes: description: |+ The write attributes. _Required:_ No _Type_: List of Strings _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the Amazon Cognito user pool client ID, such as `1h57kf5cpq17m0eml12EXAMPLE`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). ClientSecret: description: |+ The client secret, as a `String`. Name: description: |+ The name of the user pool client, as a `String`. examples: {} AWS::Cognito::UserPoolGroup: description: The `AWS::Cognito::UserPoolGroup` resource creates a user group in an Amazon Cognito user pool. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html properties: Description: description: |+ A description of the user group. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) MaxLength: 2048 required: 'no' type: String update_requires: no_interruption GroupName: description: |+ The name of the user group. `GroupName` must be unique. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Precedence: description: |+ A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest `Precedence` value. Groups with lower `Precedence` values take precedence over groups with higher or null `Precedence` values. If a user belongs to two or more groups, the role ARN of the group with the lowest precedence value is used in the `cognito:roles` and `cognito:preferred_role` claims in the user's tokens. Two groups can have the same `Precedence` value. If this happens, neither group takes precedence over the other. If two groups with the same `Precedence` value have the same role ARN, that role is used in the `cognito:preferred_role` claim in tokens for users in each group. If the two groups have different role ARNs, the `cognito:preferred_role` claim is not set in users' tokens. The default `Precedence` value is null. _Required:_ No _Type_: Number _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption RoleArn: description: |+ The role ARN for the group. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption UserPoolId: description: |+ The user pool ID. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the name of the user pool group. For example, `Admins`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Cognito::UserPoolUser: description: The `AWS::Cognito::UserPoolUser` resource creates an Amazon Cognito user pool user. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html properties: DesiredDeliveryMediums: description: |+ Specifies how the welcome message will be sent. For email, specify `EMAIL`. To use a phone number, specify `SMS`. You can specify more than one value. The default value is `SMS`. _Required:_ No _Type_: List of String values _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement ForceAliasCreation: description: |+ Use this parameter only if the `phone_number_verified` attribute or the `email_verified` attribute is set to `True`. Otherwise, it is ignored. The default value is `False`. If this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, the API call migrates the alias from the previous user to the newly created user. The previous user can no longer log in using that alias. If this parameter is set to `False` and the alias already exists, the API throws an `AliasExistsException` error. _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement UserAttributes: description: |+ A list of name-value pairs that contain user attributes and attribute values to be set for the user that you are creating. You can create a user without specifying any attributes other than `Username`. However, any attributes that you specify as required (in `CreateUserPool` or in the **Attributes** tab of the console) must be supplied either by you (in your call to `AdminCreateUser`) or by the user (when signing up in response to your welcome message). _Required:_ No _Type_: List of [Amazon Cognito UserPoolUser AttributeType](aws-properties-cognito-userpooluser-attributetype.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement MessageAction: description: |+ Specifies the action you'd like to take for the message. Valid values are `RESEND` and `SUPPRESS`. To resend the invitation message to a user that already exists and reset the expiration limit on the user's account, set this parameter to `RESEND`. To suppress sending the message, set it to `SUPPRESS`. You can specify only one value. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Username: description: |+ The user name for the user. `Username` must be unique within the user pool. It must be a UTF-8 string between 1 and 128 characters. You can't change the username. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement UserPoolId: description: |+ The ID for the user pool where the user will be created. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement ValidationData: description: |+ The user's validation data. This is a list of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain. To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool. The Lambda trigger receives the validation data and uses it in the validation process. For more information, see [Customizing User Pool Workflows by Using AWS Lambda Triggers](http://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the _Amazon Cognito Developer Guide_. _Required:_ No _Type_: List of [Amazon Cognito UserPoolUser AttributeType](aws-properties-cognito-userpooluser-attributetype.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the name of the user. For example, `admin`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Cognito::UserPoolUserToGroupAttachment: description: The `AWS::Cognito::UserPoolUserToGroupAttachment` resource attaches a user to an Amazon Cognito user pool user group. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html properties: GroupName: description: |+ The name of the group. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Username: description: |+ The user's user name. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement UserPoolId: description: |+ The ID of the user pool. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns a generated ID, such as `UserToGroupAttachment-YejJvzrEXAMPLE`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Config::ConfigRule: description: The `AWS::Config::ConfigRule` resource uses an AWS Lambda (Lambda) function that evaluates configuration items to assess whether your AWS resources comply with your specified configurations. This function can run when AWS Config detects a configuration change or delivers a configuration snapshot. The resources this function evaluates must be in the recording group. For more information, see [Evaluating AWS Resource Configurations with AWS Config](http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) in the _AWS Config Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html properties: ConfigRuleName: description: |+ A name for the AWS Config rule. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see [Name Type](aws-properties-name.html). _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Description: description: |+ A description about this AWS Config rule. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption InputParameters: description: |+ Input parameter values that are passed to the AWS Config rule (Lambda function). _Required:_ No _Type_: JSON object _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: JSON update_requires: no_interruption MaximumExecutionFrequency: description: |+ The maximum frequency at which the AWS Config rule runs evaluations. For valid values, see the [ConfigRule](http://docs.aws.amazon.com/config/latest/APIReference/API_ConfigRule.html) data type in the _AWS Config API Reference_. If the rule runs an evaluation when AWS Config delivers a configuration snapshot, the rule cannot run more frequently than the snapshot delivery frequency. Set an execution frequency value that is equal to or greater than the value of the snapshot delivery frequency, which is a property the [AWS::Config::DeliveryChannel](aws-resource-config-deliverychannel.html) resource. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Scope: description: |+ Defines which AWS resources will trigger an evaluation when their configurations change. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain the resources that are evaluated. If you don't specify a scope, the rule evaluates all resources in the recording group. _Required:_ No _Type_: [AWS Config ConfigRule Scope](aws-properties-config-configrule-scope.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS Config ConfigRule Scope update_requires: no_interruption Source: description: |+ Specifies the rule owner, the rule identifier, and the events that cause the function to evaluate your AWS resources. _Required:_ Yes _Type_: [AWS Config ConfigRule Source](aws-properties-config-configrule-source.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: AWS Config ConfigRule Source update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::Config::ConfigRule` resource to the intrinsic `Ref` function, the function returns the rule name, such as `mystack-MyConfigRule-12ABCFPXHV4OV`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ The Amazon Resource Name (ARN) of the AWS Config rule, such as `arn:aws:config:us-east-1:123456789012:config-rule/config-rule-a1bzhi`. ConfigRuleId: description: |+ The ID of the AWS Config rule, such as `config-rule-a1bzhi`. Compliance.Type: description: |+ The compliance status of an AWS Config rule, such as `COMPLIANT` or `NON_COMPLIANT`. examples: {} AWS::Config::ConfigurationRecorder: description: |- The `AWS::Config::ConfigurationRecorder` resource describes the AWS resource types for which AWS Config records configuration changes. The configuration recorder stores the configurations of the supported resources in your account as configuration items. Note To enable AWS Config, you must create a configuration recorder and a delivery channel. AWS Config uses the delivery channel to deliver the configuration changes to your Amazon S3 bucket or Amazon SNS topic. For more information, see [AWS::Config::DeliveryChannel](aws-resource-config-deliverychannel.html). AWS CloudFormation starts the recorder as soon as the delivery channel is available. To stop the recorder, delete the configuration recorder from your stack. For more information, see [Configuration Recorder](http://docs.aws.amazon.com/config/latest/developerguide/config-concepts.html#config-recorder) in the _AWS Config Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html properties: Name: description: |+ A name for the configuration recorder. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the configuration recorder name. For more information, see [Name Type](aws-properties-name.html). Note After you create a configuration recorder, you cannot rename it. If you don't want a name that AWS CloudFormation generates, specify a value for this property. _Required:_ No _Type_: String _Update requires_: Updates are not supported. required: 'no' type: String update_requires: RecordingGroup: description: |+ Indicates whether to record configurations for all supported resources or for a list of resource types. The resource types that you list must be supported by AWS Config. _Required:_ No _Type_: [AWS Config ConfigurationRecorder RecordingGroup](aws-properties-config-configurationrecorder-recordinggroup.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- AWS Config ConfigurationRecorder RecordingGroup update_requires: no_interruption RoleARN: description: |+ The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to make read or write requests to the delivery channel that you specify and to get configuration details for supported AWS resources. For more information, see [Permissions for the IAM Role Assigned to AWS Config](http://docs.aws.amazon.com/config/latest/developerguide/iamrole-permissions.html) in the _AWS Config Developer Guide_. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::Config::ConfigurationRecorder` resource to the intrinsic `Ref` function, the function returns the configuration recorder name, such as `default`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Config::DeliveryChannel: description: "The `AWS::Config::DeliveryChannel` resource describes where AWS Config sends notifications and updated configuration states for AWS resources.\n\nWhen you create the delivery channel, you can specify the following:\n\n- \n\nHow often AWS Config delivers configuration snapshots to your Amazon S3 bucket (for example, 24 hours)\n\n- \n\nThe S3 bucket to which AWS Config sends configuration snapshots and configuration history files\n\n- \n\nThe Amazon SNS topic to which AWS Config sends notifications about configuration changes, such as updated resources, AWS Config rule evaluations, and when AWS Config delivers the configuration snapshot to your S3 bucket.\n\nFor more information, see [Deliver Configuration Items](http://docs.aws.amazon.com/config/latest/developerguide/how-does-config-work.html#delivery-channel) in the _AWS Config Developer Guide_.\n\nNote\n\nTo enable AWS Config, you must create a configuration recorder and a delivery channel. If you want to create the resources separately, you must create a configuration recorder before you can create a delivery channel. AWS Config uses the configuration recorder to capture configuration changes to your resources. For more information, see [AWS::Config::ConfigurationRecorder](aws-resource-config-configurationrecorder.html).\n\nFor more information, see [Managing the Delivery Channel](http://docs.aws.amazon.com/config/latest/developerguide/manage-delivery-channel.html) in the _AWS Config Developer Guide_." url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html properties: ConfigSnapshotDeliveryProperties: description: |+ Provides options for how AWS Config delivers configuration snapshots to the S3 bucket in your delivery channel. _Required:_ No _Type_: [AWS Config DeliveryChannel ConfigSnapshotDeliveryProperties](aws-properties-config-deliverychannel-configsnapshotdeliveryproperties.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- AWS Config DeliveryChannel ConfigSnapshotDeliveryProperties update_requires: no_interruption Name: description: |+ A name for the delivery channel. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the delivery channel name. For more information, see [Name Type](aws-properties-name.html). _Required:_ No _Type_: String _Update requires_: Updates are not supported. To change the name, you must run two separate updates. In the first update, delete this resource, and then recreate it with a new name in the second update. required: 'no' type: String update_requires: S3BucketName: description: |+ The name of an S3 bucket where you want to store configuration history for the delivery channel. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption S3KeyPrefix: description: |+ A key prefix (folder) for the specified S3 bucket. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption SnsTopicARN: description: |+ The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic that AWS Config delivers notifications to. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::Config::DeliveryChannel` resource to the intrinsic `Ref` function, the function returns the delivery channel name, such as `default`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::DataPipeline::Pipeline: description: Creates a data pipeline that you can use to automate the movement and transformation of data. In each pipeline, you define pipeline objects, such as activities, schedules, data nodes, and resources. For information about pipeline objects and components that you can use, see [Pipeline Object Reference](http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-pipeline-objects.html) in the _AWS Data Pipeline Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html properties: Activate: description: |+ Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to `true`. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption Description: description: |+ A description for the pipeline. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement). required: 'no' type: String update_requires: replacement Name: description: |+ A name for the pipeline. Because AWS CloudFormation assigns each new pipeline a unique identifier, you can use the same name for multiple pipelines that are associated with your AWS account. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement ParameterObjects: description: |+ Defines the variables that are in the pipeline definition. For more information, see [Creating a Pipeline Using Parameterized Templates](http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-custom-templates.html) in the _AWS Data Pipeline Developer Guide_. _Required:_ No _Type_: [AWS Data Pipeline Pipeline ParameterObjects](aws-properties-datapipeline-pipeline-parameterobjects.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- AWS Data Pipeline Pipeline ParameterObjects update_requires: no_interruption ParameterValues: description: |+ Defines the values for the parameters that are defined in the `ParameterObjects` property. For more information, see [Creating a Pipeline Using Parameterized Templates](http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-custom-templates.html) in the _AWS Data Pipeline Developer Guide_. _Required:_ No _Type_: [AWS Data Pipeline Pipeline ParameterValues](aws-properties-datapipeline-pipeline-parametervalues.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- AWS Data Pipeline Pipeline ParameterValues update_requires: no_interruption PipelineObjects: description: |+ A list of pipeline objects that make up the pipeline. For more information about pipeline objects and a description of each object, see [Pipeline Object Reference](http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-pipeline-objects.html) in the _AWS Data Pipeline Developer Guide_. _Required:_ Yes _Type_: A list of [AWS Data Pipeline PipelineObject](aws-properties-datapipeline-pipeline-pipelineobjects.html) _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Not all objects, fields, and values can be updated. Restrictions on what can be updated are documented in [Editing Your Pipelines](http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-manage-pipeline-modify-console.html) in the _AWS Data Pipeline Developer Guide_. required: 'yes' type: |- A list of AWS Data Pipeline PipelineObject update_requires: some_interruptions PipelineTags: description: |+ A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see [Controlling Access to Pipelines and Resources](http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) in the _AWS Data Pipeline Developer Guide_. _Required:_ No _Type_: [AWS Data Pipeline Pipeline PipelineTags](aws-properties-datapipeline-pipeline-pipelinetags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- AWS Data Pipeline Pipeline PipelineTags update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. When you specify an `AWS::DataPipeline::Pipeline` resource as an argument to the `Ref` function, AWS CloudFormation returns the pipeline ID. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::DAX::Cluster: description: |- Use the `AWS::DAX::Cluster` resource to create a DAX cluster for use with Amazon DynamoDB. For information about creating a DAX cluster, see [Creating a DAX Cluster](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.create-cluster.html) in the _Amazon DynamoDB Developer Guide_ and [`CreateCluster`](http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_dax_CreateCluster.html) in the _Amazon DynamoDB Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html properties: AvailabilityZones: description: |+ The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs. You must specify one AZ per DAX node in the cluster. _Required:_ No _Type_: List of String values _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: List update_requires: some_interruptions ClusterName: description: |+ The cluster identifier. This parameter is stored as a lowercase string. _Required:_ No _Type_: String _Update requires_: Updates are not supported. required: 'no' type: String update_requires: Description: description: |+ A description of the cluster. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption IAMRoleARN: description: |+ A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf. _Required:_ Yes _Type_: String _Update requires_: Updates are not supported. required: 'yes' type: String update_requires: NodeType: description: |+ The compute and memory capacity of the nodes in the cluster. _Required:_ Yes _Type_: String _Update requires_: Updates are not supported. required: 'yes' type: String update_requires: NotificationTopicARN: description: |+ The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent. Note The Amazon SNS topic owner must be same as the DAX cluster owner. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption ParameterGroupName: description: |+ The parameter group to be associated with the DAX cluster. _Required:_ No _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: String update_requires: some_interruptions PreferredMaintenanceWindow: description: "Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for `ddd` are:\n\n- \n\n`sun`\n\n- \n\n`mon`\n\n- \n\n`tue`\n\n- \n\n`wed`\n\n- \n\n`thu`\n\n- \n\n`fri`\n\n- \n\n`sat`\n\nExample: `sun:05:00-sun:09:00`\n\nNote\n\nIf you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.\n\n_Required:_ No\n\n_Type_: String\n\n_Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n\n" required: 'no' type: String update_requires: no_interruption ReplicationFactor: description: |+ The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set _ReplicationFactor_ to 2 or more. Note AWS recommends that you have at least two read replicas per cluster. _Required:_ Yes _Type_: Integer _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'yes' type: Number update_requires: some_interruptions SecurityGroupIds: description: |+ A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.) If this parameter is not specified, DAX assigns the default VPC security group to each node. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption SubnetGroupName: description: |+ The name of the subnet group to be used for the replication group. Important DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC. _Required:_ Yes _Type_: String _Update requires_: Updates are not supported. required: 'yes' type: String update_requires: Tags: description: |+ A map of tags to associate with the DAX cluster. _Required:_ No _Type_: String to String map _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String to String map update_requires: no_interruption return_values: Ref: description: |- When you provide the logical ID of this resource to the `Ref` intrinsic function, `Ref` returns the name of the created DAX cluster. For example: Copy{ "Ref": "MyDAXCluster" } Returns a value similar to the following: CopyMyDAXCluster For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ Returns the ARN of the DAX cluster. For example: Copy{ "Fn::GetAtt": ["MyDAXCluster", "Arn"] } Returns a value similar to the following: Copyarn:aws:dax:us-east-1:111122223333:cache/MyDAXCluster ClusterDiscoveryEndpoint: description: |+ Returns the configuation endpoint of the DAX cluster. For example: Copy{ "Fn::GetAtt": ["MyDAXCluster", "ClusterDiscoveryEndpoint"] } Returns a value similar to the following: Copymydaxcluster.0h3d6x.clustercfg.dax.use1.cache.amazonaws.com:8111 examples: {} AWS::DAX::ParameterGroup: description: |- Use the AWS CloudFormation `AWS::DAX::ParameterGroup` resource to create a parameter group for use with Amazon DynamoDB. For more information, see [`ParameterGroup`](http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_dax_ParameterGroup.html) in the _Amazon DynamoDB Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-parametergroup.html properties: ParameterGroupName: description: |+ The name of the parameter group. _Required:_ No _Type_: String _Update requires_: Updates are not supported. required: 'no' type: String update_requires: Description: description: |+ A description of the parameter group. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt); required: 'no' type: String update_requires: no_interruption ParameterNameValues: description: |+ A map of DAX parameter names and values. _Required:_ No _Type_: String to String map _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String to String map update_requires: no_interruption return_values: Ref: description: |- When you provide the logical ID of this resource to the `Ref` intrinsic function, `Ref` returns the ARN of the created parameter group. For example: Copy{ "Ref": "MyDAXParameterGroup" } Returns a value similar to the following: Copymy-dax-parameter-group For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). ParameterGroupName: description: |+ Returns the name of the parameter group. For example: Copy{ "Fn::GetAtt": ["MyDAXParameterGroup", "ParameterGroupName"] } Returns a value similar to the following: Copymydaxparametergroup examples: {} AWS::DAX::SubnetGroup: description: |- Use the AWS CloudFormation `AWS::DAX::SubnetGroup` resource to create a subnet group for use with DAX (DynamoDB Accelerator). For more information, see [`SubnetGroup`](http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_dax_SubnetGroup.html) in the _Amazon DynamoDB Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-subnetgroup.html properties: SubnetGroupName: description: |+ The name of the subnet group. _Required:_ No _Type_: String _Update requires_: Updates are not supported. required: 'no' type: String update_requires: Description: description: |+ The description of the subnet group. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption SubnetIds: description: |+ A list of subnets associated with the subnet group. _Required:_ No _Type_: List of String values; _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When you provide the logical ID of this resource to the `Ref` intrinsic function, `Ref` returns the ARN of the created activity. For example: Copy{ "Ref": "MyDAXSubnetGroup" } Returns a value similar to the following: Copymy-dax-subnet-group For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). SubnetGroupName: description: |+ Returns the name of the subnet group. For example: Copy{ "Fn::GetAtt": ["MyDAXSubnetGroup", "SubnetGroupName"] } Returns a value similar to the following: Copymy-dax-subnet-group examples: {} AWS::DirectoryService::MicrosoftAD: description: The `AWS::DirectoryService::MicrosoftAD` resource creates a Microsoft Active Directory in AWS so that your directory users and groups can access the AWS Management Console and AWS applications using their existing credentials. For more information, see [What Is AWS Directory Service?](http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html) in the _AWS Directory Service Administration Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html properties: CreateAlias: description: |+ A unique alias to assign to the Microsoft Active Directory in AWS. AWS Directory Service uses the alias to construct the access URL for the directory, such as `http://alias.awsapps.com`. By default, AWS CloudFormation does not create an alias. _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement EnableSso: description: |+ Whether to enable single sign-on for a Microsoft Active Directory in AWS. Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately. If you don't specify a value, AWS CloudFormation disables single sign-on by default. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption Name: description: |+ The fully qualified name for the Microsoft Active Directory in AWS, such as `corp.example.com`. The name doesn't need to be publicly resolvable; it will resolve inside your VPC only. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Password: description: |+ The password for the default administrative user, `Admin`. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement ShortName: description: |+ The NetBIOS name for your domain, such as `CORP`. If you don't specify a value, AWS Directory Service uses the first part of your directory DNS server name. For example, if your directory DNS server name is `corp.example.com`, AWS Directory Service specifies `CORP` for the NetBIOS name. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement VpcSettings: description: |+ Specifies the VPC settings of the Microsoft Active Directory server in AWS. _Required:_ Yes _Type_: [AWS Directory Service MicrosoftAD VpcSettings](aws-properties-directoryservice-microsoftad-vpcsettings.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: |- AWS Directory Service MicrosoftAD VpcSettings update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource ID. In the following sample, the `Ref` function returns the ID of the `myDirectory` directory, such as `d-12345ab592`. Copy{ "Ref": "myDirectory" } For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Alias: description: |+ The alias for a directory. For example: `d-12373a053a` or `alias4-mydirectory-12345abcgmzsk` (if you have the `CreateAlias` property set to true). DnsIpAddresses: description: |+ The IP addresses of the DNS servers for the directory, such as `[ "192.0.2.1", "192.0.2.2" ]`. examples: {} AWS::DirectoryService::SimpleAD: description: The `AWS::DirectoryService::SimpleAD` resource creates an AWS Directory Service Simple Active Directory (Simple AD) in AWS so that your directory users and groups can access the AWS Management Console and AWS applications using their existing credentials. Simple AD is a Microsoft Active Directory–compatible directory. For more information, see [What Is AWS Directory Service?](http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html) in the _AWS Directory Service Administration Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html properties: CreateAlias: description: |+ A unique alias to assign to the directory. AWS Directory Service uses the alias to construct the access URL for the directory, such as `http://alias.awsapps.com`. By default, AWS CloudFormation does not create an alias. _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement Description: description: |+ A description of the directory. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement EnableSso: description: |+ Whether to enable single sign-on for a directory. If you don't specify a value, AWS CloudFormation disables single sign-on by default. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption Name: description: |+ The fully qualified name for the directory, such as `corp.example.com`. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Password: description: |+ The password for the directory administrator. AWS Directory Service creates a directory administrator account with the user name `Administrator` and this password. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement ShortName: description: |+ The NetBIOS name of the on-premises directory, such as `CORP`. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Size: description: |+ The size of the directory. For valid values, see [CreateDirectory](http://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html) in the _AWS Directory Service API Reference_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement VpcSettings: description: |+ Specifies the VPC settings of the directory server. _Required:_ Yes _Type_: [AWS Directory Service SimpleAD VpcSettings](aws-properties-directoryservice-simplead-vpcsettings.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: |- AWS Directory Service SimpleAD VpcSettings update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource ID. In the following sample, the `Ref` function returns the ID of the `myDirectory` directory, such as `d-1a2b3c4d5e`. Copy{ "Ref": "myDirectory" } For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Alias: description: |+ The alias for a directory. For example: `d-12373a053a` or `alias4-mydirectory-12345abcgmzsk` (if you have the `CreateAlias` property set to true). DnsIpAddresses: description: |+ The IP addresses of the DNS servers for the directory, such as `[ "172.31.3.154", "172.31.63.203" ]`. examples: {} AWS::DMS::Certificate: description: The `AWS::DMS::Certificate` resource creates an SSL certificate that encrypts connections between AWS DMS endpoints and the replication instance. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html properties: CertificateIdentifier: description: |+ The customer-assigned name of the certificate. Valid characters are `A-z` and `0-9`. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement CertificatePem: description: |+ The contents of the .pem X.509 certificate file for the certificate. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement CertificateWallet: description: |+ The location of the imported Oracle Wallet certificate for use with SSL. _Required:_ No _Type:_ Base64-encoded binary data object _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Base64-encoded binary data object update_requires: replacement return_values: Ref: description: |- When you pass the certificate of an `AWS::DMS::Certificate` resource to the intrinsic `Ref` function, the function returns the Amazon Resource Name (ARN) of the certificate. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::DMS::Endpoint: description: The `AWS::DMS::Endpoint` resource creates an AWS DMS endpoint. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html properties: CertificateArn: description: |+ The Amazon Resource Number (ARN) for the certificate. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption DatabaseName: description: |+ The name of the endpoint database. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption DynamoDbSettings: description: |+ Settings in JSON format for the target DynamoDB endpoint. For more information about the available settings, see the **Using Object Mapping to Migrate Data to DynamoDB** section at [Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service](http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html). _Required:_ No _Type:_ [AWS DMS Endpoint DynamoDBSettings](aws-properties-dms-endpoint-dynamodbsettings.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- AWS DMS Endpoint DynamoDBSettings update_requires: no_interruption EndpointIdentifier: description: |+ The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption EndpointType: description: |+ The type of endpoint. Valid values are `source` and `target`. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption EngineName: description: |+ The type of engine for the endpoint. Valid values depend on the `EndPointType` and include `MYSQL`, `ORACLE`, `POSTGRES`, `MARIADB`, `AURORA`, `REDSHIFT`, `S3`, `SYBASE`, `DYNAMODB`, `MONGODB`, and `SQLSERVER`. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption ExtraConnectionAttributes: description: |+ Additional attributes associated with the connection. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption KmsKeyId: description: |+ The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the `KmsKeyId` parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement MongoDbSettings: description: |+ Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the **Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service** section at [Using Amazon S3 as a Target for AWS Database Migration Service](http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html). _Required:_ No _Type:_ [AWS DMS Endpoint MongoDbSettings](aws-properties-dms-endpoint-mongodbsettings.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- AWS DMS Endpoint MongoDbSettings update_requires: no_interruption Password: description: |+ The password to be used to login to the endpoint database. Do not use this parameter directly. Use `Password` as an input parameter with `noEcho` as shown in the [Parameters](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html). For best practices information, see [Do Not Embed Credentials in Your Templates](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html#creds). _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Port: description: |+ The port used by the endpoint database. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption S3Settings: description: |+ Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see the **Extra Connection Attributes** section at [Using Amazon S3 as a Target for AWS Database Migration Service](http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html) in the _AWS Database Migration Service User Guide_. _Required:_ No _Type:_ [AWS DMS Endpoint S3Settings](aws-properties-dms-endpoint-s3settings.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- AWS DMS Endpoint S3Settings update_requires: no_interruption ServerName: description: |+ The name of the server where the endpoint database resides. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption SslMode: description: |+ The SSL mode to use for the SSL connection. SSL mode can be one of four values: `none`, `require`, `verify-ca`, `verify-full`. The default value is `none`. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Tags: description: |+ The tags that you want to attach to the DMS endpoint. _Required:_ No _Type_: List of [resource tags](aws-properties-resource-tags.html) in key-value format _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement Username: description: |+ The user name to be used to login to the endpoint database. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::DMS::Endpoint` resource to the intrinsic `Ref` function, the function returns the ARN of the endpoint. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::DMS::EventSubscription: description: Use the `AWS::DMS::EventSubscription` resource to get notifications for AWS Database Migration Service events through the Amazon Simple Notification Service. For more information, see [Using AWS DMS Event Notification](http://docs.aws.amazon.com/dms/latest/userguide/USER_Events.html) in the _AWS Database Migration Service User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html properties: Enabled: description: |+ Indicates whether to activate the subscription. If you don't specify this property, AWS CloudFormation activates the subscription. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption EventCategories: description: |+ A list of event categories that you want to subscribe to for a given source type. If you don't specify this property, you are notified about all event categories. For more information, see [Using AWS DMS Event Notification](http://docs.aws.amazon.com/dms/latest/userguide/USER_Events.html) in the _AWS Database Migration Service User Guide_. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption SnsTopicArn: description: |+ The Amazon Resource Name (ARN) of an Amazon SNS topic that you want to send event notifications to. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption SourceIds: description: |+ A list of identifiers for which AWS DMS provides notification events. If you don't specify a value, notifications are provided for all sources. If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, all other values must be database instance IDs. _Required:_ No _Type_: List of String values _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement SourceType: description: |+ The type of source for which AWS DMS provides notification events. For example, if you want to be notified of events generated by a database instance, set this parameter to `replication-instance`. If you don't specify a value, notifications are provided for all source types. For valid values, see the `SourceType` parameter for the [CreateEventSubscription](http://docs.aws.amazon.com/dms/latest/APIReference/API_CreateEventSubscription.html) action in the _AWS Database Migration Service API Reference_. _Required:_ Conditional. If you specify the `SourceIds` or `EventCategories` property, you must specify this property. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption SubscriptionName: description: |+ The subscription name. If you don't specify a value, we create a random value. _Required:_ No _Type_: List of String values _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement Tags: description: |+ The tags that you want to attach to the DMS event subscription. _Required:_ No _Type_: List of [resource tags](aws-properties-resource-tags.html) in key-value format _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement return_values: Ref: description: '' examples: {} AWS::DMS::ReplicationInstance: description: The `AWS::DMS::ReplicationInstance` resource creates an AWS DMS replication instance. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html properties: AllocatedStorage: description: |+ The amount of storage (in gigabytes) to be initially allocated for the replication instance. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption AutoMinorVersionUpgrade: description: |+ Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption AvailabilityZone: description: |+ The EC2 Availability Zone that the replication instance will be created in. The default value is a random, system-chosen Availability Zone in the endpoint's region. _Example_: `us-east-1d` _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement EngineVersion: description: |+ The engine version number of the replication instance. _Required:_ No _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: String update_requires: some_interruptions KmsKeyId: description: |+ The KMS key identifier that will be used to encrypt the content on the replication instance. If you do not specify a value for the `KmsKeyId` parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement MultiAZ: description: |+ Specifies if the replication instance is a Multi-AZ deployment. You cannot set the `AvailabilityZone` parameter if the `MultiAZ` parameter is set to `true` . _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption PreferredMaintenanceWindow: description: |+ The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). _Format_: `ddd:hh24:mi-ddd:hh24:mi` _Default_: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. _Valid Values_: `Mon`, `Tue`, `Wed`, `Thu`, `Fri`, `Sat`, `Sun` _Constraints_: Minimum 30-minute window _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption PubliclyAccessible: description: |+ Specifies the accessibility options for the replication instance. A value of `true` represents an instance with a public IP address. A value of `false` represents an instance with a private IP address. The default value is `true` . _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement ReplicationInstanceClass: description: |+ The compute and memory capacity of the replication instance as specified by the replication instance class. _Valid Values_: `dms.t2.micro`, `dms.t2.small`, `dms.t2.medium` , `dms.t2.large`, `dms.c4.large`, `dms.c4.xlarge`, `dms.c4.2xlarge`, `dms.c4.4xlarge` _Required:_ Yes _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'yes' type: String update_requires: some_interruptions ReplicationInstanceIdentifier: description: "A name for the replication instance. If you specify a name, AWS CloudFormation converts it to lower case. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the replication instance identifier. For more information, see [Name Type](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n\n_Constraints_:\n\n- \n\nMust contain from 1 to 63 alphanumeric characters or hyphens.\n\n- \n\nFirst character must be a letter.\n\n- \n\nCannot end with a hyphen or contain two consecutive hyphens.\n\n_Example_: `myrepinstance`\n\n_Required:_ No\n\n_Type_: String\n\n_Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n\n" required: 'no' type: String update_requires: no_interruption ReplicationSubnetGroupIdentifier: description: |+ A subnet group to associate with the replication instance. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Tags: description: |+ The tags that you want to attach to the DMS endpoint. _Required:_ No _Type_: List of [resource tags](aws-properties-resource-tags.html) in key-value format _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement VpcSecurityGroupIds: description: |+ Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::DMS::ReplicationInstance` resource to the intrinsic `Ref` function, the function returns the replication instance ARN. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::DMS::ReplicationSubnetGroup: description: |- The `AWS::DMS::ReplicationSubnetGroup` resource creates an AWS DMS replication subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region. Note Resource creation will fail if the `dms-vpc-role` IAM role doesn't already exist. For more information, see [Creating the IAM Roles to Use With the AWS CLI and AWS DMS API](http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.APIRole.html) in the _AWS Database Migration Service User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnet-group.html properties: ReplicationSubnetGroupIdentifier: description: |+ The identifier for the replication subnet group. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the identifier. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement ReplicationSubnetGroupDescription: description: |+ The description for the replication subnet group. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption SubnetIds: description: |+ The EC2 subnet IDs for the replication subnet group. _Required:_ Yes _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: List update_requires: no_interruption Tags: description: |+ The tags that you want to attach to the AWS DMS replication subnet group. _Required:_ No _Type_: A list of [resource tags](aws-properties-resource-tags.html) in key-value format. _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: |- A list of resource tags in key-value format. update_requires: replacement return_values: Ref: description: |- When you pass the logical ID of an `AWS::DMS::ReplicationSubnetGroup` resource to the intrinsic `Ref` function, the function returns the name of the replication subnet group, such as `mystack-myrepsubnetgroup-0a12bc456789de0fg`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::DMS::ReplicationTask: description: The `AWS::DMS::ReplicationTask` resource creates an AWS DMS replication task. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html properties: CdcStartTime: description: |+ The start time for the Change Data Capture (CDC) operation. _Required:_ No _Type:_ Number, epic value in milliseconds _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number, epic value in milliseconds update_requires: no_interruption MigrationType: description: |+ The migration type. `Valid Values`: `full-load`, `cdc`, `full-load-and-cdc` _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption ReplicationInstanceArn: description: |+ The Amazon Resource Name (ARN) of the replication instance. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement ReplicationTaskIdentifier: description: |+ The ARN string that uniquely identifies the endpoint. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption ReplicationTaskSettings: description: |+ Settings for the task, such as target metadata settings. For a complete list of task settings, see [Task Settings for AWS Database Migration Service Tasks](http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html) in the _AWS Database Migration Service User Guide_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption SourceEndpointArn: description: |+ The ARN string that uniquely identifies the endpoint. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement TableMappings: description: |+ The JSON that contains additional parameter values. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Tags: description: |+ The tags that you want to attach to the migration task. _Required:_ No _Type_: List of [resource tags](aws-properties-resource-tags.html) in key-value format _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement TargetEndpointArn: description: |+ The ARN string that uniquely identifies the endpoint. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When you pass the logical ID of an `AWS::DMS::ReplicationTask` resource to the intrinsic `Ref` function, the function returns the replication task ARN. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::DynamoDB::Table: description: "The `AWS::DynamoDB::Table` resource creates a DynamoDB table.\n\nYou should be aware of the following behaviors when working with DynamoDB tables:\n\n- \n\nAWS CloudFormation typically creates DynamoDB tables in parallel. However, if your template includes multiple DynamoDB tables with indexes, you must declare dependencies so that the tables are created sequentially. Amazon DynamoDB limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DynamoDB returns an error and the stack operation fails. For an example, see [DynamoDB Table with a DependsOn Attribute](aws-resource-dynamodb-table.html#cfn-dynamodb-table-examples-dependson).\n\n- \n\nUpdates to `AWS::DynamoDB::Table` resources that are associated with `AWS::ApplicationAutoScaling::ScalableTarget` resources will always result in an update failure and then an update rollback failure. The following `ScalableDimension` attributes cause this problem when associated with the table:\n\n - \n\ndynamodb:table:ReadCapacityUnits\n\n - \n\ndynamodb:table:WriteCapacityUnits\n\n - \n\ndynamodb:index:ReadCapacityUnits\n\n \ - \n\ndynamodb:index:WriteCapacityUnits\n\nAs a workaround, please deregister scalable targets before performing updates to `AWS::DynamoDB::Table` resources." url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html properties: AttributeDefinitions: description: |+ A list of attributes that describe the key schema for the table and indexes. Duplicates are allowed. _Required_: Yes _Type_: List of [DynamoDB Table AttributeDefinition](aws-properties-dynamodb-attributedef.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: List update_requires: no_interruption GlobalSecondaryIndexes: description: "Global secondary indexes to be created on the table. You can create up to 5 global secondary indexes.\n\nImportant\n\nIf you update a table to include a new global secondary index, AWS CloudFormation initiates the index creation and then proceeds with the stack update. AWS CloudFormation doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is `ACTIVE`. You can track its status by using the DynamoDB [`DescribeTable`](http://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command.\n\nIf you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index.\n\n_Required_: No\n\n_Type_: List of [DynamoDB Table GlobalSecondaryIndex](aws-properties-dynamodb-gsi.html)\n\n_Update requires_: Updates are not supported. The following are exceptions:\n\n- \n\nIf you update only the provisioned throughput values of global secondary indexes, you can update the table [without interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt).\n\n- \n\nYou can delete or add one global secondary index [without interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). If you do both in the same update (for example, by changing the index's logical ID), the update fails.\n\n" required: 'no' type: List update_requires: KeySchema: description: |+ Specifies the attributes that make up the primary key for the table. The attributes in the `KeySchema` property must also be defined in the `AttributeDefinitions` property. _Required_: Yes _Type_: List of [DynamoDB Table KeySchema](aws-properties-dynamodb-keyschema.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: List update_requires: replacement LocalSecondaryIndexes: description: |+ Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes. _Required_: No _Type_: List of [DynamoDB Table LocalSecondaryIndex](aws-properties-dynamodb-lsi.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement ProvisionedThroughput: description: |+ Throughput for the specified table, which consists of values for `ReadCapacityUnits` and `WriteCapacityUnits`. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](aws-properties-dynamodb-provisionedthroughput.html). _Required_: Yes _Type_: [DynamoDB Table ProvisionedThroughput](aws-properties-dynamodb-provisionedthroughput.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: DynamoDB Table ProvisionedThroughput update_requires: no_interruption StreamSpecification: description: |+ The settings for the DynamoDB table stream, which capture changes to items stored in the table. _Required_: No _Type_: [DynamoDB Table StreamSpecification](aws-properties-dynamodb-streamspecification.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) to the table. However, the stream is replaced. required: 'no' type: DynamoDB Table StreamSpecification update_requires: no_interruption TableName: description: |+ A name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Tags: description: |+ Specifies an arbitrary set of tags (key–value pairs) to associate with this table. Use tags to manage your resources. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption TimeToLiveSpecification: description: |+ Specifies the Time to Live (TTL) settings for the table. _Required:_ No _Type_: [DynamoDB Table TimeToLiveSpecification](aws-properties-dynamodb-table-timetolivespecification.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: DynamoDB Table TimeToLiveSpecification update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For example: Copy{ "Ref": "MyResource" } For the resource with the logical ID `myDynamoDBTable`, `Ref` will return the DynamoDB table name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ The Amazon Resource Name (ARN) of the DynamoDB table, such as `arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable`. StreamArn: description: |+ The ARN of the DynamoDB stream, such as `arn:aws:dynamodb:us-east-1:123456789012:table/testddbstack-myDynamoDBTable-012A1SL7SMP5Q/stream/2015-11-30T20:10:00.000`. Note You must specify the `StreamSpecification` property to use this attribute. examples: {} AWS::EC2::CustomerGateway: description: Provides information to AWS about your VPN customer gateway device. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html properties: BgpAsn: description: |+ The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). _Required:_ Yes _Type_: Number BgpAsn is always an integer value. _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: Number BgpAsn is always an integer value. update_requires: replacement IpAddress: description: |+ The internet-routable IP address for the customer gateway's outside interface. The address must be static. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Tags: description: |+ The tags that you want to attach to the resource. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html). _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: AWS CloudFormation Resource Tags. update_requires: no_interruption Type: description: |+ The type of VPN connection that this customer gateway supports. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) _Example_: `ipsec.1` required: 'yes' type: String update_requires: replacement return_values: Ref: description: '' examples: {} AWS::EC2::DHCPOptions: description: |- Creates a set of DHCP options for your VPC. For more information, see [CreateDhcpOptions](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateDhcpOptions.html) in the _Amazon EC2 API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html properties: DomainName: description: |+ A domain name of your choice. _Required_: Conditional; see [note](aws-resource-ec2-dhcp-options.html#dhcp-options-conditional-note). _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) _Example_: `"example.com"` required: conditional type: String update_requires: replacement DomainNameServers: description: |+ The IP (IPv4) address of a domain name server. You can specify up to four addresses. _Required_: Conditional; see [note](aws-resource-ec2-dhcp-options.html#dhcp-options-conditional-note). _Type_: List of String values _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) _Example_: `"DomainNameServers" : [ "10.0.0.1", "10.0.0.2" ]` _Example_: To preserve the order of IP addresses, specify a comma delimited list as a single string: `"DomainNameServers" : ["10.0.0.1, 10.0.0.2"]` required: conditional type: List update_requires: replacement NetbiosNameServers: description: |+ The IP address (IPv4) of a NetBIOS name server. You can specify up to four addresses. _Required_: Conditional; see [note](aws-resource-ec2-dhcp-options.html#dhcp-options-conditional-note). _Type_: List of String values _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) _Example_: `"NetbiosNameServers" : ["10.0.0.1", "10.0.0.2"]` _Example_: To preserve the order of IP addresses, specify a comma delimited list as a single string: `"NetbiosNameServers" : ["10.0.0.1, 10.0.0.2"]` required: conditional type: List update_requires: replacement NetbiosNodeType: description: "An integer value indicating the NetBIOS node type:\n\n- \n\n**1** : Broadcast (\"B\")\n\n- \n\n**2** : Point-to-point (\"P\")\n\n- \n\n**4** : Mixed mode (\"M\")\n\n- \n\n**8** : Hybrid (\"H\")\n\nFor more information about these values and about NetBIOS node types, see [RFC 2132](http://www.ietf.org/rfc/rfc2132.txt), [RFC 1001](http://tools.ietf.org/rfc/rfc1001.txt), and [RFC 1002](http://tools.ietf.org/rfc/rfc1002.txt). We recommend that you use only the value `2` at this time (broadcast and multicast are not currently supported).\n\n_Required:_ Required if `NetBiosNameServers` is specified; optional otherwise.\n\n_Type_: List of numbers\n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n\n_Example_: `\"NetbiosNodeType\" : 2`\n\n" required: type: List update_requires: replacement NtpServers: description: |+ The IP address (IPv4) of a Network Time Protocol (NTP) server. You can specify up to four addresses. _Required_: Conditional; see [note](aws-resource-ec2-dhcp-options.html#dhcp-options-conditional-note). _Type_: List of String values _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) _Example_: `"NtpServers" : ["10.0.0.1"]` _Example_: To preserve the order of IP addresses, specify a comma delimited list as a single string: `"NtpServers" : ["10.0.0.1, 10.0.0.2"]` required: conditional type: List update_requires: replacement Tags: description: |+ An arbitrary set of tags (key–value pairs) for this resource. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::EgressOnlyInternetGateway: description: The `AWS::EC2::EgressOnlyInternetGateway` resource creates an egress-only Internet gateway for your VPC (over IPv6 only). An egress-only Internet gateway enables outbound communication over IPv6 from instances in your VPC to the Internet. It also prevents hosts outside of your VPC from initiating an IPv6 connection with your instance. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-egressonlyinternetgateway.html properties: VpcId: description: |+ The ID of the VPC for which to create the egress-only Internet gateway. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the ID of the egress-only Internet gateway (the physical resource ID). For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::EIP: description: The AWS::EC2::EIP resource allocates an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html properties: InstanceId: description: |+ The Instance ID of the Amazon EC2 instance that you want to associate with this Elastic IP address. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Domain: description: |+ Set to `vpc` to allocate the address to your Virtual Private Cloud (VPC). No other values are supported. Note If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the `DependsOn` attribute on this resource. For more information, see [DependsOn Attribute](aws-attribute-dependson.html). For more information, see [AllocateAddress](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-AllocateAddress.html) in the _Amazon EC2 API Reference_. For more information about Elastic IP Addresses in VPC, go to [IP Addressing in Your VPC](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-ip-addressing.html) in the _Amazon VPC User Guide_. _Required_: Conditional. Required when allocating an address to a VPC _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement return_values: Ref: description: |- When you specify the logical ID of an AWS::EC2::EIP object as an argument to the `Ref` function, AWS CloudFormation returns the value of the instance's `PublicIp`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). AllocationId: description: |+ The ID that AWS assigns to represent the allocation of the address for use with Amazon VPC. This is returned only for VPC elastic IP addresses. Example return value: `eipalloc-5723d13e` examples: {} AWS::EC2::EIPAssociation: description: |- The AWS::EC2::EIPAssociation resource type associates an Elastic IP address with an Amazon EC2 instance. The Elastic IP address can be an existing Elastic IP address or an Elastic IP address allocated through an [AWS::EC2::EIP resource](aws-properties-ec2-eip.html). For more information EC2-Classic and EC2-VPC, see [AssociateAddress](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AssociateAddress.html) in the _Amazon EC2 API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html properties: AllocationId: description: |+ [EC2-VPC] Allocation ID for the VPC Elastic IP address you want to associate with an Amazon EC2 instance in your VPC. _Required_: Conditional. Required for EC2-VPC. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) if you also change the `InstanceId` or `NetworkInterfaceId` property. If not, update requires [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: conditional type: String update_requires: replacement EIP: description: |+ Elastic IP address that you want to associate with the Amazon EC2 instance specified by the `InstanceId` property. You can specify an existing Elastic IP address or a reference to an Elastic IP address allocated with a [AWS::EC2::EIP resource](aws-properties-ec2-eip.html). _Required_: Conditional. Required for EC2-Classic. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) if you also change the `InstanceId` or `NetworkInterfaceId` property. If not, update requires [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: conditional type: String update_requires: replacement InstanceId: description: |+ Instance ID of the Amazon EC2 instance that you want to associate with the Elastic IP address specified by the EIP property. If the instance has more than one network interface, you must specify a network interface ID. _Required_: Conditional. If you specify the `EIP` property, you must specify this property. If you specify the `AllocationId` property, you must specify this property or the `NetworkInterfaceId` property. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) if you also change the `AllocationId` or `EIP` property. If not, update requires [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: conditional type: String update_requires: replacement NetworkInterfaceId: description: |+ [EC2-VPC] The ID of the network interface to associate with the Elastic IP address. If the instance has more than one network interface, you must specify a network interface ID. _Required_: Conditional. If you specify the `AllocationId` property, you must specify this property or the `InstanceId` property. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) if you also change the `AllocationId` or `EIP` property. If not, update requires [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: conditional type: String update_requires: replacement PrivateIpAddress: description: |+ [EC2-VPC] The private IP address that you want to associate with the Elastic IP address. The private IP address is restricted to the primary and secondary private IP addresses that are associated with the network interface. By default, the private IP address that is associated with the EIP is the primary private IP address of the network interface. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::FlowLog: description: The `AWS::EC2::FlowLog` resource creates an Amazon Elastic Compute Cloud (Amazon EC2) flow log that captures IP traffic for a specified network interface, subnet, or VPC. To view the log data, use Amazon CloudWatch Logs (CloudWatch Logs) to help troubleshoot connection issues. For example, you can use a flow log to investigate why certain traffic isn't reaching an instance, which can help you diagnose overly restrictive security group rules. For more information, see [VPC Flow Logs](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/flow-logs.html) in the _Amazon VPC User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html properties: DeliverLogsPermissionArn: description: |+ The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement LogGroupName: description: |+ The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement ResourceId: description: |+ The ID of the subnet, network interface, or VPC for which you want to create a flow log. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement ResourceType: description: |+ The type of resource that you specified in the `ResourceId` property. For example, if you specified a VPC ID for the `ResourceId` property, specify `VPC` for this property. For valid values, see the `ResourceType` parameter for the [CreateFlowLogs](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFlowLogs.html) action in the _Amazon EC2 API Reference_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement TrafficType: description: |+ The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic. For valid values, see the `TrafficType` parameter for the [CreateFlowLogs](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFlowLogs.html) action in the _Amazon EC2 API Reference_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the flow log ID, such as `fl-1a23b456`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::Host: description: The `AWS::EC2::Host` resource allocates a fully dedicated physical server for launching EC2 instances. Because the host is fully dedicated for your use, it can help you address compliance requirements and reduce costs by allowing you to use your existing server-bound software licenses. For more information, see [Dedicated Hosts](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html) in the _Amazon EC2 User Guide for Linux Instances_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html properties: AutoPlacement: description: |+ Indicates if the host accepts EC2 instances with only matching configurations or if instances must also specify the host ID. Instances that don't specify a host ID can't launch onto a host with `AutoPlacement` set to `off`. By default, AWS CloudFormation sets this property to `on`. For more information, see [Understanding Instance Placement and Host Affinity](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-instance-placement.html) in the _Amazon EC2 User Guide for Linux Instances_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption AvailabilityZone: description: |+ The Availability Zone (AZ) in which to launch the dedicated host. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement InstanceType: description: |+ The instance type that the dedicated host accepts. Only instances of this type can be launched onto the host. For more information, see [Supported Instance Types](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html#dedicated-hosts-supported-instance-types) in the _Amazon EC2 User Guide for Linux Instances_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the host ID, such as `h-0ab123c45d67ef89`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::Instance: description: |- The `AWS::EC2::Instance` resource creates an EC2 instance. If an Elastic IP address is attached to your instance, AWS CloudFormation reattaches the Elastic IP address after it updates the instance. For more information about updating stacks, see [AWS CloudFormation Stacks Updates](using-cfn-updating-stacks.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html properties: Affinity: description: |+ Indicates whether Amazon Elastic Compute Cloud (Amazon EC2) always associates the instance with a [dedicated host](aws-properties-ec2-instance.html#cfn-ec2-instance-hostid). If you want Amazon EC2 to always restart the instance (if it was stopped) onto the same host on which it was launched, specify `host`. If you want Amazon EC2 to restart the instance on any available host, but to try to launch the instance onto the last host it ran on (on a best-effort basis), specify `default`. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption AvailabilityZone: description: |+ Specifies the name of the Availability Zone in which the instance is located. For more information about AWS regions and Availability Zones, see [Regions and Availability Zones](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) in the _Amazon EC2 User Guide_. _Required:_ No. If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the region. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement BlockDeviceMappings: description: |+ Defines a set of Amazon Elastic Block Store block device mappings, ephemeral instance store block device mappings, or both. For more information, see [Amazon Elastic Block Store](http://docs.aws.amazon.com/AWSEC2/latest/DeveloperGuide/AmazonEBS.html) or [Amazon EC2 Instance Store](http://docs.aws.amazon.com/AWSEC2/latest/DeveloperGuide/InstanceStorage.html) in the _Amazon EC2 User Guide for Linux Instances_. _Required:_ No _Type_: A list of [Amazon EC2 Block Device Mapping Property](aws-properties-ec2-blockdev-mapping.html). _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement). If you change only the `DeleteOnTermination` property for one or more block devices, update requires [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: A list of Amazon EC2 Block Device Mapping Property. update_requires: replacement DisableApiTermination: description: |+ Specifies whether the instance can be terminated through the API. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption EbsOptimized: description: "Specifies whether the instance is optimized for Amazon Elastic Block Store I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal `EBS` I/O performance.\n\nFor more information about the instance types that can be launched as Amazon EBS optimized instances, see [Amazon EBS-Optimized Instances](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) in the _Amazon Elastic Compute Cloud User Guide_. Additional fees are incurred when using Amazon EBS-optimized instances.\n\n_Required:_ No. By default, AWS CloudFormation specifies `false`.\n\n_Type_: Boolean\n\n_Update requires_:\n\n- \n\n_Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) for Amazon EBS-backed instances\n\n- \n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) for instance store-backed instances\n\n" required: 'no' type: Boolean update_requires: replacement HostId: description: |+ If you specify `host` for the `Affinity` property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account. This type of launch is called an untargeted launch. Note that for untargeted launches, you must have a compatible, dedicated host available to successfully launch instances. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption IamInstanceProfile: description: |+ The name of an instance profile or a reference to an [AWS::IAM::InstanceProfile](aws-resource-iam-instanceprofile.html) resource. For more information about IAM roles, see [Working with Roles](http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html) in the _AWS Identity and Access Management User Guide_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption ImageId: description: |+ Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement InstanceInitiatedShutdownBehavior: description: |+ Indicates whether an instance stops or terminates when you shut down the instance from the instance's operating system shutdown command. You can specify `stop` or `terminate`. For more information, see the [RunInstances](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-RunInstances.html) command in the _Amazon EC2 API Reference_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption InstanceType: description: "The instance type, such as `t2.micro`. The default type is `\"m3.medium\"`. For a list of instance types, see [Instance Families and Types](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html).\n\n_Required:_ No\n\n_Type_: String\n\n_Update requires_:\n\n- \n\n_Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) for Amazon EBS-backed instances\n\n- \n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) for instance store-backed instances\n\n" required: 'no' type: String update_requires: replacement Ipv6AddressCount: description: |+ The number of IPv6 addresses to associate with the instance's primary network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the `Ipv6Addresses` property and don't specify this property. For restrictions on which instance types support IPv6 addresses, see the [RunInstances](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-RunInstances.html) action in the _Amazon EC2 API Reference_. _Required:_ No _Type_: Integer _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Number update_requires: replacement Ipv6Addresses: description: |+ One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the instance's primary network interface. To specify a number of IPv6 addresses, use the `Ipv6AddressCount` property and don't specify this property. For information about restrictions on which instance types support IPv6 addresses, see the [RunInstances](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-RunInstances.html) action in the _Amazon EC2 API Reference_. _Required:_ No _Type_: List of [EC2 NetworkInterface Ipv6Addresses](aws-properties-ec2-networkinterface-ipv6addresses.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement KernelId: description: "The kernel ID.\n\n_Required:_ No\n\n_Type_: String\n\n_Update requires_:\n\n- \n\n_Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) for Amazon EBS-backed instances\n\n- \n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) for instance store-backed instances\n\n" required: 'no' type: String update_requires: replacement KeyName: description: |+ Provides the name of the Amazon EC2 key pair. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Monitoring: description: |+ Specifies whether detailed monitoring is enabled for the instance. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption NetworkInterfaces: description: |+ A list of embedded objects that describes the network interfaces to associate with this instance. Note If you use this property to point to a network interface, you must terminate the original interface before attaching a new one to allow the update of the instance to succeed. If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the `DependsOn` attribute to declare a dependency on the VPC-gateway attachment. For more information, see [DependsOn Attribute](aws-attribute-dependson.html). _Required:_ No _Type_: A list of [EC2 NetworkInterface Embedded Property Type](aws-properties-ec2-network-iface-embedded.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: |- A list of EC2 NetworkInterface Embedded Property Type update_requires: replacement PlacementGroupName: description: |+ The name of an existing placement group that you want to launch the instance into (for cluster instances). _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement PrivateIpAddress: description: |+ The private IP address for this instance. Important If you make an update to an instance that requires replacement, you must assign a new private IP address. During a replacement, AWS CloudFormation creates a new instance but doesn't delete the old instance until the stack has successfully updated. If the stack update fails, AWS CloudFormation uses the old instance in order to roll back the stack to the previous working state. The old and new instances cannot have the same private IP address. (Optional) If you're using Amazon VPC, you can use this parameter to assign the instance a specific available IP address from the subnet (for example, 10.0.0.25). By default, Amazon VPC selects an IP address from the subnet for the instance. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement RamdiskId: description: "The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the AWS Resource Center and search for the kernel ID.\n\n_Required:_ No\n\n_Type_: String\n\n_Update requires_:\n\n- \n\n_Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) for Amazon EBS-backed instances\n\n- \n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) for instance store-backed instances\n\n" required: 'no' type: String update_requires: replacement SecurityGroupIds: description: "A list that contains the security group IDs for VPC security groups to assign to the Amazon EC2 instance. If you specified the `NetworkInterfaces` property, do not specify this property.\n\n_Required_: Conditional. Required for VPC security groups.\n\n_Type_: List of String values\n\n_Update requires_:\n\n- \n\n_Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) for instances that are in a VPC.\n\n- \n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) for instances that are not in a VPC.\n\n" required: conditional type: List update_requires: replacement SecurityGroups: description: |+ Valid only for Amazon EC2 security groups. A list that contains the Amazon EC2 security groups to assign to the Amazon EC2 instance. The list can contain both the name of existing Amazon EC2 security groups or references to AWS::EC2::SecurityGroup resources created in the template. _Required:_ No _Type_: List of String values _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement). required: 'no' type: List update_requires: replacement SourceDestCheck: description: |+ Controls whether source/destination checking is enabled on the instance. Also determines if an instance in a VPC will perform network address translation (NAT). A value of `"true"` means that source/destination checking is enabled, and a value of `"false"` means that checking is disabled. For the instance to perform NAT, the value _must_ be `"false"`. For more information, see [NAT Instances](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html) in the _Amazon Virtual Private Cloud User Guide_. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption SsmAssociations: description: |+ The Amazon EC2 Systems Manager (SSM) [document](aws-resource-ssm-document.html) and parameter values to associate with this instance. To use this property, you must specify an IAM role for the instance. For more information, see [Prerequisites for Remotely Running Commands on EC2 Instances](http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/remote-commands-prereq.html) in the _Amazon EC2 User Guide for Windows Instances_. Note You can currently associate only one document with an instance. _Required:_ No _Type_: List of [Amazon EC2 Instance SsmAssociations](aws-properties-ec2-instance-ssmassociations.html). _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption SubnetId: description: |+ If you're using Amazon VPC, this property specifies the ID of the subnet that you want to launch the instance into. If you specified the `NetworkInterfaces` property, do not specify this property. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Tags: description: |+ An arbitrary set of tags (key–value pairs) for this instance. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption Tenancy: description: "The tenancy of the instance that you want to launch, such as `default`, `dedicated`, or `host`. If you specify a tenancy value of `dedicated` or `host`, you must launch the instance in a VPC. For more information, see [Dedicated Instances](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/dedicated-instance.html) in the _Amazon VPC User Guide_.\n\n_Required:_ No\n\n_Type_: String\n\n_Update requires_:\n\n- \n\n_Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) if this property was set to `dedicated` and you change it to `host` or vice versa.\n\n- \n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) for all other changes.\n\n" required: 'no' type: String update_requires: replacement UserData: description: "Base64-encoded MIME user data that is made available to the instances.\n\n_Required:_ No\n\n_Type_: String\n\n_Update requires_:\n\n- \n\n_Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) for Amazon EBS-backed instances.\n\nNote\n\nFor EBS-backed instances, changing the `UserData` stops and then starts the instance; however, Amazon EC2 doesn't automatically run the updated `UserData`. To update configurations on your instance, use the [cfn-hup](cfn-hup.html) helper script.\n\n- \n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) for instance store-backed instances.\n\n" required: 'no' type: String update_requires: replacement Volumes: description: |+ The Amazon EBS volumes to attach to the instance. Note Before detaching a volume, unmount any file systems on the device within your operating system. If you don't unmount the file system, a volume might get stuck in a busy state while detaching. _Required:_ No _Type_: A list of [EC2 MountPoints](aws-properties-ec2-mount-point.html). _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: A list of EC2 MountPoints. update_requires: no_interruption AdditionalInfo: description: "Reserved.\n\n_Required:_ No\n\n_Type_: String\n\n_Update requires_:\n\n- \n\n_Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) for Amazon EBS-backed instances\n\n- \n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) for instance store-backed instances\n\n" required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When you pass the logical ID of an AWS::EC2::Instance object to the intrinsic `Ref` function, the object's InstanceId is returned. For example: `i-636be302`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). AvailabilityZone: description: |+ The Availability Zone where the specified instance is launched. For example: `us-east-1b`. You can retrieve a list of all Availability Zones for a region by using the [`Fn::GetAZs`](intrinsic-function-reference-getavailabilityzones.html) intrinsic function. PrivateDnsName: description: |+ The private DNS name of the specified instance. For example: `ip-10-24-34-0.ec2.internal`. PublicDnsName: description: |+ The public DNS name of the specified instance. For example: `ec2-107-20-50-45.compute-1.amazonaws.com`. PrivateIp: description: |+ The private IP address of the specified instance. For example: `10.24.34.0`. PublicIp: description: |+ The public IP address of the specified instance. For example: `192.0.2.0`. examples: {} AWS::EC2::InternetGateway: description: Creates a new Internet gateway in your AWS account. After creating the Internet gateway, you then attach it to a VPC. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-internetgateway.html properties: Tags: description: |+ An arbitrary set of tags (key–value pairs) for this resource. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::NatGateway: description: |- The `AWS::EC2::NatGateway` resource creates a network address translation (NAT) gateway in the specified public subnet. Use a NAT gateway to allow instances in a private subnet to connect to the Internet or to other AWS services, but prevent the Internet from initiating a connection with those instances. For more information and a sample architectural diagram, see [NAT Gateways](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-nat-gateway.html) in the _Amazon VPC User Guide_. Note If you add a default route (`AWS::EC2::Route` resource) that points to a NAT gateway, specify NAT gateway's ID for the route's `NatGatewayId` property. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html properties: AllocationId: description: |+ The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement SubnetId: description: |+ The public subnet in which to create the NAT gateway. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Tags: description: |+ Specifies an arbitrary set of tags (key–value pairs) to associate with this resource. Use tags to manage your resources. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::EC2::NatGateway` resource to the intrinsic `Ref` function, the function returns the ID of the NAT gateway, such as `nat-0a12bc456789de0fg`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::NetworkAcl: description: Creates a new network ACL in a VPC. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl.html properties: Tags: description: |+ An arbitrary set of tags (key–value pairs) for this ACL. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption VpcId: description: |+ The ID of the VPC where the network ACL will be created. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::NetworkAclEntry: description: Creates an entry (i.e., a rule) in a network ACL with a rule number you specify. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html properties: CidrBlock: description: |+ The IPv4 CIDR range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24). _Required:_ Conditional. You must specify the `CidrBlock` or `Ipv6CidrBlock` property. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption Egress: description: |+ Whether this rule applies to egress traffic from the subnet (`true`) or ingress traffic to the subnet (`false`). By default, AWS CloudFormation specifies `false`. _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement). required: 'no' type: Boolean update_requires: replacement Icmp: description: |+ The Internet Control Message Protocol (ICMP) code and type. _Required:_ Conditional required if specifying 1 (ICMP) for the protocol parameter. _Type_: [EC2 NetworkAclEntry Icmp](aws-properties-ec2-networkaclentry-icmp.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: EC2 NetworkAclEntry Icmp update_requires: no_interruption Ipv6CidrBlock: description: |+ The IPv6 CIDR range to allow or deny, in CIDR notation. _Required:_ Conditional. You must specify the `CidrBlock` or `Ipv6CidrBlock` property. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption NetworkAclId: description: |+ ID of the ACL where the entry will be created. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement). required: 'yes' type: String update_requires: replacement PortRange: description: |+ The range of port numbers for the UDP/TCP protocol. _Required:_ Conditional Required if specifying 6 (TCP) or 17 (UDP) for the protocol parameter. _Type_: [EC2 NetworkAclEntry PortRange](aws-properties-ec2-networkaclentry-portrange.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: |- EC2 NetworkAclEntry PortRange update_requires: no_interruption Protocol: description: |+ The IP protocol that the rule applies to. You must specify `-1` or a protocol number (go to [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) at iana.org). You can specify `-1` for all protocols. Note If you specify `-1`, all ports are opened and the `PortRange` property is ignored. _Required:_ Yes _Type_: Number _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Number update_requires: no_interruption RuleAction: description: |+ Whether to allow or deny traffic that matches the rule; valid values are "allow" or "deny". _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption RuleNumber: description: |+ Rule number to assign to the entry, such as `100`. ACL entries are processed in ascending order by rule number. Entries can't use the same rule number unless one is an egress rule and the other is an ingress rule. For valid values, see the [CreateNetworkAclEntry](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkAclEntry.html) action in the _Amazon EC2 API Reference_. _Required:_ Yes _Type_: Number _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement). required: 'yes' type: Number update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::NetworkInterface: description: Describes a network interface in an Elastic Compute Cloud (EC2) instance for AWS CloudFormation. This is provided in a list in the `NetworkInterfaces` property of [AWS::EC2::Instance](aws-properties-ec2-instance.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html properties: Description: description: |+ The description of this network interface. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: String update_requires: no_interruption GroupSet: description: |+ A list of security group IDs associated with this network interface. _Required:_ No _Type_: List of strings. _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Ipv6AddressCount: description: |+ The number of IPv6 addresses to associate with the network interface. EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the `Ipv6Addresses` property and don't specify this property. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption Ipv6Addresses: description: |+ One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the `Ipv6AddressCount` property and don't specify this property. _Required:_ No _Type_: List of [EC2 NetworkInterface Ipv6Addresses](aws-properties-ec2-networkinterface-ipv6addresses.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption PrivateIpAddress: description: |+ Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the `PrivateIpAddresses` property. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement). required: 'no' type: String update_requires: replacement PrivateIpAddresses: description: |+ Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the `Primary` property to `true` in the `PrivateIpAddressSpecification` property. If you want EC2 to automatically assign private IP addresses, use the `SecondaryPrivateIpAddressCount` property and do not specify this property. For information about the maximum number of private IP addresses, see [Private IP Addresses Per ENI Per Instance Type](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI) in the _Amazon EC2 User Guide for Linux Instances_. _Required:_ No _Type_: list of [PrivateIpAddressSpecification](aws-properties-ec2-network-interface-privateipspec.html). _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) if you change the primary private IP address. If not, update requires [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: List update_requires: replacement SecondaryPrivateIpAddressCount: description: |+ The number of secondary private IP addresses that EC2 automatically assigns to the network interface. EC2 uses the value of the `PrivateIpAddress` property as the primary private IP address. If you don't specify that property, EC2 automatically assigns both the primary and secondary private IP addresses. If you want to specify your own list of private IP addresses, use the `PrivateIpAddresses` property and do not specify this property. For information about the maximum number of private IP addresses, see [Private IP Addresses Per ENI Per Instance Type](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI) in the _Amazon EC2 User Guide for Linux Instances_. _Required:_ No _Type_: Integer. _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: Integer. update_requires: no_interruption SourceDestCheck: description: |+ Flag indicating whether traffic to or from the instance is validated. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: Boolean update_requires: no_interruption SubnetId: description: |+ The ID of the subnet to associate with the network interface. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement). required: 'yes' type: String update_requires: replacement Tags: description: |+ An arbitrary set of tags (key–value pairs) for this network interface. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). PrimaryPrivateIpAddress: description: |+ Returns the primary private IP address of the network interface. For example, `10.0.0.192`. SecondaryPrivateIpAddresses: description: |+ Returns the secondary private IP addresses of the network interface. For example, `["10.0.0.161", "10.0.0.162", "10.0.0.163"]`. examples: {} AWS::EC2::NetworkInterfaceAttachment: description: Attaches an elastic network interface (ENI) to an Amazon EC2 instance. You can use this resource type to attach additional network interfaces to an instances without interruption. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html properties: DeleteOnTermination: description: |+ Whether to delete the network interface when the instance terminates. By default, this value is set to `True`. _Required:_ No _Type_: Boolean. _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption DeviceIndex: description: |+ The network interface's position in the attachment order. For example, the first attached network interface has a `DeviceIndex` of `0`. _Required_: Yes. _Type_: String. _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String. update_requires: no_interruption InstanceId: description: |+ The ID of the instance to which you will attach the ENI. _Required_: Yes. _Type_: String. _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String. update_requires: no_interruption NetworkInterfaceId: description: |+ The ID of the ENI that you want to attach. _Required_: Yes. _Type_: String. _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String. update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::NetworkInterfacePermission: description: The `AWS::EC2::NetworkInterfacePermission` resource specifies a permission for an Amazon EC2 network interface. For example, you can grant an AWS authorized partner account permission to attach the specified network interface to an instance in their account. For more information, see [CreateNetworkInterfacePermission](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterfacePermission.html) and [NetworkInterfacePermission](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_NetworkInterfacePermission.html) in the _Amazon EC2 API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html properties: AwsAccountId: description: |+ The AWS account ID. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement NetworkInterfaceId: description: |+ The ID of the network interface. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Permission: description: |+ The type of permission to grant: `INSTANCE-ATTACH` or `EIP-ASSOCIATE`. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When you pass the logical ID of an `AWS::EC2::NetworkInterfacePermission` resource to the intrinsic `Ref` function, the function returns the network interface permission ID. For example, `eni-perm-055663b682ea24b48`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::PlacementGroup: description: The `AWS::EC2::PlacementGroup` resource is a logical grouping of instances within a single Availability Zone (AZ) that enables applications to participate in a low-latency, 10 Gbps network. You create a placement group first, and then you can launch instances in the placement group. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-placementgroup.html properties: Strategy: description: |+ The placement strategy, which relates to the instance types that can be added to the placement group. For example, for the `cluster` strategy, you can cluster C4 instance types but not T2 instance types. For valid values, see [CreatePlacementGroup](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreatePlacementGroup.html) in the _Amazon EC2 API Reference_. By default, AWS CloudFormation sets the value of this property to `cluster`. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::Route: description: The `AWS::EC2::Route` resource creates a new route in a route table within a VPC. The route's target can be either a gateway attached to the VPC or a NAT instance in the VPC. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html properties: DestinationCidrBlock: description: |+ The IPv4 CIDR address block used for the destination match. For example, `0.0.0.0/0`. Routing decisions are based on the most specific match. _Required:_ Conditional. You must specify the `DestinationCidrBlock` or `DestinationIpv6CidrBlock` property. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement DestinationIpv6CidrBlock: description: |+ The IPv6 CIDR address block used for the destination match. For example, `::/0`. Routing decisions are based on the most specific match. _Required:_ Conditional. You must specify the `DestinationCidrBlock` or `DestinationIpv6CidrBlock` property. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement EgressOnlyInternetGatewayId: description: |+ The ID of an egress-only internet gateway that is attached to your VPC (over IPv6 only). _Required:_ Conditional. You must specify only one of the following properties: `EgressOnlyInternetGatewayId`, `GatewayId`, `InstanceId`, `NatGatewayId`, `NetworkInterfaceId`, or `VpcPeeringConnectionId`. For an example that uses this property, see [Amazon EC2 Route with Egress-Only Internet Gateway](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2.html#quickref-ec2-route-egressonlyinternetgateway). _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption GatewayId: description: |+ The ID of an internet gateway or virtual private gateway that is attached to your VPC. For example: `igw-eaad4883`. For route entries that specify a gateway, you must specify a dependency on the gateway attachment resource. For more information, see [DependsOn Attribute](aws-attribute-dependson.html). _Required:_ Conditional. You must specify only one of the following properties: `EgressOnlyInternetGatewayId`, `GatewayId`, `InstanceId`, `NatGatewayId`, `NetworkInterfaceId`, or `VpcPeeringConnectionId`. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption InstanceId: description: |+ The ID of a NAT instance in your VPC. For example, `i-1a2b3c4d`. _Required:_ Conditional. You must specify only one of the following properties: `EgressOnlyInternetGatewayId`, `GatewayId`, `InstanceId`, `NatGatewayId`, `NetworkInterfaceId`, or `VpcPeeringConnectionId`. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption NatGatewayId: description: |+ The ID of a NAT gateway. For example, `nat-0a12bc456789de0fg`. _Required:_ Conditional. You must specify only one of the following properties: `EgressOnlyInternetGatewayId`, `GatewayId`, `InstanceId`, `NatGatewayId`, `NetworkInterfaceId`, or `VpcPeeringConnectionId`. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption NetworkInterfaceId: description: |+ Allows the routing of network interface IDs. _Required:_ Conditional. You must specify only one of the following properties: `EgressOnlyInternetGatewayId`, `GatewayId`, `InstanceId`, `NatGatewayId`, `NetworkInterfaceId`, or `VpcPeeringConnectionId`. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption RouteTableId: description: |+ The ID of the [route table](aws-resource-ec2-route-table.html) where the route will be added. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement VpcPeeringConnectionId: description: |+ The ID of a VPC peering connection. _Required:_ Conditional. You must specify only one of the following properties: `EgressOnlyInternetGatewayId`, `GatewayId`, `InstanceId`, `NatGatewayId`, `NetworkInterfaceId`, or `VpcPeeringConnectionId`. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::RouteTable: description: Creates a new route table within a VPC. After you create a new route table, you can add routes and associate the table with a subnet. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route-table.html properties: VpcId: description: |+ The ID of the VPC where the route table will be created. Example: vpc-11ad4878 _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Tags: description: |+ An arbitrary set of tags (key–value pairs) for this route table. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption return_values: Ref: description: |- When you specify an `AWS::EC2::RouteTable` type as an argument to the `Ref` function, AWS CloudFormation returns the route table ID, such as `rtb-12a34567`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::SecurityGroup: description: |- Creates an Amazon EC2 security group. To create a VPC security group, use the [VpcId](aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-vpcid) property. This type supports updates. For more information about updating stacks, see [AWS CloudFormation Stacks Updates](using-cfn-updating-stacks.html). Important If you want to cross-reference two security groups in the ingress and egress rules of those security groups, use the [AWS::EC2::SecurityGroupEgress](aws-resource-ec2-security-group-egress.html) and [AWS::EC2::SecurityGroupIngress](aws-properties-ec2-security-group-ingress.html) resources to define your rules. Do not use the embedded ingress and egress rules in the `AWS::EC2::SecurityGroup`. Doing so creates a circular dependency, which AWS CloudFormation doesn't allow. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html properties: GroupName: description: |+ The name of the security group. For valid values, see the [GroupName](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html) parameter of the `CreateSecurityGroup` action in the _Amazon EC2 API Reference_. If you don't specify a `GroupName`, AWS CloudFormation generates a unique physical ID and uses that ID for the group name. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement GroupDescription: description: |+ A description of the security group. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement SecurityGroupEgress: description: |+ A list of Amazon EC2 security group egress rules. _Required:_ No _Type_: List of [EC2 Security Group Rule](aws-properties-ec2-security-group-rule.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption SecurityGroupIngress: description: |+ A list of Amazon EC2 security group ingress rules. _Required:_ No _Type_: List of [EC2 Security Group Rule](aws-properties-ec2-security-group-rule.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Tags: description: |+ The tags that you want to attach to the resource. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html). _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags. update_requires: no_interruption VpcId: description: |+ The physical ID of the VPC. You can obtain the physical ID by using a reference to an [AWS::EC2::VPC](aws-resource-ec2-vpc.html), such as: `{ "Ref" : "myVPC" }`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). _Required_: Yes, for VPC security groups without a default VPC _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) Note For more information about VPC security groups, see [Security Groups](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html) in the _Amazon VPC User Guide_. required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When you specify an `AWS::EC2::SecurityGroup` type as an argument to the `Ref` function, AWS CloudFormation returns the security group name or the security group ID (for EC2-VPC security groups that are not in a default VPC). For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). GroupId: description: |+ The group ID of the specified security group, such as `sg-94b3a1f6`. examples: {} AWS::EC2::SecurityGroupEgress: description: |- The `AWS::EC2::SecurityGroupEgress` resource adds an egress rule to an Amazon VPC security group. Important Use `AWS::EC2::SecurityGroupIngress` and `AWS::EC2::SecurityGroupEgress` only when necessary, typically to allow security groups to reference each other in ingress and egress rules. Otherwise, use the embedded ingress and egress rules of [AWS::EC2::SecurityGroup](aws-properties-ec2-security-group.html). For more information, see [Amazon EC2 Security Groups](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html properties: CidrIp: description: |+ An IPv4 CIDR range. _Required:_ Conditional. You must specify a destination security group (`DestinationPrefixListId` or `DestinationSecurityGroupId`) or a CIDR range (`CidrIp` or `CidrIpv6`). _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement CidrIpv6: description: |+ An IPv6 CIDR range. _Type_: String _Required:_ Conditional. You must specify a destination security group (`DestinationPrefixListId` or `DestinationSecurityGroupId`) or a CIDR range (`CidrIp` or `CidrIpv6`). _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement Description: description: |+ Description of the egress rule. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption DestinationPrefixListId: description: |+ The AWS service prefix of an Amazon VPC endpoint. For more information, see [VPC Endpoints](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-endpoints.html) in the _Amazon VPC User Guide_. _Required:_ Conditional. You must specify a destination security group (`DestinationPrefixListId` or `DestinationSecurityGroupId`) or a CIDR range (`CidrIp` or `CidrIpv6`). _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement DestinationSecurityGroupId: description: |+ Specifies the group ID of the destination Amazon VPC security group. _Required:_ Conditional. You must specify a destination security group (`DestinationPrefixListId` or `DestinationSecurityGroupId`) or a CIDR range (`CidrIp` or `CidrIpv6`). _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement FromPort: description: |+ Start of port range for the TCP and UDP protocols, or an ICMP type number. If you specify `icmp` for the `IpProtocol` property, you can specify -1 as a wildcard (i.e., any ICMP type number). _Required:_ Yes _Type_: Integer _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: Number update_requires: replacement GroupId: description: |+ ID of the Amazon VPC security group to modify. This value can be a reference to an [AWS::EC2::SecurityGroup](aws-properties-ec2-security-group.html) resource that has a valid `VpcId` property or the ID of an existing Amazon VPC security group. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement IpProtocol: description: |+ IP protocol name or number. For valid values, see the IpProtocol parameter in [AuthorizeSecurityGroupIngress](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-AuthorizeSecurityGroupIngress.html) _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement ToPort: description: |+ End of port range for the TCP and UDP protocols, or an ICMP code. If you specify `icmp` for the `IpProtocol` property, you can specify -1 as a wildcard (i.e., any ICMP code). _Required:_ Yes _Type_: Integer _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: Number update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::SecurityGroupIngress: description: |- The `AWS::EC2::SecurityGroupIngress` resource adds an ingress rule to an Amazon EC2 or Amazon VPC security group. Important Use `AWS::EC2::SecurityGroupIngress` and `AWS::EC2::SecurityGroupEgress` only when necessary, typically to allow security groups to reference each other in ingress and egress rules. Otherwise, use the embedded ingress and egress rules of [AWS::EC2::SecurityGroup](aws-properties-ec2-security-group.html). For more information, see [Amazon EC2 Security Groups](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html properties: CidrIp: description: |+ An IPv4 CIDR range. For an overview of CIDR ranges, go to the [Wikipedia Tutorial](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). _Type_: String _Required:_ Conditional. You must specify a source security group (`SourceSecurityGroupName` or `SourceSecurityGroupId`) or a CIDR range (`CidrIp` or `CidrIpv6`). _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement CidrIpv6: description: |+ An IPv6 CIDR range. _Type_: String _Required:_ Conditional. You must specify a source security group (`SourceSecurityGroupName` or `SourceSecurityGroupId`) or a CIDR range (`CidrIp` or `CidrIpv6`). _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement Description: description: |+ Description of the ingress rule. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption FromPort: description: |+ Start of port range for the TCP and UDP protocols, or an ICMP type number. If you specify `icmp` for the `IpProtocol` property, you can specify -1 as a wildcard (i.e., any ICMP type number). _Type_: Integer _Required:_ Yes, for ICMP and any protocol that uses ports. _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: Number update_requires: replacement GroupId: description: |+ ID of the Amazon EC2 or VPC security group to modify. The group must belong to your account. _Type_: String _Required:_ Conditional. You must specify the `GroupName` property or the `GroupId` property. For security groups that are in a VPC, you must use the `GroupId` property. For example, [EC2-VPC](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html) accounts must use the `GroupId` property. _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement GroupName: description: |+ Name of the Amazon EC2 security group (non-VPC security group) to modify. This value can be a reference to an [AWS::EC2::SecurityGroup](aws-properties-ec2-security-group.html) resource or the name of an existing Amazon EC2 security group. _Type_: String _Required:_ Conditional. You must specify the `GroupName` property or the `GroupId` property. For security groups that are in a VPC, you must use the `GroupId` property. For example, [EC2-VPC](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html) accounts must use the `GroupId` property. _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement IpProtocol: description: |+ IP protocol name or number. For valid values, see the IpProtocol parameter in [AuthorizeSecurityGroupIngress](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-AuthorizeSecurityGroupIngress.html) _Type_: String _Required:_ Yes _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement SourceSecurityGroupId: description: |+ Specifies the ID of the source security group or uses the `Ref` intrinsic function to refer to the logical ID of a security group defined in the same template. _Type_: String _Required:_ Conditional. You must specify a source security group (`SourceSecurityGroupName` or `SourceSecurityGroupId`) or a CIDR range (`CidrIp` or `CidrIpv6`). _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement SourceSecurityGroupName: description: |+ Specifies the name of the Amazon EC2 security group (non-VPC security group) to allow access or use the `Ref` intrinsic function to refer to the logical ID of a security group defined in the same template. For instances in a VPC, specify the `SourceSecurityGroupId` property. _Type_: String _Required:_ Conditional. You must specify a source security group (`SourceSecurityGroupName` or `SourceSecurityGroupId`) or a CIDR range (`CidrIp` or `CidrIpv6`). _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement SourceSecurityGroupOwnerId: description: |+ Specifies the AWS Account ID of the owner of the Amazon EC2 security group specified in the `SourceSecurityGroupName` property. _Type_: String _Required:_ Conditional. If you specify `SourceSecurityGroupName` and that security group is owned by a different account than the account creating the stack, you must specify the `SourceSecurityGroupOwnerId`; otherwise, this property is optional. _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement ToPort: description: |+ End of port range for the TCP and UDP protocols, or an ICMP code. If you specify `icmp` for the `IpProtocol` property, you can specify -1 as a wildcard (i.e., any ICMP code). _Type_: Integer _Required:_ Yes, for ICMP and any protocol that uses ports. _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: Number update_requires: replacement return_values: Ref: description: '' examples: {} AWS::EC2::SpotFleet: description: The `AWS::EC2::SpotFleet` resource creates a request for a collection of Spot instances. The Spot fleet attempts to launch the number of Spot instances to meet the target capacity that you specified. For more information, see [Spot Instances](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances.html) in the _Amazon EC2 User Guide for Linux Instances_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html properties: SpotFleetRequestConfigData: description: |+ The configuration for a Spot fleet request. _Required:_ Yes _Type_: [Amazon EC2 SpotFleet SpotFleetRequestConfigData](aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html) _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'yes' type: |- Amazon EC2 SpotFleet SpotFleetRequestConfigData update_requires: some_interruptions return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::Subnet: description: Creates a subnet in an existing VPC. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html properties: AssignIpv6AddressOnCreation: description: |+ Indicates whether a network interface created in this subnet receives an IPv6 address. _Required_: Conditional. If `AssignIpv6AddressOnCreation` is `true`, `Ipv6CidrBlock` must be specified. _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: Boolean update_requires: no_interruption AvailabilityZone: description: |+ The availability zone in which you want the subnet. Default: AWS selects a zone for you (recommended). _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) Note If you update this property, you must also update the `CidrBlock` property. required: 'no' type: String update_requires: replacement CidrBlock: description: |+ The CIDR block that you want the subnet to cover (for example, `"10.0.0.0/24"`). _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) Note If you update this property, you must also update the `AvailabilityZone` property. required: 'yes' type: String update_requires: replacement Ipv6CidrBlock: description: |+ The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a `/64` prefix length. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption MapPublicIpOnLaunch: description: |+ Indicates whether instances that are launched in this subnet receive a public IP address. By default, the value is `false`. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption Tags: description: |+ An arbitrary set of tags (key–value pairs) for this subnet. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption VpcId: description: |+ A Ref structure that contains the ID of the VPC on which you want to create the subnet. The VPC ID is provided as the value of the "Ref" property, as: `{ "Ref": "VPCID" }`. _Required_: Yes _Type_: Ref ID _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) Note If you update this property, you must also update the `CidrBlock` property. required: 'yes' type: Ref ID update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource ID, such as `subnet-e19f0178`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). AvailabilityZone: description: |+ Returns the availability zone (for example, "`us-east-1a`") of this subnet. Example: Copy { "Fn::GetAtt" : ["mySubnet", "AvailabilityZone"] } Ipv6CidrBlocks: description: |+ A list of IPv6 CIDR blocks that are associated with the subnet, such as `[2001:db8:1234:1a00::/64]`. NetworkAclAssociationId: description: |+ The ID of the network ACL that is associated with the subnet's VPC, such as `acl-5fb85d36`. VpcId: description: |+ The ID of the subnet's VPC, such as `vpc-11ad4878`. examples: {} AWS::EC2::SubnetCidrBlock: description: The `AWS::EC2::SubnetCidrBlock` resource associates a single IPv6 CIDR block with an Amazon VPC subnet. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html properties: Ipv6CidrBlock: description: |+ The IPv6 CIDR block for the subnet. The CIDR block must have a prefix length of /64. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement SubnetId: description: |+ The ID of the subnet to associate the IPv6 CIDR block with. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: '' examples: {} AWS::EC2::SubnetNetworkAclAssociation: description: |- Associates a subnet with a network ACL. For more information, see [ReplaceNetworkAclAssociation](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-ReplaceNetworkAclAssociation.html) in the _Amazon EC2 API Reference_. When `AWS::EC2::SubnetNetworkAclAssociation` resources are created during create or update operations, AWS CloudFormation adopts existing resources that share the same key properties (the properties that contribute to uniquely identify the resource). However, if the operation fails and rolls back, AWS CloudFormation deletes the previously out-of-band resources. You can protect against this behavior by using `Retain` deletion policies. For more information, see [DeletionPolicy Attribute](aws-attribute-deletionpolicy.html). Note The EC2 API Reference refers to the `SubnetId` parameter as the `AssociationId`. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-network-acl-assoc.html properties: SubnetId: description: |+ The ID representing the current association between the original network ACL and the subnet. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement NetworkAclId: description: |+ The ID of the new ACL to associate with the subnet. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). AssociationId: description: |+ Returns the value of this object's [SubnetId](aws-resource-ec2-subnet-network-acl-assoc.html#cfn-ec2-subnetnetworkaclassociation-associationid) property. examples: {} AWS::EC2::SubnetRouteTableAssociation: description: |- Associates a subnet with a route table. When `AWS::EC2::SubnetRouteTableAssociation` resources are created during create or update operations, AWS CloudFormation adopts existing resources that share the same key properties (the properties that contribute to uniquely identify the resource). However, if the operation fails and rolls back, AWS CloudFormation deletes the previously out-of-band resources. You can protect against this behavior by using `Retain` deletion policies. For more information, see [DeletionPolicy Attribute](aws-attribute-deletionpolicy.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-route-table-assoc.html properties: RouteTableId: description: |+ The ID of the route table. This is commonly written as a reference to a route table declared elsewhere in the template. For example: Copy"RouteTableId" : { "Ref" : "myRouteTable" } _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). However, the physical ID changes when the route table ID is changed. required: 'yes' type: String update_requires: no_interruption SubnetId: description: |+ The ID of the subnet. This is commonly written as a reference to a subnet declared elsewhere in the template. For example: Copy"SubnetId" : { "Ref" : "mySubnet" } _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: '' examples: {} AWS::EC2::Volume: description: "The `AWS::EC2::Volume` type creates a new Amazon Elastic Block Store (Amazon EBS) volume.\n\nImportant\n\nWhen you use AWS CloudFormation to update an Amazon EBS volume that modifies `Iops`, `Size`, or `VolumeType`, there is a cooldown period before another operation can occur. This can cause your stack to report being in `UPDATE_IN_PROGRESS` or `UPDATE_ROLLBACK_IN_PROGRESS` for long periods of time.\n\nSome common scenarios when you might encounter a cooldown period for Amazon EBS include:\n\n- \n\nYou successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period.\n\n- \n\nYou successfully update an Amazon EBS volume and the update succeeds but another change in your `update-stack` call fails. The rollback will be subject to a cooldown period.\n\nFor more information on the cooldown period, see [Considerations for Modifying EBS Volumes](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/considerations.html) in the _Amazon EBS Developer Guide_.\n\nTo control how AWS CloudFormation handles the volume when the stack is deleted, set a deletion policy for your volume. You can choose to _retain_ the volume, to _delete_ the volume, or to _create a snapshot_ of the volume. For more information, see [DeletionPolicy Attribute](aws-attribute-deletionpolicy.html).\n\nNote\n\nIf you set a deletion policy that creates a snapshot, all tags on the volume are included in the snapshot.\n\nImportant\n\nAmazon EBS does not support sizing down an Amazon EBS volume. AWS CloudFormation will not attempt to modify an Amazon EBS volume to a smaller size on rollback.\n\nNote\n\nAmazon EBS does not support modifying a Magnetic volume. For more information, see [Considerations for Modifying EBS Volumes](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/considerations.html)." url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html properties: AutoEnableIO: description: |+ Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O. For more information, see [Working with the AutoEnableIO Volume Attribute](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-status.html#volumeIO) in the _Amazon EC2 User Guide for Linux Instances_. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption AvailabilityZone: description: |+ The Availability Zone in which to create the new volume. _Required:_ Yes _Type_: String _Update requires_: Updates are not supported. required: 'yes' type: String update_requires: Encrypted: description: |+ Indicates whether the volume is encrypted. You can attach encrypted Amazon EBS volumes only to instance types that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. You can't create an encrypted volume from an unencrypted snapshot, or vice versa. If your AMI uses encrypted volumes, you can launch the AMI only on supported instance types. For more information, see [Amazon EBS encryption](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the _Amazon EC2 User Guide for Linux Instances_. _Required:_ Conditional. If you specify the `KmsKeyId` property, you must enable encryption. _Type_: Boolean _Update requires_: Updates are not supported. required: conditional type: Boolean update_requires: Iops: description: |+ The number of I/O operations per second (IOPS) that the volume supports. For more information about the valid sizes for each volume type, see the `Iops` parameter for the [`CreateVolume`](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVolume.html) action in the _Amazon EC2 API Reference_. _Required:_ Conditional. _Required_ when the volume type is `io1`; not used with other volume types. _Type_: Number _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: Number update_requires: no_interruption KmsKeyId: description: |+ The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to create the encrypted volume, such as `arn:aws:kms:``us-east-2``:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef`. If you create an encrypted volume and don't specify this property, AWS CloudFormation uses the default master key. _Required:_ No _Type_: String _Update requires_: Updates are not supported. required: 'no' type: String update_requires: Size: description: |+ The size of the volume, in gibibytes (GiBs). For more information about the valid sizes for each volume type, see the `Size` parameter for the [`CreateVolume`](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVolume.html) action in the _Amazon EC2 API Reference_. If you specify the `SnapshotId` property, specify a size that is equal to or greater than the size of the snapshot. If you don't specify a size, EC2 uses the size of the snapshot as the volume size. _Required:_ Conditional. If you don't specify a value for the `SnapshotId` property, you must specify this property. _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: Number update_requires: no_interruption SnapshotId: description: |+ The snapshot from which to create the new volume. _Required:_ No _Type_: String _Update requires_: Updates are not supported. required: 'no' type: String update_requires: Tags: description: |+ An arbitrary set of tags (key–value pairs) for this volume. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption VolumeType: description: |+ The volume type. If you set the type to `io1`, you must also set the `Iops` property. For valid values, see the `VolumeType` parameter for the [CreateVolume](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVolume.html) action in the _Amazon EC2 API Reference_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: |- When you specify an `AWS::EC2::Volume` type as an argument to the `Ref` function, AWS CloudFormation returns the volume's physical ID. For example: `vol-5cb85026`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::VolumeAttachment: description: |- Attaches an Amazon EBS volume to a running instance and exposes it to the instance with the specified device name. Important Before this resource can be deleted (and therefore the volume detached), you must first unmount the volume in the instance. Failure to do so results in the volume being stuck in the busy state while it is trying to detach, which could possibly damage the file system or the data it contains. If an Amazon EBS volume is the root device of an instance, it cannot be detached while the instance is in the "running" state. To detach the root volume, stop the instance first. If the root volume is detached from an instance with an AWS Marketplace product code, then the AWS Marketplace product codes from that volume are no longer associated with the instance. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html properties: Device: description: |+ How the device is exposed to the instance (e.g., /dev/sdh, or xvdh). _Required_: Yes _Type_: String _Update requires_: Updates are not supported. required: 'yes' type: String update_requires: InstanceId: description: |+ The ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance. _Required_: Yes _Type_: String _Update requires_: Updates are not supported. required: 'yes' type: String update_requires: VolumeId: description: |+ The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume. _Required_: Yes _Type_: String _Update requires_: Updates are not supported. required: 'yes' type: String update_requires: return_values: Ref: description: '' examples: {} AWS::EC2::VPC: description: Creates a Virtual Private Cloud (VPC) with the CIDR block that you specify. To name a VPC resource, use the `Tags` property and specify a value for the `Name` key. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html properties: CidrBlock: description: |+ The CIDR block you want the VPC to cover. For example: `"10.0.0.0/16"`. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement EnableDnsSupport: description: |+ Specifies whether DNS resolution is supported for the VPC. If this attribute is `true`, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not. By default the value is set to `true`. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption EnableDnsHostnames: description: |+ Specifies whether the instances launched in the VPC get DNS hostnames. If this attribute is `true`, instances in the VPC get DNS hostnames; otherwise, they do not. You can only set `EnableDnsHostnames` to `true` if you also set the `EnableDnsSupport` attribute to `true`. By default, the value is set to `false`. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption InstanceTenancy: description: "The allowed tenancy of instances launched into the VPC.\n\n- \n\n`\"default\"`: Instances can be launched with any tenancy.\n\n- \n\n`\"dedicated\"`: Any instance launched into the VPC automatically has dedicated tenancy, unless you launch it with the default tenancy.\n\n_Required:_ No\n\n_Type_: String\n\n_Valid values_: `\"default\"` or `\"dedicated\"`\n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n\n" required: 'no' type: String update_requires: replacement Tags: description: |+ An arbitrary set of tags (key–value pairs) for this VPC. To name a VPC resource, specify a value for the `Name` key. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource ID, such as `vpc-18ac277d`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). CidrBlock: description: |+ The set of IP addresses for the VPC. For example, `10.0.0.0/16`. CidrBlockAssociations: description: |+ A list of IPv4 CIDR block association IDs for the VPC. For example, `[vpc-cidr-assoc-0280ab6b]`. DefaultNetworkAcl: description: |+ The default network ACL ID that is associated with the VPC. For example, `acl-814dafe3`. DefaultSecurityGroup: description: |+ The default security group ID that is associated with the VPC. For example, `sg-b178e0d3`. Ipv6CidrBlocks: description: |+ A list of IPv6 CIDR blocks that are associated with the VPC, such as `[ 2001:db8:1234:1a00::/56 ]`. examples: {} AWS::EC2::VPCCidrBlock: description: The `AWS::EC2::VPCCidrBlock` resource associates a single Amazon-provided IPv6 CIDR block or a single user-specified IPv4 CIDR block with a Virtual Private Cloud (VPC). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html properties: AmazonProvidedIpv6CidrBlock: description: |+ Whether to request an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You can't specify the range of IPv6 addresses or the size of the CIDR block. _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement CidrBlock: description: |+ An IPv4 CIDR block to associate with the VPC. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement VpcId: description: |+ The ID of the VPC to associate the Amazon-provided IPv6 CIDR block with. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: '' examples: {} AWS::EC2::VPCDHCPOptionsAssociation: description: Associates a set of DHCP options (that you've previously created) with the specified VPC. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-dhcp-options-assoc.html properties: DhcpOptionsId: description: |+ The ID of the DHCP options you want to associate with the VPC. Specify `default` if you want the VPC to use no DHCP options. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption VpcId: description: |+ The ID of the VPC to associate with this DHCP options set. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::VPCEndpoint: description: The `AWS::EC2::VPCEndpoint` resource creates a VPC endpoint that you can use to establish a private connection between your VPC and another AWS service without requiring access over the Internet, a VPN connection, or AWS Direct Connect. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html properties: PolicyDocument: description: |+ A policy to attach to the endpoint that controls access to the service. The policy must be valid JSON. The default policy allows full access to the AWS service. For more information, see [Controlling Access to Services](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-endpoints.html#vpc-endpoints-access) in the _Amazon VPC User Guide_. _Required:_ No _Type_: JSON object _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: JSON update_requires: no_interruption RouteTableIds: description: |+ One or more route table IDs that are used by the VPC to reach the endpoint. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption ServiceName: description: |+ The AWS service to which you want to establish a connection. Specify the service name in the form of `com.amazonaws.region.service`. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement VpcId: description: |+ The ID of the VPC in which the endpoint is used. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When you pass the logical ID of an `AWS::EC2::VPCEndpoint` resource to the intrinsic `Ref` function, the function returns the endpoint ID, such as `vpce-a123d0d1`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::VPCGatewayAttachment: description: Attaches a gateway to a VPC. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html properties: InternetGatewayId: description: |+ The ID of the Internet gateway. _Required:_ Conditional You must specify either `InternetGatewayId` or `VpnGatewayId`, but not both. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption VpcId: description: |+ The ID of the VPC to associate with this gateway. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption VpnGatewayId: description: |+ The ID of the virtual private network (VPN) gateway to attach to the VPC. _Required:_ Conditional You must specify either `InternetGatewayId` or `VpnGatewayId`, but not both. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::VPCPeeringConnection: description: |- A VPC peering connection enables a network connection between two virtual private clouds (VPCs) so that you can route traffic between them using a private IP address. For more information about VPC peering and its limitations, see [VPC Peering Overview](http://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/vpc-peering-overview.html) in the _Amazon VPC Peering Guide_. Note You can create a peering connection with another AWS account. For a detailed walkthrough, see [Walkthrough: Peer with an Amazon VPC in Another AWS Account](peer-with-vpc-in-another-account.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html properties: PeerVpcId: description: |+ The ID of the VPC with which you are creating the peering connection. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Tags: description: |+ An arbitrary set of tags (key–value pairs) for this resource. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption VpcId: description: |+ The ID of the VPC that is requesting a peering connection. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement PeerOwnerId: description: |+ The AWS account ID of the owner of the VPC that you want to peer with. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement PeerRoleArn: description: |+ The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::VPNConnection: description: |- Creates a new VPN connection between an existing virtual private gateway and a VPN customer gateway. For more information, see [CreateVpnConnection](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnConnection.html) in the _Amazon EC2 API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html properties: Type: description: |+ The type of VPN connection this virtual private gateway supports. Example: "ipsec.1" _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement CustomerGatewayId: description: |+ The ID of the customer gateway. This can either be an embedded JSON object or a reference to a Gateway ID. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement StaticRoutesOnly: description: |+ Indicates whether the VPN connection requires static routes. _Required_: Conditional. If you are creating a VPN connection for a device that does not support Border Gateway Protocol (BGP), you must specify `true`. _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: Boolean update_requires: replacement Tags: description: |+ The tags that you want to attach to the resource. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html). _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags. update_requires: no_interruption VpnGatewayId: description: |+ The ID of the virtual private gateway. This can either be an embedded JSON object or a reference to a Gateway ID. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement VpnTunnelOptionsSpecifications: description: |+ The tunnel options for the VPN connection. Duplicates not allowed. _Required_: No _Type_: List of [EC2 VPNConnection VpnTunnelOptionsSpecification](aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement return_values: Ref: description: '' examples: {} AWS::EC2::VPNConnectionRoute: description: A static route that is associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection-route.html properties: DestinationCidrBlock: description: |+ The CIDR block that is associated with the local subnet of the customer network. _Required_: Yes. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement VpnConnectionId: description: |+ The ID of the VPN connection. _Required_: Yes. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EC2::VPNGateway: description: Creates a virtual private gateway. A virtual private gateway is the VPC-side endpoint for your VPN connection. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gateway.html properties: AmazonSideAsn: description: |+ The private Autonomous System Number (ASN) for the Amazon side of a BGP session. _Required_: No _Type_: Long _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Long update_requires: no_interruption Type: description: |+ The type of VPN connection this virtual private gateway supports. The only valid value is `"ipsec.1"`. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Tags: description: |+ An arbitrary set of tags (key–value pairs) for this resource. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::EC2::VPNGatewayRoutePropagation: description: |- Enables a virtual private gateway (VGW) to propagate routes to the routing tables of a VPC. Note If you reference a VPN gateway that is in the same template as your VPN gateway route propagation, you must explicitly declare a dependency on the VPN gateway attachment. The `AWS::EC2::VPNGatewayRoutePropagation` resource cannot use the VPN gateway until it has successfully attached to the VPC. Add a [DependsOn](aws-attribute-dependson.html) attribute in the `AWS::EC2::VPNGatewayRoutePropagation` resource to explicitly declare a dependency on the VPN gateway attachment. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gatewayrouteprop.html properties: RouteTableIds: description: |+ A list of routing table IDs that are associated with a VPC. The routing tables must be associated with the same VPC that the virtual private gateway is attached to. _Required:_ Yes _Type_: List of route table IDs _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: List update_requires: no_interruption VpnGatewayId: description: |+ The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::ECR::Repository: description: The `AWS::ECR::Repository` resource creates an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images. For more information, see [Amazon ECR Repositories](http://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in the _Amazon Elastic Container Registry User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html properties: LifecyclePolicy: description: |+ A lifecycle policy for the repository. _Required_: No _Type_: [Amazon ECR Repository LifecyclePolicy](aws-properties-ecr-repository-lifecyclepolicy.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon ECR Repository LifecyclePolicy update_requires: no_interruption RepositoryName: description: |+ A name for the image repository. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement RepositoryPolicyText: description: |+ A policy that controls who has access to the repository and which actions they can perform on it. For more information, see [Amazon ECR Repository Policies](http://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicies.html) in the _Amazon Elastic Container Registry User Guide_. _Required:_ No _Type_: JSON object _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: JSON update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name, such as `test-repository`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ECS::Cluster: description: The `AWS::ECS::Cluster` resource creates an Amazon Elastic Container Service (Amazon ECS) cluster. This resource has no properties; use the Amazon ECS container agent to connect to the cluster. For more information, see [Amazon ECS Container Agent](http://docs.aws.amazon.com/AmazonECS/latest/developerguide//ECS_agent.html) in the _Amazon Elastic Container Service Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html properties: ClusterName: description: |+ A name for the cluster. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. In the following sample, the `Ref` function returns the name of the `MyECSCluster` cluster, such as `MyStack-MyECSCluster-NT5EUXTNTXXD`. Copy{ "Ref": "MyECSCluster" } For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as `arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster`. examples: {} AWS::ECS::Service: description: The `AWS::ECS::Service` resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html properties: Cluster: description: |+ The name or Amazon Resource Name (ARN) of the cluster that you want to run your Amazon ECS service on. If you do not specify a cluster, Amazon ECS uses the default cluster. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement DeploymentConfiguration: description: |+ Configures how many tasks run during a deployment. _Required:_ No _Type_: [Amazon Elastic Container Service Service DeploymentConfiguration](aws-properties-ecs-service-deploymentconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- Amazon Elastic Container Service Service DeploymentConfiguration update_requires: no_interruption DesiredCount: description: |+ The number of simultaneous tasks that you want to run on the cluster. Specify the tasks with the `TaskDefinition` property. _Required:_ Conditional. Required only when creating an Amazon ECS Service. _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: Number update_requires: no_interruption LaunchType: description: |+ The launch type on which to run your service. If one is not specified, `EC2` will be used by default. Valid values include `EC2` and `FARGATE`. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement LoadBalancers: description: |+ A list of load balancer objects to associate with the cluster. If you specify the `Role` property, `LoadBalancers` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the _Amazon Elastic Container Service Developer Guide_. _Required:_ Conditional _Type_: List of [Amazon Elastic Container Service Service LoadBalancers](aws-properties-ecs-service-loadbalancers.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: List update_requires: replacement NetworkConfiguration: description: |+ The network configuration for the service. This parameter is required for task definitions that use the `awsvpc` network mode to receive their own Elastic Network Interface, and it is not supported for other network modes. For more information, see [Task Networking](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/developerguidetask-networking.html) in the _Amazon Elastic Container Service Developer Guide_. _Required_: No _Type_: [Amazon ECS Service NetworkConfiguration](aws-properties-ecs-service-networkconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon ECS Service NetworkConfiguration update_requires: no_interruption PlacementConstraints: description: |+ The placement constraints for the tasks in the service. _Required:_ No _Type_: [Amazon Elastic Container Service Service PlacementConstraint](aws-properties-ecs-service-placementconstraints-placementconstraint.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: |- Amazon Elastic Container Service Service PlacementConstraint update_requires: replacement PlacementStrategies: description: |+ The placement strategies that determine how tasks for the service are placed. _Required:_ No _Type_: [Amazon Elastic Container Service Service PlacementStrategies](aws-properties-ecs-service-placementstrategies-placementstrategy.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: |- Amazon Elastic Container Service Service PlacementStrategies update_requires: replacement PlatformVersion: description: |+ The platform version on which to run your service. If one is not specified, the latest version will be used by default. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Role: description: |+ The name or ARN of an AWS Identity and Access Management (IAM) role that allows your Amazon ECS container agent to make calls to your load balancer. Note In some cases, you might need to add a dependency on the service role's policy. For more information, see IAM role policy in [DependsOn Attribute](aws-attribute-dependson.html). _Required:_ Conditional. Required only if you specify the `LoadBalancers` property. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement ServiceName: description: |+ The name of your service. The name is limited to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement TaskDefinition: description: |+ The ARN of the task definition (including the revision number) that you want to run on the cluster, such as `arn:aws:ecs:us-east-1:123456789012:task-definition/mytask:3`. You can't use `:latest` to specify a revision because it's ambiguous. For example, if AWS CloudFormation needed to roll back an update, it wouldn't know which revision to roll back to. _Required:_ Yes _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'yes' type: String update_requires: some_interruptions return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the ARN. In the following sample, the `Ref` function returns the ARN of the `MyECSService` service, such as `arn:aws:ecs:us-west-2:123456789012:service/sample-webapp`. Copy{ "Ref": "MyECSService" } For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Name: description: |+ The name of the Amazon ECS service, such as `sample-webapp`. examples: {} AWS::ECS::TaskDefinition: description: The `AWS::ECS::TaskDefinition` resource describes the container and volume definitions of an Amazon Elastic Container Service (Amazon ECS) task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html properties: ContainerDefinitions: description: |+ A list of container definitions in JSON format that describes the containers that make up your task. _Required:_ Yes _Type_: List of [Amazon Elastic Container Service TaskDefinition ContainerDefinition](aws-properties-ecs-taskdefinition-containerdefinitions.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: List update_requires: replacement Cpu: description: "The number of `cpu` units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the `memory` parameter:\n\n- \n\n256 (.25 vCPU) - Available `memory` values: 512MB, 1GB, 2GB\n\n- \n\n512 (.5 vCPU) - Available `memory` values: 1GB, 2GB, 3GB, 4GB\n\n- \n\n1024 (1 vCPU) - Available `memory` values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB\n\n- \n\n2048 (2 vCPU) - Available `memory` values: Between 4GB and 16GB in 1GB increments\n\n- \n\n4096 (4 vCPU) - Available `memory` values: Between 8GB and 30GB in 1GB increments\n\n_Required:_ No\n\n_Type_: String\n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n\n" required: 'no' type: String update_requires: replacement ExecutionRoleArn: description: |+ The Amazon Resource Name (ARN) of the task execution role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Family: description: |+ The name of a family that this task definition is registered to. A _family_ groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add. Note To use revision numbers when you update a task definition, specify this property. If you don't specify a value, AWS CloudFormation generates a new task definition each time that you update it. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Memory: description: "The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the `cpu` parameter:\n\n- \n\n512MB, 1GB, 2GB - Available `cpu` values: 256 (.25 vCPU)\n\n- \n\n1GB, 2GB, 3GB, 4GB - Available `cpu` values: 512 (.5 vCPU)\n\n- \n\n2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available `cpu` values: 1024 (1 vCPU)\n\n- \n\nBetween 4GB and 16GB in 1GB increments - Available `cpu` values: 2048 (2 vCPU)\n\n- \n\nBetween 8GB and 30GB in 1GB increments - Available `cpu` values: 4096 (4 vCPU)\n\n_Required:_ No\n\n_Type_: String\n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n\n" required: 'no' type: String update_requires: replacement NetworkMode: description: |+ The Docker networking mode to use for the containers in the task, such as `none`, `bridge`, or `host`. For information about network modes, see [`NetworkMode`](http://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RegisterTaskDefinition.html) in the [Task Definition Parameters](http://docs.aws.amazon.com/AmazonECS/latest/developerguide//task_definition_parameters.html) topic in the _Amazon Elastic Container Service Developer Guide_. For Fargate launch types, you can specify `awsvpc` only. The `none`, `bridge`, or `host` option won't work for Fargate launch types. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement PlacementConstraints: description: |+ The placement constraints for the tasks in the service. _Required:_ No _Type_: [Amazon Elastic Container Service Service PlacementConstraint](aws-properties-ecs-taskdefinition-placementconstraints-taskdefinitionplacementconstraint.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: |- Amazon Elastic Container Service Service PlacementConstraint update_requires: replacement RequiresCompatibilities: description: |+ The launch type the task requires. If no value is specified, it will default to `EC2`. Valid values include `EC2` and `FARGATE`. _Required:_ No _Type_: List of Strings _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement TaskRoleArn: description: |+ The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see [IAM Roles for Tasks](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the _Amazon Elastic Container Service Developer Guide_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Volumes: description: |+ A list of volume definitions in JSON format for the volumes that you can use in your container definitions. _Required:_ No _Type_: List of [Amazon Elastic Container Service TaskDefinition Volumes](aws-properties-ecs-taskdefinition-volumes.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the Amazon Resource Name (ARN). In the following example, the `Ref` function returns the ARN of the `MyTaskDefinition` task, such as `arn:aws:ecs:us-west-2:123456789012:task/1abf0f6d-a411-4033-b8eb-a4eed3ad252a`. Copy{ "Ref": "MyTaskDefinition" } For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EFS::FileSystem: description: The `AWS::EFS::FileSystem` resource creates a new, empty file system in Amazon Elastic File System (Amazon EFS). You must create a mount target ([AWS::EFS::MountTarget](aws-resource-efs-mounttarget.html)) to mount your Amazon EFS file system on an Amazon Elastic Compute Cloud (Amazon EC2) instance. For more information, see the [CreateFileSystem](http://docs.aws.amazon.com/efs/latest/ug/API_CreateFileSystem.html) API in the _Amazon Elastic File System User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html properties: FileSystemTags: description: |+ Tags to associate with the file system. _Required:_ No _Type_: [Amazon Elastic File System FileSystem FileSystemTags](aws-properties-efs-filesystem-filesystemtags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- Amazon Elastic File System FileSystem FileSystemTags update_requires: no_interruption Encrypted: description: |+ A boolean value that, if true, creates an encrypted file system. For more information, see [CreateFileSystem](http://docs.aws.amazon.com/efs/latest/ug/API_CreateFileSystem.html) in the _Amazon Elastic File System User Guide_. _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement KmsKeyId: description: |+ The ID of the AWS KMS customer master key (CMK) to use to protect the encrypted file system. This parameter is only required if you want to use a non-default CMK. For more information, see [CreateFileSystem](http://docs.aws.amazon.com/efs/latest/ug/API_CreateFileSystem.html) in the _Amazon Elastic File System User Guide_. _Required:_ Conditional. This parameter is required if you use a non-default CMK. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement PerformanceMode: description: |+ The performance mode of the file system. For valid values, see the `PerformanceMode` parameter for the [CreateFileSystem](http://docs.aws.amazon.com/efs/latest/ug/API_CreateFileSystem.html) action in the _Amazon Elastic File System User Guide_. For more information about performance modes, see [Amazon EFS Performance](http://docs.aws.amazon.com/efs/latest/ug/performance.html) in the _Amazon Elastic File System User Guide_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource ID, such as `fs-47a2c22e`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EFS::MountTarget: description: |- The `AWS::EFS::MountTarget` resource creates a mount target for an Amazon Elastic File System (Amazon EFS) file system ([AWS::EFS::FileSystem](aws-resource-efs-filesystem.html)). Use the mount target to mount file systems on Amazon Elastic Compute Cloud (Amazon EC2) instances. For more information on creating a mount target for a file system, see [CreateMountTarget](http://docs.aws.amazon.com/efs/latest/ug/API_CreateMountTarget.html) in the _Amazon Elastic File System User Guide_. For a detailed overview of deploying EC2 instances associated with an Amazon EFS file system, see [Amazon Elastic File System Sample Template](quickref-efs.html). Note EC2 instances and the mount target that they connect to must be in a VPC with DNS enabled. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html properties: FileSystemId: description: |+ The ID of the file system for which you want to create the mount target. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) Before updating this property, stop EC2 instances that are using this mount target, and then restart them after the update is complete. This allows the instances to unmount the file system before the mount target is replaced. If you don't stop and restart them, instances or applications that are using those mounts might be disrupted when the mount target is deleted (uncommitted writes might be lost). required: 'yes' type: String update_requires: replacement IpAddress: description: |+ An IPv4 address that is within the address range of the subnet that is specified in the `SubnetId` property. If you don't specify an IP address, Amazon EFS automatically assigns an address that is within the range of the subnet. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) Before updating this property, stop EC2 instances that are using this mount target, and then restart them after the update is complete. This allows the instances to unmount the file system before the mount target is replaced. If you don't stop and restart them, instances or applications that are using those mounts might be disrupted when the mount target is deleted (uncommitted writes might be lost). required: 'no' type: String update_requires: replacement SecurityGroups: description: |+ A maximum of five VPC security group IDs that are in the same VPC as the subnet that is specified in the `SubnetId` property. For more information about security groups and mount targets, see [Security](http://docs.aws.amazon.com/efs/latest/ug/security-considerations.html) in the _Amazon Elastic File System User Guide_. _Required:_ Yes _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: List update_requires: no_interruption SubnetId: description: |+ The ID of the subnet in which you want to add the mount target. Note For each file system, you can create only one mount target per Availability Zone (AZ). All EC2 instances in an AZ share a single mount target for a file system. If you create multiple mount targets for a single file system, do not specify a subnet that is an AZ that already has a mount target associated with the same file system. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) Before updating this property, stop EC2 instances that are using this mount target and then restart them after the update is complete. That way the instances can unmount the file system before the mount target is replaced. If you don't stop and restart them, instances or applications that are using those mounts might be disrupted when the mount target is deleted (uncommitted writes might be lost). required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource ID, such as `fsmt-55a4413c`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ElastiCache::CacheCluster: description: The AWS::ElastiCache::CacheCluster type creates an Amazon ElastiCache cache cluster. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html properties: AutoMinorVersionUpgrade: description: |+ Indicates that minor engine upgrades will be applied automatically to the cache cluster during the maintenance window. _Required:_ No _Type_: Boolean _Default_: `true` _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption AZMode: description: |+ For Memcached cache clusters, indicates whether the nodes are created in a single Availability Zone or across multiple Availability Zones in the cluster's region. For valid values, see [CreateCacheCluster](http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheCluster.html) in the _Amazon ElastiCache API Reference_. _Required:_ Conditional. If you specify multiple Availability Zones in the `PreferredAvailabilityZones` property, you must specify cross Availability Zones for this property. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption CacheNodeType: description: |+ The compute and memory capacity of nodes in a cache cluster. _Required:_ Yes _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'yes' type: String update_requires: some_interruptions CacheParameterGroupName: description: |+ The name of the cache parameter group that is associated with this cache cluster. _Required:_ No _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: String update_requires: some_interruptions CacheSecurityGroupNames: description: |+ A list of cache security group names that are associated with this cache cluster. If your cache cluster is in a VPC, specify the `VpcSecurityGroupIds` property instead. _Required:_ Conditional: If your cache cluster isn't in a VPC, you must specify this property. _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: List update_requires: no_interruption CacheSubnetGroupName: description: |+ The cache subnet group that you associate with a cache cluster. _Required:_ Conditional. If you specified the `VpcSecurityGroupIds` property, you must specify this property. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement ClusterName: description: |+ A name for the cache cluster. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the cache cluster. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. The name must contain 1 to 20 alphanumeric characters or hyphens. The name must start with a letter and cannot end with a hyphen or contain two consecutive hyphens. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Engine: description: |+ The name of the cache engine to be used for this cache cluster, such as `memcached` or `redis`. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement EngineVersion: description: |+ The version of the cache engine to be used for this cluster. _Required:_ No _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: String update_requires: some_interruptions NotificationTopicArn: description: |+ The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption NumCacheNodes: description: |+ The number of cache nodes that the cache cluster should have. _Required:_ Yes _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). However, if the `PreferredAvailabilityZone` and `PreferredAvailabilityZones` properties were not previously specified and you don't specify any new values, an update requires [replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement). required: 'yes' type: Number update_requires: replacement Port: description: |+ The port number on which each of the cache nodes will accept connections. _Required:_ No _Type_: Integer _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Number update_requires: replacement PreferredAvailabilityZone: description: |+ The Amazon EC2 Availability Zone in which the cache cluster is created. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement PreferredAvailabilityZones: description: |+ For Memcached cache clusters, the list of Availability Zones in which cache nodes are created. The number of Availability Zones listed must equal the number of cache nodes. For example, if you want to create three nodes in two different Availability Zones, you can specify `["us-east-1a", "us-east-1a", "us-east-1b"]`, which would create two nodes in us-east-1a and one node in us-east-1b. If you specify a subnet group and you're creating your cache cluster in a VPC, you must specify Availability Zones that are associated with the subnets in the subnet group that you've chosen. If you want all the nodes in the same Availability Zone, use the `PreferredAvailabilityZone` property or repeat the Availability Zone multiple times in the list. _Required:_ No _Type_: List of String values If you specify an Availability Zone that was previously specified in the template, such as in the `PreferredAvailabilityZone` property, the update requires [some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Also, if the `PreferredAvailabilityZones` property was already specified and you're updating its values (regardless of whether you specify the same Availability Zones), the update requires [some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). All other updates require [replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement). required: 'no' type: List update_requires: PreferredMaintenanceWindow: description: |+ The weekly time range (in UTC) during which system maintenance can occur. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption SnapshotArns: description: |+ The ARN of the snapshot file that you want to use to seed a new Redis cache cluster. If you manage a Redis instance outside of Amazon ElastiCache, you can create a new cache cluster in ElastiCache by using a snapshot file that is stored in an Amazon S3 bucket. _Required:_ No _Type_: List of String values _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement SnapshotName: description: |+ The name of a snapshot from which to restore data into a new Redis cache cluster. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement SnapshotRetentionLimit: description: |+ For Redis cache clusters, the number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set the value to `5`, a snapshot that was taken today will be retained for 5 days before being deleted. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption SnapshotWindow: description: |+ For Redis cache clusters, the daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group. For example, you can specify `05:00-09:00`. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Tags: description: |+ An arbitrary set of tags (key–value pairs) for this cache cluster. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption VpcSecurityGroupIds: description: |+ A list of VPC security group IDs. If your cache cluster isn't in a VPC, specify the `CacheSecurityGroupNames` property instead. Note You must use the `AWS::EC2::SecurityGroup` resource instead of the `AWS::ElastiCache::SecurityGroup` resource in order to specify an ElastiCache security group that is in a VPC. In addition, if you use the [default VPC](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/default-vpc.html) for your AWS account, you must use the `Fn::GetAtt` function and the `GroupId` attribute to retrieve security group IDs (instead of the `Ref` function). To see a sample template, see the Template Snippet section. _Required:_ Conditional: If your cache cluster is in a VPC, you must specify this property. _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). ConfigurationEndpoint.Address: description: |+ The DNS address of the configuration endpoint for the Memcached cache cluster. ConfigurationEndpoint.Port: description: |+ The port number of the configuration endpoint for the Memcached cache cluster. RedisEndpoint.Address: description: |+ The DNS address of the configuration endpoint for the Redis cache cluster. RedisEndpoint.Port: description: |+ The port number of the configuration endpoint for the Redis cache cluster. examples: {} AWS::ElastiCache::ParameterGroup: description: The AWS::ElastiCache::ParameterGroup type creates a new cache parameter group. Cache parameter groups control the parameters for a cache cluster. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-parameter-group.html properties: CacheParameterGroupFamily: description: |+ The name of the cache parameter group family that the cache parameter group can be used with. _Required:_ Yes _Type_: String _Update requires_: Updates are not supported. required: 'yes' type: String update_requires: Description: description: |+ The description for the Cache Parameter Group. _Required:_ Yes _Type_: String _Update requires_: Updates are not supported. required: 'yes' type: String update_requires: Properties: description: |+ A comma-delimited list of parameter name/value pairs. For more information, go to [ModifyCacheParameterGroup](http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheParameterGroup.html) in the _Amazon ElastiCache API Reference Guide_. _Example_: Copy "Properties" : { "cas_disabled" : "1", "chunk_size_growth_factor" : "1.02" } _Required:_ No _Type_: Mapping of key-value pairs _Update requires_: Updates are not supported. required: 'no' type: List> update_requires: return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ElastiCache::ReplicationGroup: description: The `AWS::ElastiCache::ReplicationGroup` resource creates an Amazon ElastiCache Redis replication group. A _replication group_ is a collection of cache clusters, where one of the clusters is a primary read-write cluster and the others are read-only replicas. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html properties: AtRestEncryptionEnabled: description: |+ Indicates whether to enable encryption at rest. The default value is `false`. For more information about how you can use this property, see [CreateReplicationGroup](http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateReplicationGroup.html) in the _Amazon ElastiCache API Reference_. _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement AuthToken: description: |+ The password that's used to access a password-protected server. For constraints, see [CreateReplicationGroup](http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateReplicationGroup.html) in the _Amazon ElastiCache API Reference_. `AuthToken` can be specified only on replication groups where `TransitEncryptionEnabled` is `true`. Important For HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroupName`. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement AutomaticFailoverEnabled: description: "Indicates whether Multi-AZ is enabled. When Multi-AZ is enabled, a read-only replica is automatically promoted to a read-write primary cluster if the existing primary cluster fails. If you specify `true`, you must specify a value greater than `1` for the `NumCacheClusters` property. By default, AWS CloudFormation sets the value to `true`.\n\nFor Redis (clustered mode enabled) replication groups, you must enable automatic failover.\n\nFor information about Multi-AZ constraints, see [Replication with Multi-AZ and Automatic Failover (Redis)](http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/AutoFailover.html) in the _Amazon ElastiCache User Guide_.\n\nNote\n\nYou cannot enable automatic failover for Redis versions earlier than 2.8.6 or for T1 cache node types. Automatic failover is supported on T2 node types only if you are running Redis version 3.2.4 or later with cluster mode enabled.\n\nImportant\n\nIf you specify the `PrimaryClusterId`, you can use only the following additional parameters:\n\n- \n\n`AutomaticFailoverEnabled`\n\n- \n\n`NodeGroupConfiguration`\n\n- \n\n`NumCacheClusters`\n\n- \n\n`NumNodeGroups`\n\n- \n\n`PreferredCacheClusterAZs`\n\n- \n\n`ReplicationGroupDescription`\n\n_Required:_ No\n\n_Type_: Boolean\n\n_Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n\n" required: 'no' type: Boolean update_requires: no_interruption AutoMinorVersionUpgrade: description: |+ Currently, this property isn't used by ElastiCache. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption CacheNodeType: description: |+ The compute and memory capacity of nodes in the node group. For valid values, see [CreateReplicationGroup](http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateReplicationGroup.html) in the _Amazon ElastiCache API Reference Guide_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption CacheParameterGroupName: description: |+ The name of the parameter group to associate with this replication group. For valid and default values, see [CreateReplicationGroup](http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateReplicationGroup.html) in the _Amazon ElastiCache API Reference Guide_. _Required:_ No _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: String update_requires: some_interruptions CacheSecurityGroupNames: description: |+ A list of cache security group names to associate with this replication group. Important If you specify the `CacheSecurityGroupNames` property, don't also specify the `SecurityGroupIds` property. The `SecurityGroupIds` property is only for Amazon Virtual Private Cloud (Amazon VPC) security groups. If you specify an Amazon VPC security group, the deployment fails. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption CacheSubnetGroupName: description: |+ The name of a cache subnet group to use for this replication group. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Engine: description: |+ The name of the cache engine to use for the cache clusters in this replication group. Currently, you can specify only `redis`. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption EngineVersion: description: |+ The version number of the cache engine to use for the cache clusters in this replication group. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption NodeGroupConfiguration: description: "Configuration options for the node group (shard).\n\nImportant\n\nIf you specify the `PrimaryClusterId`, you can use only the following additional parameters:\n\n- \n\n`AutomaticFailoverEnabled`\n\n- \n\n`NodeGroupConfiguration`\n\n- \n\n`NumCacheClusters`\n\n- \n\n`NumNodeGroups`\n\n- \n\n`PreferredCacheClusterAZs`\n\n- \n\n`ReplicationGroupDescription`\n\n_Required:_ No\n\n_Type_: List of [Amazon ElastiCache ReplicationGroup NodeGroupConfiguration](aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html)\n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n\n" required: 'no' type: List update_requires: replacement NotificationTopicArn: description: |+ The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic to which notifications are sent. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption NumCacheClusters: description: "The number of cache clusters for this replication group. If automatic failover is enabled, you must specify a value greater than `1`. For valid values, see [CreateReplicationGroup](http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateReplicationGroup.html) in the _Amazon ElastiCache API Reference Guide_.\n\nIf you specify more than one node group (shard), this property is ignored. Use the `ReplicasPerNodeGroup` property instead.\n\nImportant\n\nIf you specify the `PrimaryClusterId`, you can use only the following additional parameters:\n\n- \n\n`AutomaticFailoverEnabled`\n\n- \n\n`NodeGroupConfiguration`\n\n- \n\n`NumCacheClusters`\n\n- \n\n`NumNodeGroups`\n\n- \n\n`PreferredCacheClusterAZs`\n\n- \n\n`ReplicationGroupDescription`\n\n_Required:_ No\n\n_Type_: Integer\n\n_Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n\n" required: 'no' type: Number update_requires: no_interruption NumNodeGroups: description: "The number of node groups (shards) for this Redis (clustered mode enabled) replication group. For Redis (clustered mode disabled), omit this property.\n\nImportant\n\nIf you specify the `PrimaryClusterId`, you can use only the following additional parameters:\n\n- \n\n`AutomaticFailoverEnabled`\n\n- \n\n`NodeGroupConfiguration`\n\n- \n\n`NumCacheClusters`\n\n- \n\n`NumNodeGroups`\n\n- \n\n`PreferredCacheClusterAZs`\n\n- \n\n`ReplicationGroupDescription`\n\n_Required:_ No\n\n_Type_: Integer\n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n\n" required: 'no' type: Number update_requires: replacement Port: description: |+ The port number on which each member of the replication group accepts connections. _Required:_ No _Type_: Integer _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Number update_requires: replacement PreferredCacheClusterAZs: description: "A list of Availability Zones in which the cache clusters in this replication group are created.\n\nImportant\n\nIf you specify the `PrimaryClusterId`, you can use only the following additional parameters:\n\n- \n\n`AutomaticFailoverEnabled`\n\n- \n\n`NodeGroupConfiguration`\n\n- \n\n`NumCacheClusters`\n\n- \n\n`NumNodeGroups`\n\n- \n\n`PreferredCacheClusterAZs`\n\n- \n\n`ReplicationGroupDescription`\n\n_Required:_ No\n\n_Type_: List of String values\n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n\n" required: 'no' type: List update_requires: replacement PreferredMaintenanceWindow: description: |+ The weekly time range during which system maintenance can occur. Use the following format to specify a time range: `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). For example, you can specify `sun:22:00-sun:23:30` for Sunday from 10 PM to 11:30 PM. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption PrimaryClusterId: description: "The cache cluster that ElastiCache uses as the primary cluster for the replication group. The cache cluster must have a status of `available`.\n\nImportant\n\nIf you specify the `PrimaryClusterId`, you can use only the following additional parameters:\n\n- \n\n`AutomaticFailoverEnabled`\n\n- \n\n`NodeGroupConfiguration`\n\n- \n\n`NumCacheClusters`\n\n- \n\n`NumNodeGroups`\n\n- \n\n`PreferredCacheClusterAZs`\n\n- \n\n`ReplicationGroupDescription`\n\n_Required:_ Conditional. This property is optional if you specify the `NumCacheClusters`, `NumNodeGroups`, or `ReplicasPerNodeGroup` properties.\n\n_Type_: String\n\n_Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n\n" required: conditional type: String update_requires: no_interruption ReplicasPerNodeGroup: description: |+ The number of replica nodes in each node group (shard). For valid values, see [CreateReplicationGroup](http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateReplicationGroup.html) in the _Amazon ElastiCache API Reference Guide_. _Required:_ No _Type_: Integer _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Number update_requires: replacement ReplicationGroupDescription: description: "A description of the replication group.\n\nImportant\n\nIf you specify the `PrimaryClusterId`, you can use only the following additional parameters:\n\n- \n\n`AutomaticFailoverEnabled`\n\n- \n\n`NodeGroupConfiguration`\n\n- \n\n`NumCacheClusters`\n\n- \n\n`NumNodeGroups`\n\n- \n\n`PreferredCacheClusterAZs`\n\n- \n\n`ReplicationGroupDescription`\n\n_Required:_ Yes\n\n_Type_: String\n\n_Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n\n" required: 'yes' type: String update_requires: no_interruption ReplicationGroupId: description: |+ An ID for the replication group. If you don't specify an ID, AWS CloudFormation generates a unique physical ID. For more information, see [Name Type](aws-properties-name.html). _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement SecurityGroupIds: description: |+ A list of Amazon Virtual Private Cloud (Amazon VPC) security groups to associate with this replication group. Important If you specify the `SecurityGroupIds` property, don't also specify the `CacheSecurityGroupNames` property. The `CacheSecurityGroupNames` property is only for EC2-Classic security groups. If you specify an EC2-Classic security group, the deployment fails. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption SnapshotArns: description: |+ A single-element string list that specifies an ARN of a Redis `.rdb` snapshot file that is stored in Amazon Simple Storage Service (Amazon S3). The snapshot file populates the node group. The Amazon S3 object name in the ARN cannot contain commas. For example, you can specify `arn:aws:s3:::my_bucket/snapshot1.rdb`. _Required:_ No _Type_: List of String values _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement SnapshotName: description: |+ The name of a snapshot from which to restore data into the replication group. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement SnapshotRetentionLimit: description: |+ The number of days that ElastiCache retains automatic snapshots before deleting them. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption SnapshottingClusterId: description: |+ The ID of the cache cluster that ElastiCache uses as the daily snapshot source for the replication group. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption SnapshotWindow: description: |+ The time range (in UTC) when ElastiCache takes a daily snapshot of the node group that you specified in the `SnapshottingClusterId` property. For example, you can specify `05:00-09:00`. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Tags: description: |+ An arbitrary set of tags (key–value pairs) for this replication group. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption TransitEncryptionEnabled: description: |+ Indicates whether to enable in-transit encryption. The default value is `false`. For more information about how you can use this property, see [CreateReplicationGroup](http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateReplicationGroup.html) in the _Amazon ElastiCache API Reference_. If you enable `TransitEncryptionEnabled`, then you must also specify `CacheSubnetGroupName`. _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. In the following example, the `Ref` function returns the name of the `myReplicationGroup` replication group, such as `abc12xmy3d1w3hv6`. Copy{ "Ref": "myReplicationGroup" } For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). ConfigurationEndPoint.Address: description: |+ The DNS hostname of the cache node. ConfigurationEndPoint.Port: description: |+ The port number that the cache engine is listening on. PrimaryEndPoint.Address: description: |+ The DNS address of the primary read-write cache node. PrimaryEndPoint.Port: description: |+ The number of the port that the primary read-write cache engine is listening on. ReadEndPoint.Addresses: description: |+ A string with a list of endpoints for the read-only replicas. The order of the addresses maps to the order of the ports from the `ReadEndPoint.Ports` attribute. ReadEndPoint.Ports: description: |+ A string with a list of ports for the read-only replicas. The order of the ports maps to the order of the addresses from the `ReadEndPoint.Addresses` attribute. ReadEndPoint.Addresses.List: description: |+ A list of endpoints for the read-only replicas. The order of the addresses maps to the order of the ports from the `ReadEndPoint.Ports.List` attribute. ReadEndPoint.Ports.List: description: |+ A list of ports for the read-only replicas. The order of the ports maps to the order of the addresses from the `ReadEndPoint.Addresses.List` attribute. examples: {} AWS::ElastiCache::SecurityGroup: description: |- The `AWS::ElastiCache::SecurityGroup` resource creates a cache security group. For more information about cache security groups, go to [Cache Security Groups](http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheSecurityGroup.html) in the _Amazon ElastiCache User Guide_ or go to [CreateCacheSecurityGroup](http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSecurityGroup.html) in the _Amazon ElastiCache API Reference Guide_. To create an ElastiCache cluster in a VPC, use the [AWS::EC2::SecurityGroup](aws-properties-ec2-security-group.html) resource. For more information, see the `VpcSecurityGroupIds` property in the [AWS::ElastiCache::CacheCluster](aws-properties-elasticache-cache-cluster.html) resource. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-security-group.html properties: Description: description: |+ A description for the cache security group. _Type_: String _Required:_ No _Update requires_: Updates are not supported. required: 'no' type: String update_requires: return_values: Ref: description: |- When you specify the `AWS::ElastiCache::SecurityGroup` resource as an argument to the `Ref` function, AWS CloudFormation returns the `CacheSecurityGroupName` property of the cache security group. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ElastiCache::SecurityGroupIngress: description: The AWS::ElastiCache::SecurityGroupIngress type authorizes ingress to a cache security group from hosts in specified Amazon EC2 security groups. For more information about ElastiCache security group ingress, go to [AuthorizeCacheSecurityGroupIngress](http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_AuthorizeCacheSecurityGroupIngress.html) in the _Amazon ElastiCache API Reference Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-security-group-ingress.html properties: CacheSecurityGroupName: description: |+ The name of the Cache Security Group to authorize. _Type_: String _Required:_ Yes _Update requires_: Updates are not supported. required: 'yes' type: String update_requires: EC2SecurityGroupName: description: |+ Name of the EC2 Security Group to include in the authorization. _Type_: String _Required:_ Yes _Update requires_: Updates are not supported. required: 'yes' type: String update_requires: EC2SecurityGroupOwnerId: description: |+ Specifies the AWS Account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName property. The AWS access key ID is not an acceptable value. _Type_: String _Required:_ No _Update requires_: Updates are not supported. required: 'no' type: String update_requires: return_values: Ref: description: '' examples: {} AWS::ElastiCache::SubnetGroup: description: Creates a cache subnet group. For more information about cache subnet groups, go to [Cache Subnet Groups](http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheSubnetGroups.html) in the _Amazon ElastiCache User Guide_ or go to [CreateCacheSubnetGroup](http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html) in the _Amazon ElastiCache API Reference Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-subnetgroup.html properties: CacheSubnetGroupName: description: |+ A name for the cache subnet group. If you don't specify a name, AWS CloudFormation generates a unique physical ID. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Description: description: |+ The description for the cache subnet group. _Type_: String _Required_: Yes _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption SubnetIds: description: |+ The Amazon EC2 subnet IDs for the cache subnet group. _Type_: String list _Required_: Yes _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String list update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ElasticBeanstalk::Application: description: Creates an Elastic Beanstalk application. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk.html properties: ApplicationName: description: |+ A name for the Elastic Beanstalk application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Description: description: |+ An optional description of this application. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption ResourceLifecycleConfig: description: |+ Defines lifecycle settings for resources that belong to the application, and the service role that Elastic Beanstalk assumes in order to apply lifecycle settings. _Required_: No _Type_: [Elastic Beanstalk Application ApplicationResourceLifecycleConfig](aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Elastic Beanstalk Application ApplicationResourceLifecycleConfig update_requires: return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ElasticBeanstalk::ApplicationVersion: description: Creates an application version, an iteration of deployable code, for an Elastic Beanstalk application. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-version.html properties: ApplicationName: description: |+ Name of the Elastic Beanstalk application that is associated with this application version. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Description: description: |+ A description of this application version. _Required:_ No _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: String update_requires: some_interruptions SourceBundle: description: |+ The location of the source bundle for this version. _Required:_ Yes _Type_: [Source Bundle](aws-properties-beanstalk-sourcebundle.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: Source Bundle update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ElasticBeanstalk::ConfigurationTemplate: description: Creates a configuration template for an Elastic Beanstalk application. You can use configuration templates to deploy different versions of an application by using the configuration settings that you define in the configuration template. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-beanstalk-configurationtemplate.html properties: ApplicationName: description: |+ Name of the Elastic Beanstalk application that is associated with this configuration template. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Description: description: |+ An optional description for this configuration. _Type_: String _Required:_ No _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: String update_requires: some_interruptions EnvironmentId: description: |+ An environment whose settings you want to use to create the configuration template. You must specify this property if you don't specify the `SolutionStackName` or `SourceConfiguration` properties. _Type_: String _Required:_ Conditional _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement OptionSettings: description: |+ The options for the Elastic Beanstalk configuration, such as the instance type. For a complete list of Elastic Beanstalk configuration options, see [Option Values](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html), in the _AWS Elastic Beanstalk Developer Guide_. _Type_: List of [Elastic Beanstalk ConfigurationTemplate ConfigurationOptionSetting](aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html) _Required:_ No _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: List update_requires: some_interruptions PlatformArn: description: |+ The Amazon Resource Name (ARN) of the custom platform. For more information, see [Custom Platforms](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the _AWS Elastic Beanstalk Developer Guide_. Note If you specify `PlatformArn`, then don't specify `SolutionStackName`. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement SolutionStackName: description: |+ The name of an Elastic Beanstalk solution stack that this configuration will use. A solution stack specifies the operating system, architecture, and application server for a configuration template, such as `64bit Amazon Linux 2013.09 running Tomcat 7 Java 7`. For more information, see [Supported Platforms](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the _AWS Elastic Beanstalk Developer Guide_. You must specify this property if you don't specify the `PlatformArn`, `EnvironmentId`, or `SourceConfiguration` properties. _Type_: String _Required:_ Conditional _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement SourceConfiguration: description: |+ A configuration template that is associated with another Elastic Beanstalk application. If you specify the `SolutionStackName` property and the `SourceConfiguration` property, the solution stack in the source configuration template must match the value that you specified for the `SolutionStackName` property. You must specify this property if you don't specify the `EnvironmentId` or `SolutionStackName` properties. _Type_: [Elastic Beanstalk ConfigurationTemplate SourceConfiguration](aws-properties-beanstalk-configurationtemplate-sourceconfiguration.html) _Required:_ Conditional _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: Elastic Beanstalk ConfigurationTemplate SourceConfiguration update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ElasticBeanstalk::Environment: description: Creates or updates an AWS Elastic Beanstalk environment. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html properties: ApplicationName: description: |+ The name of the application that is associated with this environment. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement CNAMEPrefix: description: |+ A prefix for your Elastic Beanstalk environment URL. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Description: description: |+ A description that helps you identify this environment. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption EnvironmentName: description: |+ A name for the Elastic Beanstalk environment. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the environment name. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement OptionSettings: description: |+ Key-value pairs defining configuration options for this environment, such as the instance type. These options override the values that are defined in the solution stack or the [configuration template](aws-resource-beanstalk-configurationtemplate.html). If you remove any options during a stack update, the removed options revert to default values. _Required_: Yes. The `IamInstanceProfile` and `ServiceRole` options are required. _Type_: List of [Elastic Beanstalk Environment OptionSetting](aws-properties-beanstalk-option-settings.html) _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'yes' type: List update_requires: some_interruptions PlatformArn: description: |+ The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see [Custom Platforms](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the _AWS Elastic Beanstalk Developer Guide_. Note If you specify `PlatformArn`, then don't specify `SolutionStackName`. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) _Example_: `"PlatformArn": "arn:aws:elasticbeanstalk:us-east-1::platform/PHP 5.4 running on 64bit Amazon Linux/2.4.4"` required: 'no' type: String update_requires: no_interruption SolutionStackName: description: |+ The name of an Elastic Beanstalk solution stack that this configuration will use. For more information, see [Supported Platforms](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the _AWS Elastic Beanstalk Developer Guide_. Note If you specify `SolutionStackName`, then don't specify `PlatformArn` or `TemplateName`. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Tags: description: |+ An arbitrary set of tags (key–value pairs) for this environment. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: You can update tags only if you update another property that requires that the environment be replaced, such as the `ApplicationName` property. required: 'no' type: AWS CloudFormation Resource Tags update_requires: TemplateName: description: |+ The name of the Elastic Beanstalk configuration template to use with the environment. Note If you specify `TemplateName`, then don't specify `SolutionStackName`. _Required:_ No _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: String update_requires: some_interruptions Tier: description: |+ Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks. _Required:_ No _Type_: [Elastic Beanstalk Environment Tier Property Type](aws-properties-beanstalk-environment-tier.html) _Update requires_: See [Elastic Beanstalk Environment Tier Property Type](aws-properties-beanstalk-environment-tier.html) required: 'no' type: |- Elastic Beanstalk Environment Tier Property Type update_requires: VersionLabel: description: |+ The version to associate with the environment. _Required:_ No _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: String update_requires: some_interruptions return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). EndpointURL: description: |+ The URL to the load balancer for this environment. Example: `awseb-myst-myen-132MQC4KRLAMD-1371280482.``us-east-2``.elb.amazonaws.com` examples: {} AWS::ElasticLoadBalancing::LoadBalancer: description: |- The AWS::ElasticLoadBalancing::LoadBalancer type creates a LoadBalancer. Note If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the `DependsOn` attribute to declare a dependency on the VPC-gateway attachment. For more information, see [DependsOn Attribute](aws-attribute-dependson.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html properties: AccessLoggingPolicy: description: |+ Captures detailed information for all requests made to your load balancer, such as the time a request was received, client’s IP address, latencies, request path, and server responses. _Required:_ No _Type_: [Elastic Load Balancing AccessLoggingPolicy](aws-properties-ec2-elb-accessloggingpolicy.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Elastic Load Balancing AccessLoggingPolicy update_requires: no_interruption AppCookieStickinessPolicy: description: |+ Generates one or more stickiness policies with sticky session lifetimes that follow that of an application-generated cookie. These policies can be associated only with HTTP/HTTPS listeners. _Required:_ No _Type_: A list of [AppCookieStickinessPolicy](aws-properties-ec2-elb-AppCookieStickinessPolicy.html) objects. _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: A list of AppCookieStickinessPolicy objects. update_requires: no_interruption AvailabilityZones: description: |+ The Availability Zones in which to create the load balancer. You can specify the `AvailabilityZones` or `Subnets` property, but not both. Note For load balancers that are in a VPC, specify the `Subnets` property. _Required:_ No _Type_: List of String values _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) if you did not have an Availability Zone specified and you are adding one or if you are removing all Availability Zones. Otherwise, update requires [no interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: List update_requires: replacement ConnectionDrainingPolicy: description: |+ Whether deregistered or unhealthy instances can complete all in-flight requests. _Required:_ No _Type_: [Elastic Load Balancing ConnectionDrainingPolicy](aws-properties-ec2-elb-connectiondrainingpolicy.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- Elastic Load Balancing ConnectionDrainingPolicy update_requires: no_interruption ConnectionSettings: description: |+ Specifies how long front-end and back-end connections of your load balancer can remain idle. _Required:_ No _Type_: [Elastic Load Balancing ConnectionSettings](aws-properties-ec2-elb-connectionsettings.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Elastic Load Balancing ConnectionSettings update_requires: no_interruption CrossZone: description: |+ Whether cross-zone load balancing is enabled for the load balancer. With cross-zone load balancing, your load balancer nodes route traffic to the back-end instances across all Availability Zones. By default the `CrossZone` property is `false`. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption HealthCheck: description: |+ Application health check for the instances. _Required:_ No _Type_: [ElasticLoadBalancing LoadBalancer HealthCheck](aws-properties-ec2-elb-health-check.html). _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) if you did not have a health check specified and you are adding one or if you are removing a health check. Otherwise, update requires [no interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: ElasticLoadBalancing LoadBalancer HealthCheck. update_requires: replacement Instances: description: |+ A list of EC2 instance IDs for the load balancer. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption LBCookieStickinessPolicy: description: |+ Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent), or by a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners. _Required:_ No _Type_: A list of [LBCookieStickinessPolicy](aws-properties-ec2-elb-LBCookieStickinessPolicy.html) objects. _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: A list of LBCookieStickinessPolicy objects. update_requires: no_interruption LoadBalancerName: description: |+ A name for the load balancer. For valid values, see the `LoadBalancerName` parameter for the [`CreateLoadBalancer`](http://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_CreateLoadBalancer.html) action in the _Elastic Load Balancing API Reference version 2012-06-01_. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the load balancer. The name must be unique within your set of load balancers. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Listeners: description: |+ One or more listeners for this load balancer. Each listener must be registered for a specific port, and you cannot have more than one listener for a given port. Important If you update the property values for a listener specified by the `Listeners` property, AWS CloudFormation will delete the existing listener and create a new one with the updated properties. During the time that AWS CloudFormation is performing this action, clients will not be able to connect to the load balancer. _Required:_ Yes _Type_: A list of [ElasticLoadBalancing Listener Property Type](aws-properties-ec2-elb-listener.html) objects. _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: A list of ElasticLoadBalancing Listener Property Type objects. update_requires: no_interruption Policies: description: |+ A list of elastic load balancing policies to apply to this elastic load balancer. Specify only back-end server policies. For more information, see [DescribeLoadBalancerPolicyTypes](http://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancerPolicyTypes.html) in the _Elastic Load Balancing API Reference version 2012-06-01_. _Required:_ No _Type_: A list of [ElasticLoadBalancing policy](aws-properties-ec2-elb-policy.html) objects. _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: A list of ElasticLoadBalancing policy objects. update_requires: no_interruption Scheme: description: |+ For load balancers attached to an Amazon VPC, this parameter can be used to specify the type of load balancer to use. Specify `internal` to create an internal load balancer with a DNS name that resolves to private IP addresses or `internet-facing` to create a load balancer with a publicly resolvable DNS name, which resolves to public IP addresses. Note If you specify `internal`, you must specify subnets to associate with the load balancer, not Availability Zones. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement SecurityGroups: description: |+ _Required:_ No _Type_: A list of security groups assigned to your load balancer within your virtual private cloud (VPC). _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- A list of security groups assigned to your load balancer within your virtual private cloud (VPC). update_requires: no_interruption Subnets: description: |+ A list of subnet IDs in your virtual private cloud (VPC) to attach to your load balancer. Do not specify multiple subnets that are in the same Availability Zone. You can specify the `AvailabilityZones` or `Subnets` property, but not both. For more information about using Elastic Load Balancing in a VPC, see [How Do I Use Elastic Load Balancing in Amazon VPC](http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenariosForVPC.html) in the _Elastic Load Balancing Developer Guide_. _Required:_ No _Type_: List of String values _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) if you did not have an subnet specified and you are adding one or if you are removing all subnets. Otherwise, update requires [no interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). To update the load balancer to another subnet that is in the same Availability Zone, you must do two updates. You must first update the load balancer to use a subnet in different Availability Zone. After the update is complete, update the load balancer to use the new subnet that is in the original Availability Zone. required: 'no' type: List update_requires: replacement Tags: description: |+ An arbitrary set of tags (key-value pairs) for this load balancer. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For example, `mystack-myelb-1WQN7BJGDB5YQ`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). CanonicalHostedZoneName: description: |+ The name of the Amazon Route 53 hosted zone that is associated with the load balancer. Important If you specify `internal` for the Elastic Load Balancing scheme, use `DNSName` instead. For an `internal` scheme, the load balancer doesn't have a `CanonicalHostedZoneName` value. Example: `mystack-myelb-15HMABG9ZCN57-1013119603.``us-east-2``.elb.amazonaws.com` CanonicalHostedZoneNameID: description: |+ The ID of the Amazon Route 53 hosted zone name that is associated with the load balancer. Example: `Z3DZXE0Q79N41H` DNSName: description: |+ The DNS name for the load balancer. Example: `mystack-myelb-15HMABG9ZCN57-1013119603.``us-east-2``.elb.amazonaws.com` SourceSecurityGroup.GroupName: description: |+ The security group that you can use as part of your inbound rules for your load balancer's back-end Amazon EC2 application instances. Example: `amazon-elb` SourceSecurityGroup.OwnerAlias: description: |+ The owner of the source security group. Example: `amazon-elb-sg` examples: {} AWS::ElasticLoadBalancingV2::Listener: description: The `AWS::ElasticLoadBalancingV2::Listener` resource creates a listener for an Elastic Load Balancing Application or Network load balancer. The listener checks for connection requests and forwards them to one or more target groups. For more information, see [Getting Started](http://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/load-balancer-getting-started.html) in the _Elastic Load Balancing User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html properties: Certificates: description: |+ The SSL server certificate for the listener. With a certificate, you can encrypt traffic between the load balancer and the clients that initiate HTTPS sessions, and traffic between the load balancer and your targets. This property represents the default certificate for the listener. You can specify only one certificate for the `AWS::ElasticLoadBalancingV2::Listener` resource. _Required:_ Conditional. If you specify `HTTPS` for the `Protocol` property, specify a certificate. _Type_: List of [Elastic Load Balancing Listener Certificate](aws-properties-elasticloadbalancingv2-listener-certificates.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: List update_requires: no_interruption DefaultActions: description: |+ The default actions that the listener takes when handling incoming requests. _Required:_ Yes _Type_: List of [Elastic Load Balancing Listener Action](aws-properties-elasticloadbalancingv2-listener-defaultactions.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: List update_requires: no_interruption LoadBalancerArn: description: |+ The Amazon Resource Name (ARN) of the load balancer to associate with the listener. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Port: description: |+ The port on which the listener listens for requests. For valid values, see the `Port` parameter for the [CreateListener](http://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_CreateListener.html) action in the _Elastic Load Balancing API Reference version 2015-12-01_. _Required:_ Yes _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Number update_requires: no_interruption Protocol: description: |+ The protocol that clients must use to send requests to the listener. For valid values, see the `Protocol` parameter for the [CreateListener](http://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_CreateListener.html) action in the _Elastic Load Balancing API Reference version 2015-12-01_. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption SslPolicy: description: |+ The security policy that defines the ciphers and protocols that the load balancer supports. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the listener's ARN, such as `arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ElasticLoadBalancingV2::ListenerCertificate: description: The `AWS::ElasticLoadBalancingV2::ListenerCertificate` resource specifies certificates for an Elastic Load Balancing secure listener. For more information, see [Getting Started](http://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/load-balancer-getting-started.html) in the _Elastic Load Balancing User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html properties: Certificates: description: |+ Certificates specified for the listener. Duplicates not allowed. _Required_: Yes _Type_: List of [Elastic Load Balancing ListenerCertificate Certificate](aws-properties-elasticloadbalancingv2-listenercertificate-certificate.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: List update_requires: replacement ListenerArn: description: |+ The Amazon Resource Name (ARN) of the listener. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: '' examples: {} AWS::ElasticLoadBalancingV2::ListenerRule: description: The `AWS::ElasticLoadBalancingV2::ListenerRule` resource defines which requests an Elastic Load Balancing listener takes action on and the action that it takes. For more information, see [Getting Started](http://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/load-balancer-getting-started.html) in the _Elastic Load Balancing User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html properties: Actions: description: |+ The action that the listener takes when a request meets the specified condition. _Required:_ Yes _Type_: List of [Elastic Load Balancing ListenerRule Actions](aws-properties-elasticloadbalancingv2-listenerrule-actions.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: List update_requires: no_interruption Conditions: description: |+ The conditions under which a rule takes effect. _Required:_ Yes _Type_: List of [Elastic Load Balancing ListenerRule Conditions](aws-properties-elasticloadbalancingv2-listenerrule-conditions.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: List update_requires: no_interruption ListenerArn: description: |+ The Amazon Resource Name (ARN) of the listener that the rule applies to. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Priority: description: |+ The priority for the rule. Elastic Load Balancing evaluates rules in priority order, from the lowest value to the highest value. If a request satisfies a rule, Elastic Load Balancing ignores all subsequent rules. Note A listener can have only one rule with a given priority. For valid values, see the `Priority` parameter for the [CreateRule](http://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_CreateRule.html) action in the _Elastic Load Balancing API Reference version 2015-12-01_. _Required:_ Yes _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Number update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the rule's ARN, such as `arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ElasticLoadBalancingV2::LoadBalancer: description: |- The `AWS::ElasticLoadBalancingV2::LoadBalancer` resource creates an Elastic Load Balancing Application or Network Load Balancer. For more information, see the see [Getting Started](http://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/load-balancer-getting-started.html) in the _Elastic Load Balancing User Guide_. Note AWS CloudFormation does not automatically create tags (key–value pairs) for an Elastic Load Balancing load balancer. You must use the [`Tags`](aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-tags) property to create tags to associate with the load balancer. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html properties: LoadBalancerAttributes: description: |+ Specifies the load balancer configuration. _Required:_ No _Type_: A list of [Elastic Load Balancing LoadBalancer LoadBalancerAttributes](aws-properties-elasticloadbalancingv2-loadbalancer-loadbalancerattributes.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: A list of Elastic Load Balancing LoadBalancer LoadBalancerAttributes update_requires: no_interruption Name: description: |+ Specifies a name for the load balancer. This name must be unique within your AWS account and can have a maximum of 32 alphanumeric characters and hyphens. A name can't begin or end with a hyphen. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Scheme: description: |+ Specifies whether the load balancer is internal or Internet-facing. Valid values are `internet-facing` and `internal`. The default is `internet-facing`. The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the Internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement SecurityGroups: description: |+ [Application Load Balancers] Specifies a list of the IDs of the security groups to assign to the load balancer. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption SubnetMappings: description: |+ The subnets to attach to the load balancer, specified as a list of `SubnetMapping` property types. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. [Application Load Balancers] The load balancer is allocated one static IP address per subnet. You cannot specify your own Elastic IP addresses. [Network Load Balancers] You can specify one Elastic IP address per subnet. _Required:_ No _Type_: List of [Elastic Load Balancing LoadBalancer SubnetMapping](aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement Subnets: description: |+ The subnets to attach to the load balancer, specified as a list of subnet IDs. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. [Application Load Balancers] You must specify subnets from at least two Availability Zones. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Tags: description: |+ Specifies an arbitrary set of tags (key–value pairs) to associate with this load balancer. Use tags to manage your resources. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption Type: description: |+ Specifies the type of load balancer to create. Valid values are `application` and `network`.The default is `application`. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement IpAddressType: description: |+ [Application Load Balancers] The type of IP addresses that are used by the load balancer's subnets, such as `ipv4` (for IPv4 addresses) or `dualstack` (for IPv4 and IPv6 addresses). For valid values, see the `IpAddressType` parameter for the `CreateLoadBalancer` action in the _Elastic Load Balancing API Reference version 2015-12-01_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the ARN of the load balancer, for example: Copyarn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/50dc6c495c0c9188 For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). DNSName: description: |+ The DNS name for the load balancer, for example `my-load-balancer-424835706.us-west-2.elb.amazonaws.com`. CanonicalHostedZoneID: description: |+ The ID of the Amazon Route 53 hosted zone associated with the load balancer, for example `Z2P70J7EXAMPLE`. LoadBalancerFullName: description: |+ The full name of the load balancer, for example `app/my-load-balancer/50dc6c495c0c9188`. LoadBalancerName: description: |+ The name of the load balancer, for example `my-load-balancer`. SecurityGroups: description: |+ The IDs of the security groups for the load balancer, for example `sg-123456a`. examples: {} AWS::ElasticLoadBalancingV2::TargetGroup: description: The `AWS::ElasticLoadBalancingV2::TargetGroup` resource creates an Elastic Load Balancing target group that routes requests to one or more registered targets, such as EC2 instances. For more information, see [Getting Started](http://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/load-balancer-getting-started.html) in the _Elastic Load Balancing User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html properties: HealthCheckIntervalSeconds: description: |+ The approximate number of seconds between health checks for an individual target. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption HealthCheckPath: description: |+ The ping path destination where Elastic Load Balancing sends health check requests. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption HealthCheckPort: description: |+ The port that the load balancer uses when performing health checks on the targets. For valid and default values, see the `HealthCheckPort` parameter for the [CreateTargetGroup](http://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_CreateTargetGroup.html) action in the _Elastic Load Balancing API Reference version 2015-12-01_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption HealthCheckProtocol: description: |+ The protocol that the load balancer uses when performing health checks on the targets, such as `HTTP` or `HTTPS`. For valid and default values, see the `HealthCheckProtocol` parameter for the [CreateTargetGroup](http://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_CreateTargetGroup.html) action in the _Elastic Load Balancing API Reference version 2015-12-01_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption HealthCheckTimeoutSeconds: description: |+ The number of seconds to wait for a response before considering that a health check has failed. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption HealthyThresholdCount: description: |+ The number of consecutive successful health checks that are required before an unhealthy target is considered healthy. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption Matcher: description: |+ The HTTP codes that a healthy target uses when responding to a health check. _Required:_ No _Type_: [Elastic Load Balancing TargetGroup Matcher](aws-properties-elasticloadbalancingv2-targetgroup-matcher.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Elastic Load Balancing TargetGroup Matcher update_requires: no_interruption Name: description: |+ A name for the target group. Important This name must be unique per account, per region. The target group name should be shorter than 22 characters because AWS CloudFormation uses the target group name to create the name of the load balancer. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Port: description: |+ The port on which the targets receive traffic. _Required:_ Yes _Type_: Integer _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: Number update_requires: replacement Protocol: description: |+ The protocol to use for routing traffic to the targets. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Tags: description: |+ An arbitrary set of tags (key–value pairs) for the target group. Use tags to help manage resources. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption TargetGroupAttributes: description: |+ Target group configurations. _Required:_ No _Type_: List of [Elastic Load Balancing TargetGroup TargetGroupAttributes](aws-properties-elasticloadbalancingv2-targetgroup-targetgroupattributes.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Targets: description: |+ The targets to add to this target group. _Required:_ No _Type_: List of [Elastic Load Balancing TargetGroup TargetDescription](aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption TargetType: description: |+ The registration type of the targets in this target group. Valid values are `instance` and `ip`. The default is `instance`. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement UnhealthyThresholdCount: description: |+ The number of consecutive failed health checks that are required before a target is considered unhealthy. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption VpcId: description: |+ The ID of the VPC in which your targets are located. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the target group's Amazon Resource Name (ARN), such as `arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). LoadBalancerArns: description: |+ A list of Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group, such as `[ "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" ]`. TargetGroupFullName: description: |+ The full name of the target group, such as `targetgroup/my-target-group/cbf133c568e0d028`. TargetGroupName: description: |+ The name of the target group, such as `my-target-group`. This is the value of the target group's `Name` property. examples: {} AWS::Elasticsearch::Domain: description: The `AWS::Elasticsearch::Domain` resource creates an Amazon Elasticsearch Service (Amazon ES) domain that encapsulates the Amazon ES engine instances. For more information, see [CreateElasticsearchDomain](http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-actions-createelasticsearchdomain) in the _Amazon Elasticsearch Service Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html properties: AccessPolicies: description: |+ An AWS Identity and Access Management (IAM) policy document that specifies who can access the Amazon ES domain and their permissions. For more information, see [Configuring Access Policies](http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies) in the _Amazon Elasticsearch Service Developer Guide_. _Required:_ No _Type_: JSON object _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: JSON update_requires: no_interruption AdvancedOptions: description: |+ Additional options to specify for the Amazon ES domain. For more information, see [Configuring Advanced Options](http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options) in the _Amazon Elasticsearch Service Developer Guide_. _Required:_ No _Type_: A JSON object that consists of a string key-value pair, such as: Copy{ "rest.action.multi.allow_explicit_index": "true" } _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: 'A JSON object that consists of a string key-value pair, such as:' update_requires: replacement DomainName: description: |+ A name for the Amazon ES domain. For valid values, see the [DomainName](http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-datatypes-domainname) data type in the _Amazon Elasticsearch Service Developer Guide_. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement EBSOptions: description: |+ The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon ES domain. For more information, see [Configuring EBS-based Storage](http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs) in the _Amazon Elasticsearch Service Developer Guide_. _Required:_ No _Type_: [Amazon ES Domain EBSOptions](aws-properties-elasticsearch-domain-ebsoptions.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon ES Domain EBSOptions update_requires: no_interruption ElasticsearchClusterConfig: description: |+ The cluster configuration for the Amazon ES domain. You can specify options such as the instance type and the number of instances. For more information, see [Configuring Amazon ES Domains](http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains-configure-cluster-cli) in the _Amazon Elasticsearch Service Developer Guide_. _Required:_ No _Type_: [Amazon ES Domain ElasticsearchClusterConfig](aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon ES Domain ElasticsearchClusterConfig update_requires: no_interruption ElasticsearchVersion: description: |+ The version of Elasticsearch to use, such as `2.3`. For information about the versions that Amazon ES supports, see the `Elasticsearch-Version` parameter for the [CreateElasticsearchDomain](http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-actions-createelasticsearchdomain) action in the _Amazon Elasticsearch Service Developer Guide_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement SnapshotOptions: description: |+ The automated snapshot configuration for the Amazon ES domain indices. _Required:_ No _Type_: [Amazon ES Domain SnapshotOptions](aws-properties-elasticsearch-domain-snapshotoptions.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon ES Domain SnapshotOptions update_requires: no_interruption Tags: description: |+ An arbitrary set of tags (key–value pairs) to associate with the Amazon ES domain. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption VPCOptions: description: |+ The virtual private cloud (VPC) configuration for the Amazon ES domain. For more information, see [VPC Support for Amazon Elasticsearch Service Domains](http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html) in the _Amazon Elasticsearch Service Developer Guide_. _Required_: No _Type_: [Amazon ES Domain VPCOptions](aws-properties-elasticsearch-domain-vpcoptions.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon ES Domain VPCOptions update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name, such as `mystack-elasticsea-abc1d2efg3h4`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). DomainArn: description: |+ The Amazon Resource Name (ARN) of the domain, such as `arn:aws:es:us-west-2:123456789012:domain/mystack-elasti-1ab2cdefghij`. DomainEndpoint: description: |+ The domain-specific endpoint that's used to submit index, search, and data upload requests to an Amazon ES domain, such as `search-mystack-elasti-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-2.es.amazonaws.com`. examples: {} AWS::EMR::Cluster: description: The `AWS::EMR::Cluster` resource creates an Amazon EMR cluster. This cluster is a collection of EC2 instances that you can run big data frameworks on to process and analyze vast amounts of data. For more information, see [Plan an Amazon EMR Cluster](http://docs.aws.amazon.com//ElasticMapReduce/latest/ManagementGuide/emr-plan.html) in the _Amazon EMR Management Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html properties: AdditionalInfo: description: |+ (Intended for advanced uses only.) Additional features that you want to select. This is meta information about third-party applications that third-party vendors use for testing purposes. _Required:_ No _Type_: JSON object _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: JSON update_requires: replacement Applications: description: |+ The software applications to deploy on the cluster, and the arguments that Amazon EMR passes to those applications. _Required:_ No _Type_: List of [Amazon EMR Cluster Application](aws-properties-emr-cluster-application.html) property types _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement AutoScalingRole: description: |+ An AWS Identity and Access Management (IAM) role for automatic scaling policies. The default role is `EMR_AutoScaling_DefaultRole`. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement BootstrapActions: description: |+ A list of bootstrap actions that Amazon EMR runs before starting applications on the cluster. _Required:_ No _Type_: List of [Amazon EMR Cluster BootstrapActionConfig](aws-properties-emr-cluster-bootstrapactionconfig.html) property types _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement Configurations: description: |+ The software configuration of the Amazon EMR cluster. _Required:_ No _Type_: List of [Amazon EMR Cluster Configurations](aws-properties-emr-cluster-configuration.html) property types _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement CustomAmiId: description: |+ A custom Amazon Linux AMI for the cluster (instead of an EMR-owned AMI). For more information, see [Using a Custom AMI](http://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-custom-ami.html) in the _Amazon EMR Management Guide_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) _Example_: `"CustomAmiId" : "ami-7fb3bc69"` required: 'no' type: String update_requires: replacement EbsRootVolumeSize: description: |+ The size, in GiB, of the EBS root device volume of the Linux AMI that's used for each EC2 instance. Currently, AWS CloudFormation supports only Amazon EMR 4.0 and later software releases. _Required_: No _Type_: Integer _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Number update_requires: replacement Instances: description: |+ Configures the EC2 instances that run jobs in the Amazon EMR cluster. _Required:_ Yes _Type_: [Amazon EMR Cluster JobFlowInstancesConfig](aws-properties-emr-cluster-jobflowinstancesconfig.html) _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'yes' type: |- Amazon EMR Cluster JobFlowInstancesConfig update_requires: some_interruptions JobFlowRole: description: |+ (Also called _instance profile_ and _EC2 role_.) Accepts an instance profile that's associated with the role that you want to use. All EC2 instances in the cluster assume this role. For more information, see [Create and Use IAM Roles for Amazon EMR](http://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-iam-roles-creatingroles.html) in the _Amazon EMR Management Guide_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement LogUri: description: |+ An S3 bucket location that Amazon EMR writes logs files to from a job flow. If you don't specify a value, Amazon EMR doesn't write any log files. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Name: description: |+ A name for the Amazon EMR cluster. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement ReleaseLabel: description: |+ The Amazon EMR software release label. A release is a set of software applications and components that you can install and configure on an Amazon EMR cluster. For more information, see [About Amazon EMR Releases](http://docs.aws.amazon.com//ElasticMapReduce/latest/ReleaseGuide/emr-release-components.html) in the _Amazon EMR Release Guide_. Currently, AWS CloudFormation supports only Amazon EMR 4.0 and later software releases. _Required:_ Conditional. If you specify the `Applications` property, you must specify this property. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement ScaleDownBehavior: description: |+ Indicates how individual EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. For more information, see [Cluster](http://docs.aws.amazon.com//ElasticMapReduce/latest/API/API_Cluster.html) in the Amazon EMR API Reference. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement SecurityConfiguration: description: |+ The name of the security configuration that's applied to the cluster. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement ServiceRole: description: |+ The IAM role that Amazon EMR assumes to access AWS resources on your behalf. For more information, see [Configure IAM Roles for Amazon EMR](http://docs.aws.amazon.com//ElasticMapReduce/latest/ManagementGuide/emr-iam-roles.html) in the _Amazon EMR Management Guide_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Tags: description: |+ An arbitrary set of tags (key–value pairs) to help you identify the Amazon EMR cluster. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption VisibleToAllUsers: description: |+ Indicates whether the instances in the cluster are visible to all IAM users in the AWS account. If you specify `true`, all IAM users can view and (if they have permissions) manage the instances. If you specify `false`, only the IAM user that created the cluster can view and manage it. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) _Default value_: `false` required: 'no' type: Boolean update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the cluster ID, such as `j-1ABCD123AB1A`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). MasterPublicDNS: description: |+ The public DNS name of the master node (instance), such as `ec2-12-123-123-123.us-west-2.compute.amazonaws.com`. examples: {} AWS::EMR::InstanceFleetConfig: description: |- Use the `AWS::EMR::InstanceFleetConfig` resource to configure a Spot Instance fleet for an Amazon EMR cluster. For more information, see [Configure Instance Fleets](http://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-fleet.html) in the _Amazon EMR Management Guide_. Note The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html properties: ClusterId: description: |+ The ID of the target cluster. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement InstanceFleetType: description: |+ The node type that the instance fleet hosts. Valid values are `MASTER`, `CORE`, and `TASK`. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement InstanceTypeConfigs: description: |+ The instance type configurations that define the EC2 instances in the instance fleet. Duplicates not allowed. _Required:_ No _Type_: List of [Amazon EMR InstanceFleetConfig InstanceTypeConfig](aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement LaunchSpecifications: description: |+ The launch specification for the instance fleet. _Required:_ No _Type_: [Amazon EMR InstanceFleetConfig InstanceFleetProvisioningSpecifications](aws-properties-elasticmapreduce-instancefleetconfig-instancefleetprovisioningspecifications.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Amazon EMR InstanceFleetConfig InstanceFleetProvisioningSpecifications update_requires: replacement Name: description: |+ The friendly name of the instance fleet. For constraints, see [InstanceFleetConfig](http://docs.aws.amazon.com/ElasticMapReduce/latest/API/API_InstanceFleetConfig.html) in the _Amazon EMR API Reference_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement TargetOnDemandCapacity: description: |+ The target capacity of On-Demand units for the instance fleet. This determines how many On-Demand Instances to provision. For more information, see [InstanceFleetConfig](http://docs.aws.amazon.com/ElasticMapReduce/latest/API/API_InstanceFleetConfig.html) in the _Amazon EMR API Reference_. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption TargetSpotCapacity: description: |+ The target capacity of Spot units for the instance fleet. This determines how many Spot Instances to provision. For more information, see [InstanceFleetConfig](http://docs.aws.amazon.com/ElasticMapReduce/latest/API/API_InstanceFleetConfig.html) in the _Amazon EMR API Reference_. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::EMR::InstanceGroupConfig: description: |- The `AWS::EMR::InstanceGroupConfig` resource configures a task instance group for an Amazon EMR cluster. Note You can't delete an instance group. If you remove an instance group, AWS CloudFormation sets the instance count to zero (`0`). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html properties: AutoScalingPolicy: description: |+ An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. An automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. For more information, see [PutAutoScalingPolicy](http://docs.aws.amazon.com//ElasticMapReduce/latest/API/API_PutAutoScalingPolicy.html) in the Amazon EMR API Reference. _Required:_ No _Type_: [Amazon EMR InstanceGroupConfig AutoScalingPolicy](aws-properties-elasticmapreduce-instancegroupconfig-autoscalingpolicy.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- Amazon EMR InstanceGroupConfig AutoScalingPolicy update_requires: no_interruption BidPrice: description: |+ The bid price in USD for each Amazon EC2 instance in the instance group when launching instances (nodes) as Spot Instances. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Configurations: description: |+ A list of configurations to apply to this instance group. For more information see, [Configuring Applications](http://docs.aws.amazon.com//ElasticMapReduce/latest/ReleaseGuide/emr-configure-apps.html) in the _Amazon EMR Release Guide_. _Required:_ No _Type_: List of [Amazon EMR Cluster Configurations](aws-properties-emr-cluster-configuration.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement EbsConfiguration: description: |+ Configures Amazon Elastic Block Store (Amazon EBS) storage volumes to attach to your instances. _Required:_ No _Type_: [Amazon EMR EbsConfiguration](aws-properties-emr-ebsconfiguration.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Amazon EMR EbsConfiguration update_requires: replacement InstanceCount: description: |+ The number of instances to launch in the instance group. _Required:_ Yes _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Number update_requires: no_interruption InstanceRole: description: |+ The role of the servers in the Amazon EMR cluster, such as `TASK`. For more information, see [Instance Groups](http://docs.aws.amazon.com//ElasticMapReduce/latest/ManagementGuide/InstanceGroups.html) in the _Amazon EMR Management Guide_. Note Currently, the only valid value is `TASK`. You configure the master and core instance groups as part of the [AWS::EMR::Cluster](aws-resource-emr-cluster.html) resource. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement InstanceType: description: |+ The EC2 instance type for all instances in the instance group. For more information, see [Instance Configurations](http://docs.aws.amazon.com//ElasticMapReduce/latest/ManagementGuide/emr-plan-ec2-instances.html) in the _Amazon EMR Management Guide_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement JobFlowId: description: |+ The ID of an Amazon EMR cluster that you want to associate this instance group with. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Market: description: |+ The type of marketplace from which your instances are provisioned into this group, either `ON_DEMAND` or `SPOT`. For more information, see [Amazon EC2 Purchasing Options](https://aws.amazon.com/ec2/purchasing-options/). _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Name: description: |+ A name for the instance group. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the instance group ID, such as `ig-ABC12DEF3456`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EMR::SecurityConfiguration: description: The `AWS::EMR::SecurityConfiguration` resource creates a security configuration that is stored in the Amazon EMR web service. You can specify the security configuration when creating a cluster. For more information, see [Specifying Amazon EMR Encryption Options Using a Security Configuration](http://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-encryption-enable-security-configuration.html) in the _Amazon EMR Release Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-securityconfiguration.html properties: Name: description: |+ The name of the security configuration. For a list of valid parameters for encryption settings, see [AWS CLI Security Configuration JSON Reference](http://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-encryption-enable-security-configuration.html#emr-encryption-cli-parameters) in the _Amazon EMR Release Guide_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement SecurityConfiguration: description: |+ The security configuration details in JSON format. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the security configuration name, such as `mySecurityConfiguration`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::EMR::Step: description: |- The `AWS::EMR::Step` resource creates a unit of work (a job flow step) that you submit to an Amazon EMR (Amazon EMR) cluster. The job flow step contains instructions for processing data on the cluster. Note You can't delete work flow steps. During a stack update, if you remove a step, AWS CloudFormation takes no action. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html properties: ActionOnFailure: description: "The action to take if the job flow step fails. Currently, AWS CloudFormation supports `CONTINUE` and `CANCEL_AND_WAIT`.\n\n- \n\n`TERMINATE_CLUSTER` indicates that all associated cluster resources terminate if the step fails, and no subsequent steps or jobs are attempted.\n\n- \n\n`CANCEL_AND_WAIT` indicates that the step is canceled, and all subsequent steps and jobs are attempted.\n\nFor more information, see [Managing Cluster Termination](http://docs.aws.amazon.com//ElasticMapReduce/latest/ManagementGuide/UsingEMR_TerminationProtection.html) in the _Amazon EMR Management Guide_.\n\n_Required:_ Yes\n\n_Type_: String\n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n\n" required: 'yes' type: String update_requires: replacement HadoopJarStep: description: |+ The JAR file that includes the main function that Amazon EMR executes. _Required:_ Yes _Type_: [Amazon EMR Step HadoopJarStepConfig](aws-properties-emr-step-hadoopjarstepconfig.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: |- Amazon EMR Step HadoopJarStepConfig update_requires: replacement JobFlowId: description: |+ The ID of a cluster in which you want to run this job flow step. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Name: description: |+ A name for the job flow step. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the step ID, such as `s-1A2BC3D4EFG56`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Events::Rule: description: The `AWS::Events::Rule` resource creates a rule that matches incoming Amazon CloudWatch Events (CloudWatch Events) events and routes them to one or more targets for processing. For more information, see [Using CloudWatch Events](http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/WhatIsCloudWatchEvents.html) in the _Amazon CloudWatch User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html properties: Description: description: |+ A description of the rule's purpose. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption EventPattern: description: |+ Describes which events CloudWatch Events routes to the specified target. These routed events are matched events. For more information, see [Events and Event Patterns](http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CloudWatchEventsandEventPatterns.html) in the _Amazon CloudWatch User Guide_. _Required:_ Conditional. You must specify this property, the `ScheduleExpression` property, or both. _Type_: JSON object _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: JSON update_requires: no_interruption Name: description: |+ A name for the rule. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement ScheduleExpression: description: |+ The schedule or rate (frequency) that determines when CloudWatch Events runs the rule. For more information, see [Schedule Expression Syntax for Rules](http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html) in the _Amazon CloudWatch User Guide_. _Required:_ Conditional. You must specify this property, the `EventPattern` property, or both. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption State: description: |+ Indicates whether the rule is enabled. For valid values, see the `State` parameter for the [PutRule](http://docs.aws.amazon.com/AmazonCloudWatchEvents/latest/APIReference/API_PutRule.html) action in the _Amazon CloudWatch Events API Reference_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Targets: description: |+ The resources, such as Lambda functions or Kinesis streams, that CloudWatch Events routes events to and invokes when the rule is triggered. For information about valid targets, see the [PutTargets](http://docs.aws.amazon.com/AmazonCloudWatchEvents/latest/APIReference/API_PutTargets.html) action in the _Amazon CloudWatch Events API Reference_. Note Creating rules with built-in targets is supported only in the AWS Management Console. _Required:_ No _Type_: List of [Amazon CloudWatch Events Rule Target](aws-properties-events-rule-target.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the event rule ID, such as `mystack-ScheduledRule-ABCDEFGHIJK`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ The event rule Amazon Resource Name (ARN), such as `arn:aws:events:``us-east-2``:123456789012:rule/example`. examples: {} AWS::GameLift::Alias: description: The `AWS::GameLift::Alias` resource creates an alias for an Amazon GameLift (GameLift) fleet, which you can use to anonymize your fleet. You can reference the alias instead of a specific fleet when you create game sessions. For more information, see the [CreateAlias](http://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateAlias.html) action in the _Amazon GameLift API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html properties: Description: description: |+ Information that helps you identify the purpose of this alias. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Name: description: |+ An identifier to associate with this alias. Alias names don't need to be unique. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption RoutingStrategy: description: |+ A routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message. _Required:_ Yes _Type_: [Amazon GameLift Alias RoutingStrategy](aws-properties-gamelift-alias-routingstrategy.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: |- Amazon GameLift Alias RoutingStrategy update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the alias ID, such as `myalias-a01234b56-7890-1de2-f345-g67h8i901j2k`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::GameLift::Build: description: The `AWS::GameLift::Build` resource creates a build that includes all of the components to run your game server in an Amazon GameLift (GameLift) fleet. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html properties: Name: description: |+ An identifier to associate with this build. Build names don't need to be unique. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption StorageLocation: description: |+ The Amazon Simple Storage Service (Amazon S3) location where your build package files are located. _Required:_ No, but we recommend that you specify a location. If you don't specify this property, you must manually upload your build package files to GameLift. _Type_: [Amazon GameLift Build StorageLocation](aws-properties-gamelift-build-storagelocation.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: |- Amazon GameLift Build StorageLocation update_requires: replacement Version: description: |+ A version to associate with this build. Version is useful if you want to track updates to your build package files. Versions don't need to be unique. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the build ID, such as `mybuild-a01234b56-7890-1de2-f345-g67h8i901j2k`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::GameLift::Fleet: description: The `AWS::GameLift::Fleet` resource creates an Amazon GameLift (GameLift) fleet to host game servers. A fleet is a set of EC2 instances, each of which is a host in the fleet. For more information, see the [CreateFleet](http://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html) action in the _Amazon GameLift API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html properties: BuildId: description: |+ The unique identifier for the build that you want to use with this fleet. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Description: description: |+ Information that helps you identify the purpose of this fleet. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption DesiredEC2Instances: description: |+ The number of EC2 instances that you want in this fleet. _Required:_ Yes _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Number update_requires: no_interruption EC2InboundPermissions: description: |+ The incoming traffic, expressed as IP ranges and port numbers, that is permitted to access the game server. If you don't specify values, no traffic is permitted to your game servers. _Required:_ No _Type_: List of [Amazon GameLift Fleet EC2InboundPermission](aws-properties-gamelift-fleet-ec2inboundpermission.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption EC2InstanceType: description: |+ The type of EC2 instances that the fleet uses. EC2 instance types define the CPU, memory, storage, and networking capacity of the fleet's hosts. For more information about the instance types that are supported by GameLift, see the [EC2InstanceType](http://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html#gamelift-CreateFleet-request-EC2InstanceType) parameter in the _Amazon GameLift API Reference_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement LogPaths: description: |+ The path to game-session log files that are generated by your game server, with the slashes (`\`) escaped. After a game session has been terminated, GameLift captures and stores the logs in an S3 bucket. _Required:_ No _Type_: List of String values _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement MaxSize: description: |+ The maximum number of EC2 instances that you want to allow in this fleet. By default, AWS CloudFormation, sets this property to `1`. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption MinSize: description: |+ The minimum number of EC2 instances that you want to allow in this fleet. By default, AWS CloudFormation, sets this property to `0`. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption Name: description: |+ An identifier to associate with this fleet. Fleet names don't need to be unique. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption ServerLaunchParameters: description: |+ The parameters that are required to launch your game server. Specify these parameters as a string of command-line parameters, such as `+sv_port 33435 +start_lobby`. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement ServerLaunchPath: description: |+ The location of your game server that GameLift launches. You must escape the slashes (`\`) and use the following pattern: `C:\\game\\launchpath`. For example, if your game server files are in the `MyGame` folder, the path should be `C:\\game\\MyGame\\server.exe`. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the fleet ID, such as `myfleet-a01234b56-7890-1de2-f345-g67h8i901j2k`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Glue::Classifier: description: The `AWS::Glue::Classifier` resource creates an AWS Glue classifier that categorizes data sources and specifies schemas. For more information, see [Adding Classifiers to a Crawler](http://docs.aws.amazon.com/glue/latest/dg/add-classifier.html) and [Classifier Structure](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-crawler-classifiers.html#aws-glue-api-crawler-classifiers-Classifier) in the _AWS Glue Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html properties: GrokClassifier: description: |+ A classifier that uses `grok`. _Required_: No _Type_: [AWS Glue Classifier GrokClassifier](aws-properties-glue-classifier-grokclassifier.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS Glue Classifier GrokClassifier update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Glue::Connection: description: The `AWS::Glue::Connection` resource specifies an AWS Glue connection to a data source. For more information, see [Adding a Connection to Your Data Store](http://docs.aws.amazon.com/glue/latest/dg/populate-add-connection.html) and [Connection Structure](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-connections.html#aws-glue-api-catalog-connections-Connection) in the _AWS Glue Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connection.html properties: ConnectionInput: description: |+ The connection that you want to create. _Required_: Yes _Type_: [AWS Glue Connection ConnectionInput](aws-properties-glue-connection-connectioninput.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: AWS Glue Connection ConnectionInput update_requires: no_interruption CatalogId: description: |+ The ID of the data catalog to create the catalog object in. Currently, this should be the AWS account ID. Note To specify the account ID, you can use the `Ref` intrinsic function with the `AWS::AccountId` pseudo parameter—for example `!Ref AWS::AccountId`. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the `ConnectionInput` name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Glue::Crawler: description: The `AWS::Glue::Crawler` resource specifies an AWS Glue crawler. For more information, see [Cataloging Tables with a Crawler](http://docs.aws.amazon.com/glue/latest/dg/add-crawler.html) and [Crawler Structure](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-crawler-crawling.html#aws-glue-api-crawler-crawling-Crawler) in the _AWS Glue Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html properties: Role: description: |+ The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon S3 data. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Classifiers: description: |+ A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler. _Required_: No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Description: description: |+ A description of the crawler and where it should be used. It must match the URI address multi-line string pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*` _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption SchemaChangePolicy: description: |+ The policy that specifies update and delete behaviors for the crawler. _Required_: No _Type_: [AWS Glue Crawler SchemaChangePolicy](aws-properties-glue-crawler-schemachangepolicy.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS Glue Crawler SchemaChangePolicy update_requires: no_interruption Schedule: description: |+ The schedule for the crawler. _Required_: No _Type_: [AWS Glue Crawler Schedule](aws-properties-glue-crawler-schedule.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS Glue Crawler Schedule update_requires: no_interruption DatabaseName: description: |+ The name of the database where the crawler's output is stored. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Targets: description: |+ The crawler targets. _Required_: Yes _Type_: [AWS Glue Crawler Targets](aws-properties-glue-crawler-targets.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: AWS Glue Crawler Targets update_requires: no_interruption TablePrefix: description: |+ The table prefix that's used for catalog tables that are created. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Name: description: |+ The name of the crawler. Must match the single-line string pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*` _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Glue::Database: description: The `AWS::Glue::Database` resource specifies a logical grouping of tables in AWS Glue. For more information, see [Defining a Database in Your Data Catalog](http://docs.aws.amazon.com/glue/latest/dg/define-database.html) and [Database Structure](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-databases.html#aws-glue-api-catalog-databases-Database) in the _AWS Glue Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-database.html properties: DatabaseInput: description: |+ The metadata of the database. _Required_: Yes _Type_: [AWS Glue Database DatabaseInput](aws-properties-glue-database-databaseinput.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: AWS Glue Database DatabaseInput update_requires: no_interruption CatalogId: description: |+ The ID of the data catalog to create the catalog object in. Currently, this should be the AWS account ID. Note To specify the account ID, you can use the `Ref` intrinsic function with the `AWS::AccountId` pseudo parameter—for example `!Ref AWS::AccountId`. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the `DatabaseInput` name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Glue::DevEndpoint: description: The `AWS::Glue::DevEndpoint` resource specifies a development endpoint where a developer can remotely debug ETL scripts for AWS Glue. For more information, see [DevEndpoint Structure](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-dev-endpoint.html#aws-glue-api-jobs-dev-endpoint-DevEndpoint) in the _AWS Glue Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html properties: EndpointName: description: |+ The name of the endpoint. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement ExtraJarsS3Path: description: |+ The path to one or more Java Jars in an Amazon S3 bucket to load in your endpoint. Note You can currently use only pure Java/Scala libraries on a DevEndpoint. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption ExtraPythonLibsS3Path: description: |+ The path to one or more Python libraries in an Amazon S3 bucket to load in your endpoint. Note You can currently use only pure Python libraries on a DevEndpoint. Libraries that rely on C extensions, such as the [pandas](http://pandas.pydata.org/) Python data analysis library, aren't supported yet. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption NumberOfNodes: description: |+ The number of nodes that the endpoint uses. _Required_: No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption PublicKey: description: |+ The public key for the endpoint to use for authentication. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption RoleArn: description: |+ The Amazon Resource Name (ARN) of the IAM role for the endpoint. It must match the AWS ARN string pattern: `arn:aws:iam::\d{12}:role/.*` _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption SecurityGroupIds: description: |+ A list of UTF-8 strings that specify the security group IDs for the endpoint. _Required_: No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption SubnetId: description: |+ The subnet ID for the endpoint. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::Glue::Job: description: The `AWS::Glue::Job` resource specifies an AWS Glue job in the data catalog. For more information, see [Adding Jobs in AWS Glue](http://docs.aws.amazon.com/glue/latest/dg/add-job.html) and [Job Structure](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job) in the _AWS Glue Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html properties: Role: description: |+ The role that's associated with the job. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption DefaultArguments: description: "UTF-8 string–to–UTF-8 string key-value pairs that specify the default parameters for the job.\n\nYou can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes. For information about how to specify and consume your own Job arguments, see the [Passing and Accessing Python Parameters in AWS Glue](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-crawler-pyspark-extensions-python-intro.html#aws-glue-api-crawler-pyspark-extensions-python-intro-parameters) in the _AWS Glue Developer Guide_.\n\nAWS Glue consumes the following arguments to set up the Job script environment:\n\n- \n\n`--scriptLocation` — The Amazon S3 location where your ETL script is located (in a form like `s3://path/to/my/script.py`).\n\n- \n\n`--extra-py-files` — Amazon S3 path(s) to additional Python modules that AWS Glue adds to the Python path before executing your script. Multiple values must be complete paths separated by a comma (,). Note that only pure Python modules will work currently. Extension modules written in C or other languages are not supported.\n\n- \n\n`--extra-jars` — Amazon S3 path(s) to additional Java `.jar` file(s) that AWS Glue adds to the Java classpath before executing your script. Multiple values must be complete paths separated by a comma (,).\n\n- \n\n`--extra-files` — Amazon S3 path(s) to additional files such as configuration files) that AWS Glue copies to the working directory of your script before executing it. Multiple values must be complete paths separated by a comma (,).\n\nThere are several argument names used by AWS Glue internally that you should never set:\n\n- \n\n`--conf` — Internal to AWS Glue. Do not set!\n\n- \n\n`--debug` — Internal to AWS Glue. Do not set!\n\n- \n\n`--mode` — Internal to AWS Glue. Do not set!\n\n- \n\n`--JOB_NAME` — Internal to AWS Glue. Do not set!\n\n_Required_: No\n\n_Type_: JSON object\n\n_Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n\n" required: 'no' type: JSON update_requires: no_interruption Connections: description: |+ The connections that are used by the job. _Required_: No _Type_: [AWS Glue Job ConnectionsList](aws-properties-glue-job-connectionslist.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS Glue Job ConnectionsList update_requires: no_interruption MaxRetries: description: |+ The maximum number of times to retry this job if it fails. _Required_: No _Type_: Double _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Double update_requires: no_interruption Description: description: |+ The description of the job. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption LogUri: description: |+ The location of the logs for the job. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Command: description: |+ The code that executes a job. _Required_: Yes _Type_: [AWS Glue Job JobCommand](aws-properties-glue-job-jobcommand.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: AWS Glue Job JobCommand update_requires: no_interruption AllocatedCapacity: description: |+ The number of capacity units that are allocated to this job. _Required_: No _Type_: Double _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Double update_requires: no_interruption ExecutionProperty: description: |+ The execution property of the job, which specifies the maximum number of concurrent runs that are allowed for the job. _Required_: No _Type_: [AWS Glue Job ExecutionProperty](aws-properties-glue-job-executionproperty.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS Glue Job ExecutionProperty update_requires: no_interruption Name: description: |+ The name of the job. It must match the single-line string pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*` _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Glue::Partition: description: The `AWS::Glue::Partition` resource creates an AWS Glue partition, which represents a slice of table data. For more information, see [CreatePartition Action](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-partitions.html#aws-glue-api-catalog-partitions-CreatePartition) and [Partition Structure](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-partitions.html#aws-glue-api-catalog-partitions-Partition) in the _AWS Glue Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html properties: TableName: description: |+ The name of the metadata table to create the partition in. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement DatabaseName: description: |+ The name of the catalog database to create the partition in. It must match the single-line string pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*` _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement CatalogId: description: |+ The ID of the data catalog to create the catalog object in. Currently, this should be the AWS account ID. Note To specify the account ID, you can use the `Ref` intrinsic function with the `AWS::AccountId` pseudo parameter—for example `!Ref AWS::AccountId`. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption PartitionInput: description: |+ The metadata of the partition. _Required_: Yes _Type_: [AWS Glue Partition PartitionInput](aws-properties-glue-partition-partitioninput.html) _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'yes' type: AWS Glue Partition PartitionInput update_requires: some_interruptions return_values: Ref: description: '' examples: {} AWS::Glue::Table: description: The `AWS::Glue::Table` resource specifies tabular data in the AWS Glue data catalog. For more information, see [Defining Tables in the AWS Glue Data Catalog](http://docs.aws.amazon.com/glue/latest/dg/tables-described.html) and [Table Structure](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-tables.html#aws-glue-api-catalog-tables-Table) in the _AWS Glue Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html properties: TableInput: description: |+ The metadata of the table. _Required_: Yes _Type_: [AWS Glue Table TableInput](aws-properties-glue-table-tableinput.html) _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'yes' type: AWS Glue Table TableInput update_requires: some_interruptions DatabaseName: description: |+ The name of the catalog database for the table. It must match the single-line string pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*` _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement CatalogId: description: |+ The ID of the data catalog to create the catalog object in. Currently, this should be the AWS account ID. Note To specify the account ID, you can use the `Ref` intrinsic function with the `AWS::AccountId` pseudo parameter—for example `!Ref AWS::AccountId`. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the `TableInput` name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Glue::Trigger: description: The `AWS::Glue::Trigger` resource specifies triggers that run AWS Glue jobs. For more information, see [Triggering Jobs in AWS Glue](http://docs.aws.amazon.com/glue/latest/dg/trigger-job.html) and [Trigger Structure](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-trigger.html#aws-glue-api-jobs-trigger-Trigger) in the _AWS Glue Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html properties: Type: description: |+ The type of job trigger. Valid values are `SCHEDULED`, `CONDITIONAL`, or `ON_DEMAND`. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Description: description: |+ The description of the job trigger. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Actions: description: |+ The actions that the job trigger initiates when it fires. _Required_: Yes _Type_: List of [AWS Glue Trigger Action](aws-properties-glue-trigger-action.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: List update_requires: no_interruption Schedule: description: |+ The `cron` schedule expression for the job trigger. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Name: description: |+ The name of the job trigger. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Predicate: description: |+ The predicate of the job trigger, which determines when the trigger fires. _Required_: No _Type_: [AWS Glue Trigger Predicate](aws-properties-glue-trigger-predicate.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS Glue Trigger Predicate update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::GuardDuty::Detector: description: The `AWS::GuardDuty::Detector` resource creates a single Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. You must create a detector for GuardDuty to become operational. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html properties: Enable: description: |+ A Boolean value that specifies whether the detector is to be enabled. _Required_: Yes _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Boolean update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::GuardDuty::Detector` resource to the intrinsic `Ref` function, the function returns the unique ID of the created detector. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::GuardDuty::IPSet: description: The `AWS::GuardDuty::IPSet` resource creates an Amazon GuardDuty IP set. An IP set is a list of trusted IP addresses that have been whitelisted for secure communication with your AWS environment. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html properties: Activate: description: |+ A Boolean value that indicates whether GuardDuty is to start using the uploaded IP set. _Required_: Yes _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Boolean update_requires: no_interruption DetectorId: description: |+ The detector ID that specifies the GuardDuty service for which an IP set is to be created. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Format: description: |+ The format of the file that contains the IP set. Valid values are TXT, STIX, and OTX\_CSV. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Location: description: |+ The URI of the file that contains the IP set. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Name: description: |+ The friendly name to identify the IP set. This name is displayed in all findings that are triggered by activity that involves IP addresses included in this IP set. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::GuardDuty::IPSet` resource to the intrinsic `Ref` function, the function returns the unique ID of the created IP set. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::GuardDuty::ThreatIntelSet: description: The `AWS::GuardDuty::ThreatIntelSet` resource creates a ThreatIntelSet. A ThreatIntelSet consists of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html properties: Activate: description: |+ A Boolean value that indicates whether GuardDuty should start using the uploaded ThreatIntelSet. _Required_: Yes _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Boolean update_requires: no_interruption DetectorId: description: |+ The detector ID that specifies the GuardDuty service for which an ThreatIntelSet is to be created. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Format: description: |+ The format of the file that contains the ThreatIntelSet. Valid values are TXT, STIX, OTX\_CSV, ALIEN\_VAULT, PROOF\_POINT, and FIRE\_EYE. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Location: description: |+ The URI of the file that contains the ThreatIntelSet. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Name: description: |+ A friendly ThreatIntelSet name that is displayed in all findings generated by activity that involves IP addresses included in this ThreatIntelSet. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::GuardDuty::ThreatIntelSet` resource to the intrinsic `Ref` function, the function returns the unique ID of the created threatIntelSet. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::IAM::AccessKey: description: |- The AWS::IAM::AccessKey resource type generates a secret access key and assigns it to an IAM user or AWS account. This type supports updates. For more information about updating stacks, see [AWS CloudFormation Stacks Updates](using-cfn-updating-stacks.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html properties: Serial: description: |+ This value is specific to AWS CloudFormation and can only be _incremented_. Incrementing this value notifies AWS CloudFormation that you want to rotate your access key. When you update your stack, AWS CloudFormation will replace the existing access key with a new key. _Required_: No _Type_: Integer _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Number update_requires: replacement Status: description: |+ The status of the access key. By default, AWS CloudFormation sets this property value to `Active`. _Required_: No _Type_: String _Valid values:_`Active` or `Inactive` _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption UserName: description: |+ The name of the user that the new key will belong to. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- Specifying this resource ID to the intrinsic `Ref` function will return the `AccessKeyId`. For example: `AKIAIOSFODNN7EXAMPLE`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). SecretAccessKey: description: |+ Returns the secret access key for the specified `AWS::IAM::AccessKey` resource. For example: `wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY`. examples: {} AWS::IAM::Group: description: |- The `AWS::IAM::Group` resource creates an AWS Identity and Access Management (IAM) group. This type supports updates. For more information about updating stacks, see [AWS CloudFormation Stacks Updates](using-cfn-updating-stacks.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html properties: GroupName: description: |+ A name for the IAM group. For valid values, see the `GroupName` parameter for the [`CreateGroup`](http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateGroup.html) action in the _IAM API Reference_. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the group name. Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. If you specify a name, you must specify the `CAPABILITY_NAMED_IAM` value to acknowledge your template's capabilities. For more information, see [Acknowledging IAM Resources in AWS CloudFormation Templates](using-iam-template.html#using-iam-capabilities). Warning Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple regions. To prevent this, we recommend using `Fn::Join` and `AWS::Region` to create a region-specific name, as in the following example: `{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}`. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement ManagedPolicyArns: description: |+ One or more managed policy ARNs to attach to this group. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Path: description: |+ The path to the group. For more information about paths, see [IAM Identifiers](http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html) in the _IAM User Guide_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Policies: description: |+ The policies to associate with this group. For information about policies, see [Overview of IAM Policies](http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?PoliciesOverview.html) in the _IAM User Guide_. _Required:_ No _Type_: List of [IAM Policies](aws-properties-iam-policy.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- Specifying this resource ID to the intrinsic `Ref` function will return the `GroupName`. For example: `mystack-mygroup-1DZETITOWEKVO`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ Returns the Amazon Resource Name (ARN) for the `AWS::IAM::Group` resource. For example: `arn:aws:iam::123456789012:group/mystack-mygroup-1DZETITOWEKVO`. examples: {} AWS::IAM::InstanceProfile: description: |- The `AWS::IAM::InstanceProfile` resource creates an AWS Identity and Access Management (IAM) instance profile that can be used with IAM roles for EC2 instances. For more information about IAM roles, see [Working with Roles](http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html) in the _AWS Identity and Access Management User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html properties: Path: description: |+ The path associated with this IAM instance profile. For information about IAM paths, see [Friendly Names and Paths](http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html#Identifiers_FriendlyNames) in the _AWS Identity and Access Management User Guide_. By default, AWS CloudFormation specifies `/` for the path. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Roles: description: |+ The name of an existing IAM role to associate with this instance profile. Currently, you can assign a maximum of one role to an instance profile. _Required:_ Yes _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: List update_requires: no_interruption InstanceProfileName: description: |+ The name of the instance profile that you want to create. This parameter allows (per its [regex pattern](http://wikipedia.org/wiki/regex)) a string consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: `= , . @ -`. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For example: Copy{ "Ref": "MyProfile" } For the `IAM::InstanceProfile` with the logical ID `MyProfile`, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ Returns the Amazon Resource Name (ARN) for the instance profile. For example: Copy{"Fn::GetAtt" : ["MyProfile", "Arn"] } This returns a value such as `“arn:aws:iam::1234567890:instance-profile/MyProfile-ASDNSDLKJ”`. examples: {} AWS::IAM::ManagedPolicy: description: "`AWS::IAM::ManagedPolicy` creates an AWS Identity and Access Management (IAM) managed policy for your AWS account, which you can use to apply permissions to IAM users, groups, and roles. For more information about managed policies, see [Managed Policies and Inline Policies](http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_managed-vs-inline.html) in the _IAM User Guide_ guide." url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html properties: Description: description: |+ A description of the IAM policy. For example, describe the permissions that are defined in the policy. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Groups: description: |+ The names of IAM groups to attach to this policy. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Path: description: |+ The path for the IAM policy. By default, the path is `/`. For more information, see [IAM Identifiers](http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the _IAM User Guide_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement PolicyDocument: description: |+ Policies that define the permissions for this managed policy. For more information about policy syntax, see [IAM Policy Elements Reference](http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in _IAM User Guide_. _Required:_ Yes _Type_: JSON object Note AWS Identity and Access Management (IAM) requires that policies be in JSON format. However, for templates formatted in YAML, you can create an IAM policy in either JSON or YAML format. AWS CloudFormation always converts a policy to JSON format before submitting it to IAM. _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: JSON update_requires: no_interruption Roles: description: |+ The names of IAM roles to attach to this policy. Note If a policy has a `Ref` to a role and if a resource (such as `AWS::ECS::Service`) also has a `Ref` to the same role, add a `DependsOn` attribute to the resource so that the resource depends on the policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an `AWS::ECS::Service` resource, the `DependsOn` attribute ensures that the `AWS::ECS::Service` resource can complete its deletion before its role's policy is deleted. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Users: description: |+ The names of users to attach to this policy. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption ManagedPolicyName: description: |+ A custom, friendly name for your IAM managed policy. For valid values, see the [PolicyName](http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html) parameter of the `CreatePolicy` action in the _IAM API Reference_. If you don't specify a `PolicyName`, AWS CloudFormation generates a unique physical ID and uses that ID for the policy name. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the ARN. In the following sample, the `Ref` function returns the ARN of the `CreateTestDBPolicy` managed policy, such as `arn:aws:iam::123456789012:policy/teststack-CreateTestDBPolicy-16M23YE3CS700`. Copy{ "Ref": "CreateTestDBPolicy" } For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::IAM::Policy: description: The `AWS::IAM::Policy` resource associates an IAM policy with IAM users, roles, or groups. For more information about IAM policies, see [Overview of IAM Policies](http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html) in the _IAM User Guide_ guide. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html properties: Groups: description: |+ The names of groups to which you want to add the policy. _Required:_ Conditional. You must specify at least one of the following properties: `Groups`, `Roles`, or `Users`. _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: List update_requires: no_interruption PolicyDocument: description: |+ A policy document that contains permissions to add to the specified users or groups. _Required:_ Yes _Type_: JSON object Note AWS Identity and Access Management (IAM) requires that policies be in JSON format. However, for templates formatted in YAML, you can create an IAM policy in either JSON or YAML format. AWS CloudFormation always converts a policy to JSON format before submitting it to IAM. _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: JSON update_requires: no_interruption PolicyName: description: |+ The name of the policy. If you specify multiple policies for an entity, specify unique names. For example, if you specify a list of policies for an IAM role, each policy must have a unique name. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Roles: description: |+ The names of [AWS::IAM::Role](aws-resource-iam-role.html)s to which this policy will be attached. Note If a policy has a `Ref` to a role and if a resource (such as `AWS::ECS::Service`) also has a `Ref` to the same role, add a `DependsOn` attribute to the resource so that the resource depends on the policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an `AWS::ECS::Service` resource, the `DependsOn` attribute ensures that the `AWS::ECS::Service` resource can complete its deletion before its role's policy is deleted. _Required:_ Conditional. You must specify at least one of the following properties: `Groups`, `Roles`, or `Users`. _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: List update_requires: no_interruption Users: description: |+ The names of users for whom you want to add the policy. _Required:_ Conditional. You must specify at least one of the following properties: `Groups`, `Roles`, or `Users`. _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::IAM::Role: description: |- Creates an AWS Identity and Access Management (IAM) role. Use an IAM role to enable applications running on an EC2 instance to securely access your AWS resources. For more information about IAM roles, see [Working with Roles](http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html) in the _AWS Identity and Access Management User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html properties: AssumeRolePolicyDocument: description: |+ The trust policy that is associated with this role. You can associate only one assume role policy with a role. For an example of an assume role policy, see [Template Examples](aws-resource-iam-role.html#cfn-iam-role-templateexamples). For more information about the elements that you can use in an IAM policy, see [IAM Policy Elements Reference](http://docs.aws.amazon.com//IAM/latest/UserGuide/reference_policies_elements.html) in the _IAM User Guide_. _Required:_ Yes _Type_: A JSON policy document Note AWS Identity and Access Management (IAM) requires that policies be in JSON format. However, for templates formatted in YAML, you can create an IAM policy in either JSON or YAML format. AWS CloudFormation always converts a policy to JSON format before submitting it to IAM. _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: A JSON policy document update_requires: no_interruption ManagedPolicyArns: description: |+ One or more managed policy ARNs to attach to this role. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Path: description: |+ The path associated with this role. For information about IAM paths, see [Friendly Names and Paths](http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html#Identifiers_FriendlyNames) in _IAM User Guide_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Policies: description: |+ The policies to associate with this role. For sample templates, see [Template Examples](aws-resource-iam-role.html#cfn-iam-role-templateexamples). Important The name of each policy for a role, user, or group must be unique. If you don't, updates to the IAM role will fail. Note If an external policy (such as `AWS::IAM::Policy` or `AWS::IAM::ManagedPolicy`) has a `Ref` to a role and if a resource (such as `AWS::ECS::Service`) also has a `Ref` to the same role, add a `DependsOn` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an `AWS::ECS::Service` resource, the `DependsOn` attribute ensures that AWS CloudFormation deletes the `AWS::ECS::Service` resource before deleting its role's policy. _Required:_ No _Type_: List of [IAM Policies](aws-properties-iam-policy.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption RoleName: description: |+ A name for the IAM role. For valid values, see the `RoleName` parameter for the [`CreateRole`](http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the _IAM API Reference_. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the group name. Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. If you specify a name, you must specify the `CAPABILITY_NAMED_IAM` value to acknowledge your template's capabilities. For more information, see [Acknowledging IAM Resources in AWS CloudFormation Templates](using-iam-template.html#using-iam-capabilities). Warning Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple regions. To prevent this, we recommend using `Fn::Join` and `AWS::Region` to create a region-specific name, as in the following example: `{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}`. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For example: Copy{ "Ref": "RootRole" } For the IAM::Role with the logical ID "RootRole", `Ref` will return the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ Returns the Amazon Resource Name (ARN) for the instance profile. For example: Copy{"Fn::GetAtt" : ["MyRole", "Arn"] } This will return a value such as `“arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF”`. examples: {} AWS::IAM::User: description: The `AWS::IAM::User` type creates a user. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html properties: Groups: description: |+ A name of a group to which you want to add the user. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption LoginProfile: description: |+ Creates a login profile so that the user can access the AWS Management Console. _Required:_ No _Type_: [IAM User LoginProfile](aws-properties-iam-user-loginprofile.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: IAM User LoginProfile update_requires: no_interruption ManagedPolicyArns: description: |+ One or more managed policy ARNs to attach to this user. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Path: description: |+ The path for the user name. For more information about paths, see [IAM Identifiers](http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html) in the _IAM User Guide_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Policies: description: |+ The policies to associate with this user. For information about policies, see [Overview of IAM Policies](http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?PoliciesOverview.html) in the _IAM User Guide_. Note If you specify multiple polices, specify unique values for the policy name. If you don't, updates to the IAM user will fail. _Required:_ No _Type_: List of [IAM Policies](aws-properties-iam-policy.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption UserName: description: |+ A name for the IAM user. For valid values, see the `UserName` parameter for the [`CreateUser`](http://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateUser.html) action in the _IAM API Reference_. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the user name. Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. If you specify a name, you must specify the `CAPABILITY_NAMED_IAM` value to acknowledge your template's capabilities. For more information, see [Acknowledging IAM Resources in AWS CloudFormation Templates](using-iam-template.html#using-iam-capabilities). Warning Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple regions. To prevent this, we recommend using `Fn::Join` and `AWS::Region` to create a region-specific name, as in the following example: `{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}`. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- Specifying this resource ID to the intrinsic Ref function will return the `UserName`. For example: `mystack-myuser-1CCXAFG2H2U4D`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ Returns the Amazon Resource Name (ARN) for the specified AWS::IAM::User resource. For example: `arn:aws:iam::123456789012:user/mystack-myuser-1CCXAFG2H2U4D`. examples: {} AWS::Inspector::AssessmentTarget: description: The `AWS::Inspector::AssessmentTarget` resource creates an Amazon Inspector assessment target - a resource that contains information about an Amazon Inspector application. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttarget.html properties: AssessmentTargetName: description: |+ The name of the Amazon Inspector assessment target. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement ResourceGroupArn: description: |+ The ARN that specifies the resource group that is associated with the assessment target. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption return_values: Ref: description: '' Arn: description: |+ The Amazon Resource Name (ARN) that specifies the assessment target that is created. examples: {} AWS::Inspector::AssessmentTemplate: description: The `AWS::Inspector::AssessmentTemplate` resource creates an Amazon Inspector assessment template - a resource that contains information about an Amazon Inspector assessment template. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html properties: AssessmentTargetArn: description: |+ The ARN of the assessment target that corresponds to this assessment template. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement DurationInSeconds: description: |+ The duration in seconds specified for this assessment tempate. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day). _Required_: Yes _Type_: Integer _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: Number update_requires: replacement AssessmentTemplateName: description: |+ The name of the assessment template. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement RulesPackageArns: description: |+ The rules packages that are specified for this assessment template. _Required_: Yes _Type_: List of String values _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: List update_requires: replacement UserAttributesForFindings: description: |+ The user-defined attributes that are assigned to every generated finding from the assessment run that uses this assessment template. _Required_: No _Type_: List of [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement return_values: Ref: description: '' Arn: description: |+ The Amazon Resource Name (ARN) that specifies the assessment template that is created. examples: {} AWS::Inspector::ResourceGroup: description: The `AWS::Inspector::ResourceGroup` resource is used to create Amazon Inspector resource groups. A resource group defines a set of tags that, when queried, identify the AWS resources that make up the assessment target. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-resourcegroup.html properties: ResourceGroupTags: description: |+ The tags (key and value pairs) of the resource group. _Required_: Yes _Type_: List of [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: List update_requires: replacement return_values: Ref: description: '' Arn: description: |+ The Amazon Resource Name (ARN) that specifies the resource group that is created. examples: {} AWS::IAM::UserToGroupAddition: description: |- The `AWS::IAM::UserToGroupAddition` type adds AWS Identity and Access Management (IAM) users to a group. This type supports updates. For more information about updating stacks, see [AWS CloudFormation Stacks Updates](using-cfn-updating-stacks.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html properties: GroupName: description: |+ The name of group to add users to. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Users: description: |+ _Required_: Yes _Type_: List of users _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: List update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::IoT::Certificate: description: |- Use the `AWS::IoT::Certificate` resource to declare an X.509 certificate. For information about working with X.509 certificates, see [Authentication in AWS IoT](http://docs.aws.amazon.com/iot/latest/developerguide/identity-in-iot.html) in the _AWS IoT Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-certificate.html properties: CertificateSigningRequest: description: |+ The certificate signing request (CSR). _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Status: description: |+ The status of the certificate. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption return_values: Ref: description: |- When you provide the logical ID of this resource to the `Ref` intrinsic function, `Ref` returns the certificate ID. For example: Copy{ "Ref": "MyCertificate" } A value similar to the following is returned: Copya1234567b89c012d3e4fg567hij8k9l01mno1p23q45678901rs234567890t1u2 For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ Returns the Amazon Resource Name (ARN) for the instance profile. For example: Copy{ "Fn::GetAtt": ["MyCertificate", "Arn"] } A value similar to the following is returned: Copyarn:aws:iot:ap-southeast-2:123456789012:cert/a1234567b89c012d3e4fg567hij8k9l01mno1p23q45678901rs234567890t1u2 examples: {} AWS::IoT::Policy: description: |- Use the `AWS::IoT::Policy` resource to declare an AWS IoT policy. For information about working with AWS IoT policies, see [Authorization](http://docs.aws.amazon.com/iot/latest/developerguide/authorization.html) in the _AWS IoT Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policy.html properties: PolicyDocument: description: |+ The JSON document that describes the policy. _Required:_ Yes _Type_: JSON object _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: JSON update_requires: replacement PolicyName: description: |+ The name (the physical ID) of the AWS IoT policy. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When you provide the logical ID of this resource to the `Ref` intrinsic function, `Ref` returns the policy name. For example: Copy{ "Ref": "MyPolicy" } For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ The Amazon Resource Name (ARN) of the AWS IoT policy, such as `arn:aws:iot:us-east-2:123456789012:policy/MyPolicy`. examples: {} AWS::IoT::PolicyPrincipalAttachment: description: |- Use the `AWS::IoT::PolicyPrincipalAttachment` resource to attach an AWS IoT policy to a principal (an X.509 certificate or other credential). For information about working with AWS IoT policies and principals, see [Authorization](http://docs.aws.amazon.com/iot/latest/developerguide/authorization.html) in the _AWS IoT Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policyprincipalattachment.html properties: PolicyName: description: |+ The name of the policy. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Principal: description: |+ The principal, which can be a certificate ARN (as returned from the `CreateCertificate` operation) or an Amazon Cognito ID. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: '' examples: {} AWS::IoT::Thing: description: |- Use the `AWS::IoT::Thing` resource to declare an AWS IoT thing. For information about working with things, see [How AWS IoT Works](http://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html) and [Device Registry for AWS IoT](http://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html) in the _AWS IoT Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html properties: AttributePayload: description: |+ The attribute payload. _Required:_ No _Type_: [AWS IoT Thing AttributePayload](aws-properties-iot-thing-attributepayload.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS IoT Thing AttributePayload update_requires: no_interruption ThingName: description: |+ The name (the physical ID) of the AWS IoT thing. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When you provide the logical ID of this resource to the `Ref` intrinsic function, `Ref` returns the thing name. For example: Copy{ "Ref": "MyThing" } For a stack named `MyStack`, a value similar to the following is returned: CopyMyStack-MyThing-AB1CDEFGHIJK For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::IoT::ThingPrincipalAttachment: description: |- Use the `AWS::IoT::ThingPrincipalAttachment` resource to attach a principal (an X.509 certificate or another credential) to a thing. For information about working with AWS IoT things and principals, see [Authorization](http://docs.aws.amazon.com/iot/latest/developerguide/authorization.html) in the _AWS IoT Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thingprincipalattachment.html properties: Principal: description: |+ The principal, which can be a certificate ARN (as returned from the `CreateCertificate` operation) or an Amazon Cognito ID. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement ThingName: description: |+ The name of the AWS IoT thing. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: '' examples: {} AWS::IoT::TopicRule: description: |- Use the `AWS::IoT::TopicRule` resource to declare an AWS IoT rule. For information about working with AWS IoT rules, see [Rules for AWS IoT](http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html) in the _AWS IoT Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html properties: RuleName: description: |+ The name (the physical ID) of the AWS IoT rule. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement TopicRulePayload: description: |+ The actions associated with the AWS IoT rule. _Required:_ Yes _Type_: [`TopicRulePayload`](aws-properties-iot-topicrule-topicrulepayload.html) object _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: TopicRulePayload object update_requires: no_interruption return_values: Ref: description: |- When you provide the logical ID of this resource to the `Ref` intrinsic function, `Ref` returns the topic rule name. For example: Copy{ "Ref": "MyTopicRule" } For a stack named `My-Stack` (the `–` character is omitted), a value similar to the following is returned: CopyMyStackMyTopicRule12ABC3D456EFG For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ The Amazon Resource Name (ARN) of the AWS IoT rule, such as `arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule`. examples: {} AWS::Kinesis::Stream: description: Creates an Kinesis stream that captures and transports data records that are emitted from data sources. For information about creating streams, see [CreateStream](http://docs.aws.amazon.com/kinesis/latest/APIReference/API_CreateStream.html) in the _Amazon Kinesis API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html properties: Name: description: |+ The name of the Kinesis stream. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the stream name. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement RetentionPeriodHours: description: |+ The number of hours for the data records that are stored in shards to remain accessible. The default value is 24. For more information about the stream retention period, see [Changing the Data Retention Period](http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-extended-retention.html) in the _Amazon Kinesis Developer Guide_. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption ShardCount: description: |+ The number of shards that the stream uses. For greater provisioned throughput, increase the number of shards. _Required:_ Yes _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Number update_requires: no_interruption Tags: description: |+ An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream. For information about constraints for this property, see [Tag Restrictions](http://docs.aws.amazon.com/kinesis/latest/dev/tagging.html#tagging-restrictions) in the _Amazon Kinesis Developer Guide_. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption return_values: Ref: description: |- When you specify an AWS::Kinesis::Stream resource as an argument to the `Ref` function, AWS CloudFormation returns the stream name (physical ID). For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ The Amazon resource name (ARN) of the Kinesis stream, such as `arn:aws:kinesis:``us-east-2``:123456789012:stream/mystream`. examples: {} AWS::KinesisAnalytics::Application: description: The `AWS::KinesisAnalytics::Application` resource creates an Amazon Kinesis Analytics application. For more information, see the [_Amazon Kinesis Analytics Developer Guide_](http://docs.aws.amazon.com/kinesisanalytics/latest/dev/). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html properties: ApplicationName: description: |+ The name of your Amazon Kinesis Analytics application. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement ApplicationDescription: description: |+ The summary description of the application. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption ApplicationCode: description: |+ One or more SQL statements that read input data, transform it, and generate output. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Inputs: description: |+ Use this parameter to configure the application input. _Required_: Yes _Type_: List of [Kinesis Analytics Application Input](aws-properties-kinesisanalytics-application-input.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: List update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::KinesisAnalytics::ApplicationOutput: description: The `AWS::KinesisAnalytics::ApplicationOutput` resource adds an external destination to your Amazon Kinesis Analytics application. For more information, see [AddApplicationOutput](http://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationOutput.html) in the _Amazon Kinesis Analytics Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationoutput.html properties: ApplicationName: description: |+ The name of the application to which you want to add the output configuration. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Output: description: |+ An array of objects, each describing one output configuration. _Required_: Yes _Type_: [Kinesis Analytics ApplicationOutput Output](aws-properties-kinesisanalytics-applicationoutput-output.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: |- Kinesis Analytics ApplicationOutput Output update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::KinesisAnalytics::ApplicationReferenceDataSource: description: Use the AWS CloudFormation `AWS::KinesisAnalytics::ApplicationReferenceDataSource` resource to add a reference data source to an existing Amazon Kinesis Analytics application. For more information, see `AddApplicationReferenceDataSource` in the _Amazon Kinesis Analytics Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationreferencedatasource.html properties: ApplicationName: description: |+ The name of an existing application. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement ReferenceDataSource: description: |+ The reference data source, which is an object in your Amazon Simple Storage Service (Amazon S3) bucket. _Required_: Yes _Type_: [Kinesis Analytics ApplicationReferenceDataSource ReferenceDataSource](aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Kinesis Analytics ApplicationReferenceDataSource ReferenceDataSource update_requires: no_interruption return_values: Ref: description: |- The following example creates an `ApplicationReferenceDataSource` resource: #### YAML CopyApplicationReferenceDataSource: Type: "AWS::KinesisAnalytics::ApplicationReferenceDataSource" Properties: ApplicationName: !Ref BasicApplication ReferenceDataSource: TableName: "exampleTable" ReferenceSchema: RecordColumns: - Name: "example" SqlType: "VARCHAR(16)" Mapping: "$.example" RecordFormat: RecordFormatType: "JSON" MappingParameters: JSONMappingParameters: RecordRowPath: "$" S3ReferenceDataSource: BucketARN: !GetAtt S3Bucket.Arn FileKey: 'fakeKey' ReferenceRoleARN: !GetAtt KinesisAnalyticsRole.Arn examples: {} AWS::KinesisFirehose::DeliveryStream: description: The `AWS::KinesisFirehose::DeliveryStream` resource creates an Amazon Kinesis Firehose (Kinesis Firehose) delivery stream that delivers real-time streaming data to an Amazon Simple Storage Service (Amazon S3), Amazon Redshift, or Amazon Elasticsearch Service (Amazon ES) destination. For more information, see [Creating an Amazon Kinesis Firehose Delivery Stream](http://docs.aws.amazon.com/firehose/latest/dev/basic-create.html) in the _Amazon Kinesis Firehose Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html properties: DeliveryStreamName: description: |+ A name for the delivery stream. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement DeliveryStreamType: description: "The delivery stream type. This property can be one of the following values:\n\n- \n\n`DirectPut`: Provider applications access the delivery stream directly.\n\n- \n\n`KinesisStreamAsSource`: The delivery stream uses a Kinesis stream as a source.\n\n_Required:_ No\n\n_Type_: String\n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n\n" required: 'no' type: String update_requires: replacement ElasticsearchDestinationConfiguration: description: |+ An Amazon ES destination for the delivery stream. _Required:_ Conditional. You must specify only one destination configuration. _Type_: [Kinesis Firehose DeliveryStream ElasticsearchDestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). If you change the delivery stream destination from an Amazon ES destination to an Amazon S3 or Amazon Redshift destination, update requires [some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). required: conditional type: Kinesis Firehose DeliveryStream ElasticsearchDestinationConfiguration update_requires: some_interruptions ExtendedS3DestinationConfiguration: description: |+ An Amazon S3 destination for the delivery stream. _Required:_ Conditional. You must specify only one destination configuration. _Type_: [Kinesis Firehose DeliveryStream ExtendedS3DestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). If you change the delivery stream destination from an Amazon Redshift destination to an Amazon ES destination, update requires [some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). required: conditional type: Kinesis Firehose DeliveryStream ExtendedS3DestinationConfiguration update_requires: some_interruptions KinesisStreamSourceConfiguration: description: |+ When a Kinesis stream is used as the source for the delivery stream, a [Kinesis Firehose DeliveryStream KinesisStreamSourceConfiguration](aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html) containing the Kinesis stream ARN and the role ARN for the source stream. _Required:_ No _Type_: [Kinesis Firehose DeliveryStream KinesisStreamSourceConfiguration](aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Kinesis Firehose DeliveryStream KinesisStreamSourceConfiguration update_requires: no_interruption RedshiftDestinationConfiguration: description: |+ An Amazon Redshift destination for the delivery stream. _Required:_ Conditional. You must specify only one destination configuration. _Type_: [Kinesis Firehose DeliveryStream RedshiftDestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). If you change the delivery stream destination from an Amazon Redshift destination to an Amazon ES destination, update requires [some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). required: conditional type: Kinesis Firehose DeliveryStream RedshiftDestinationConfiguration update_requires: some_interruptions S3DestinationConfiguration: description: |+ An Amazon S3 destination for the delivery stream. _Required:_ Conditional. You must specify only one destination configuration. _Type_: [Kinesis Firehose DeliveryStream S3DestinationConfiguration](aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). If you change the delivery stream destination from an Amazon S3 destination to an Amazon ES destination, update requires [some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). required: conditional type: Kinesis Firehose DeliveryStream S3DestinationConfiguration update_requires: some_interruptions return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the delivery stream name, such as `mystack-deliverystream-1ABCD2EF3GHIJ`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ The Amazon Resource Name (ARN) of the delivery stream, such as `arn:aws:firehose:``us-east-2``:123456789012:deliverystream/delivery-stream-name`. examples: {} AWS::KMS::Alias: description: The `AWS::KMS::Alias` resource creates a display name for a customer master key (CMK) in AWS Key Management Service (AWS KMS). Using an alias to refer to a key can help you simplify key management. For example, when rotating keys, you can just update the alias mapping instead of tracking and changing key IDs. For more information, see [Working with Aliases](http://docs.aws.amazon.com/kms/latest/developerguide/programming-aliases.html) in the _AWS Key Management Service Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html properties: AliasName: description: |+ The name of the alias. The name must start with `alias` followed by a forward slash, such as `alias/`. You can't specify aliases that begin with `alias/AWS`. These aliases are reserved. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement TargetKeyId: description: |+ The ID of the key for which you are creating the alias. Specify the key's globally unique identifier or Amazon Resource Name (ARN). You can't specify another alias. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the alias name, such as `alias/myKeyAlias`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::KMS::Key: description: The `AWS::KMS::Key` resource creates a customer master key (CMK) in AWS Key Management Service (AWS KMS). Users (customers) can use the master key to encrypt their data stored in AWS services that are integrated with AWS KMS or within their applications. For more information, see [What is the AWS Key Management Service?](http://docs.aws.amazon.com/kms/latest/developerguide/) in the _AWS Key Management Service Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html properties: Description: description: |+ A description of the key. Use a description that helps your users decide whether the key is appropriate for a particular task. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Enabled: description: |+ Indicates whether the key is available for use. AWS CloudFormation sets this value to `true` by default. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption EnableKeyRotation: description: |+ Indicates whether AWS KMS rotates the key. AWS CloudFormation sets this value to `false` by default. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption KeyPolicy: description: |+ An AWS KMS key policy to attach to the key. Use a policy to specify who has permission to use the key and which actions they can perform. For more information, see [Key Policies](http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the _AWS Key Management Service Developer Guide_. _Required:_ Yes _Type_: JSON object _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: JSON update_requires: no_interruption Tags: description: |+ Specifies an arbitrary set of tags (key–value pairs) to associate with this key. Use tags to manage your resources. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption return_values: Ref: description: |- When you provide the logical ID of this resource to the `Ref` intrinsic function, it returns the key ID, such as `123ab456-a4c2-44cb-95fd-b781f32fbb37`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ The ARN of the AWS KMS key, such as `arn:aws:kms:us-west-2:123456789012:key/12a34567-8c90-1defg-af84-0bf06c1747f3`. examples: {} AWS::Lambda::EventSourceMapping: description: The `AWS::Lambda::EventSourceMapping` resource specifies a stream as an event source for an AWS Lambda (Lambda) function. The stream can be an Kinesis stream or an Amazon DynamoDB (DynamoDB) stream. Lambda invokes the associated function when records are posted to the stream. For more information, see [CreateEventSourceMapping](http://docs.aws.amazon.com/lambda/latest/dg/API_CreateEventSourceMapping.html) in the _AWS Lambda Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html properties: BatchSize: description: |+ The largest number of records that Lambda retrieves from your event source when invoking your function. Your function receives an event with all the retrieved records. For the default and valid values, see [CreateEventSourceMapping](http://docs.aws.amazon.com/lambda/latest/dg/API_CreateEventSourceMapping.html) in the _AWS Lambda Developer Guide_. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption Enabled: description: |+ Indicates whether Lambda begins polling the event source. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption EventSourceArn: description: |+ The Amazon Resource Name (ARN) of the Kinesis or DynamoDB stream that is the source of events. Any record added to this stream can invoke the Lambda function. For more information, see [CreateEventSourceMapping](http://docs.aws.amazon.com/lambda/latest/dg/API_CreateEventSourceMapping.html) in the _AWS Lambda Developer Guide_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement FunctionName: description: |+ The name or ARN of a Lambda function to invoke when Lambda detects an event on the stream. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption StartingPosition: description: |+ The position in the stream where Lambda starts reading. For valid values, see [CreateEventSourceMapping](http://docs.aws.amazon.com/lambda/latest/dg/API_CreateEventSourceMapping.html) in the _AWS Lambda Developer Guide_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Lambda::Alias: description: The `AWS::Lambda::Alias` resource creates an alias that points to the version of an AWS Lambda (Lambda) function that you specify. Use aliases when you want to control which version of your function other services or applications invoke. Those services or applications can use your function's alias so that they don't need to be updated whenever you release a new version of your function. For more information, see [Introduction to AWS Lambda Aliases](http://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html) in the _AWS Lambda Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html properties: Description: description: |+ Information about the alias, such as its purpose or the Lambda function that is associated with it. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption FunctionName: description: |+ The Lambda function that you want to associate with this alias. You can specify the function's name or its Amazon Resource Name (ARN). _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement FunctionVersion: description: |+ The version of the Lambda function that you want to associate with this alias. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Name: description: |+ A name for the alias. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement RoutingConfig: description: |+ Use this parameter to point your alias to two different function versions, allowing you to dictate what percentage of traffic will invoke each version. For more information, see [Routing Traffic to Different Function Versions Using Aliases](http://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) in the _AWS Lambda Developer Guide_. _Required_: No _Type_: [AWS Lambda Alias AliasRoutingConfiguration](aws-properties-lambda-alias-aliasroutingconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS Lambda Alias AliasRoutingConfiguration update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the ARN of the Lambda alias. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Lambda::Function: description: The `AWS::Lambda::Function` resource creates an AWS Lambda (Lambda) function that can run code in response to events. For more information, see `CreateFunction` in the _AWS Lambda Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html properties: Code: description: |+ The source code of your Lambda function. You can point to a file in an Amazon Simple Storage Service (Amazon S3) bucket or specify your source code as inline text. _Required:_ Yes _Type_: [AWS Lambda Function Code](aws-properties-lambda-function-code.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: AWS Lambda Function Code update_requires: no_interruption DeadLetterConfig: description: |+ Configures how Lambda handles events that it can't process. If you don't specify a Dead Letter Queue (DLQ) configuration, Lambda discards events after the maximum number of retries. For more information, see [Dead Letter Queues](http://docs.aws.amazon.com/lambda/latest/dg/dlq.html) in the _AWS Lambda Developer Guide_. _Required:_ No _Type_: [AWS Lambda Function DeadLetterConfig](aws-properties-lambda-function-deadletterconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- AWS Lambda Function DeadLetterConfig update_requires: no_interruption Description: description: |+ A description of the function. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Environment: description: |+ Key-value pairs that Lambda caches and makes available for your Lambda functions. Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Lambda function source code. _Required:_ No _Type_: [AWS Lambda Function Environment](aws-properties-lambda-function-environment.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- AWS Lambda Function Environment update_requires: no_interruption FunctionName: description: |+ A name for the function. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Handler: description: |+ The name of the function (within your source code) that Lambda calls to start running your code. For more information, see the `Handler` property in the _AWS Lambda Developer Guide_. Note If you specify your source code as inline text by specifying the `ZipFile` property within the `Code` property, specify `index.function_name` as the handler. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption KmsKeyArn: description: |+ The Amazon Resource Name (ARN) of an AWS Key Management Service (AWS KMS) key that Lambda uses to encrypt and decrypt environment variable values. _Type_: String _Required_: No _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption MemorySize: description: |+ The amount of memory, in MB, that is allocated to your Lambda function. Lambda uses this value to proportionally allocate the amount of CPU power. For more information, see [Resource Model](http://docs.aws.amazon.com/lambda/latest/dg/resource-model.html) in the _AWS Lambda Developer Guide_. Your function use case determines your CPU and memory requirements. For example, a database operation might need less memory than an image processing function. You must specify a value that is greater than or equal to `128`, and it must be a multiple of 64. You cannot specify a size larger than `1536`. The default value is 128 MB. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption Role: description: |+ The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) execution role that Lambda assumes when it runs your code to access AWS services. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Runtime: description: |+ The runtime environment for the Lambda function that you are uploading. For valid values, see the [Runtime](http://docs.aws.amazon.com/lambda/latest/dg/API_CreateFunction.html#SSS-CreateFunction-request-Runtime) property in the _AWS Lambda Developer Guide_. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) Note Because Node.js 0.10.32 has been deprecated, you can no longer roll back a template that uses Node.js 0.10.32. If you update a stack to Node.js 0.10.32 and the update fails, AWS CloudFormation won't roll it back. required: 'yes' type: String update_requires: no_interruption Timeout: description: |+ The function execution time (in seconds) after which Lambda terminates the function. Because the execution time affects cost, set this value based on the function's expected execution time. By default, `Timeout` is set to `3` seconds. For more information, see the [FAQs](https://aws.amazon.com//lambda/faqs/). _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption TracingConfig: description: |+ The parent object that contains your Lambda function's tracing settings. By default, the `Mode` property is set to `PassThrough`. For valid values, see the [TracingConfig](http://docs.aws.amazon.com/lambda/latest/dg/API_TracingConfig.html) data type in the _AWS Lambda Developer Guide_. _Required:_ No _Type_: [AWS Lambda Function TracingConfig](aws-properties-lambda-function-tracingconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS Lambda Function TracingConfig update_requires: no_interruption VpcConfig: description: |+ If the Lambda function requires access to resources in a VPC, specify a VPC configuration that Lambda uses to set up an elastic network interface (ENI). The ENI enables your function to connect to other resources in your VPC, but it doesn't provide public Internet access. If your function requires Internet access (for example, to access AWS services that don't have VPC endpoints), configure a Network Address Translation (NAT) instance inside your VPC or use an Amazon Virtual Private Cloud (Amazon VPC) NAT gateway. For more information, see [NAT Gateways](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-nat-gateway.html) in the _Amazon VPC User Guide_. Note When you specify this property, AWS CloudFormation might not be able to delete the stack if another resource in the template (such as a security group) requires the attached ENI to be deleted before it can be deleted. We recommend that you run AWS CloudFormation with the `ec2:DescribeNetworkInterfaces` permission, which enables AWS CloudFormation to monitor the state of the ENI and to wait (up to 40 minutes) for Lambda to delete the ENI. _Required:_ No _Type_: [AWS Lambda Function VpcConfig](aws-properties-lambda-function-vpcconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS Lambda Function VpcConfig update_requires: no_interruption Tags: description: |+ An arbitrary set of tags (key–value pairs) for this Lambda function. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. In the following sample, the `Ref` function returns the name of the `AMILookUp` function, such as `MyStack-AMILookUp-NT5EUXTNTXXD`. Copy{ "Ref": "AMILookUp" } For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ The ARN of the Lambda function, such as `arn:aws:lambda:us-west-2:123456789012:MyStack-AMILookUp-NT5EUXTNTXXD`. examples: {} AWS::Lambda::Permission: description: The `AWS::Lambda::Permission` resource associates a policy statement with a specific AWS Lambda (Lambda) function's access policy. The function policy grants a specific AWS service or application permission to invoke the function. For more information, see [AddPermission](http://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html) in the _AWS Lambda Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html properties: Action: description: |+ The Lambda actions that you want to allow in this statement. For example, you can specify `lambda:CreateFunction` to specify a certain action, or use a wildcard (`lambda:*`) to grant permission to all Lambda actions. For a list of actions, see [Actions and Condition Context Keys for AWS Lambda](http://docs.aws.amazon.com/IAM/latest/UserGuide/list_lambda.html) in the _IAM User Guide_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement EventSourceToken: description: |+ A unique token that must be supplied by the principal invoking the function. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement FunctionName: description: |+ The name (physical ID), Amazon Resource Name (ARN), or alias ARN of the Lambda function that you want to associate with this statement. Lambda adds this statement to the function's access policy. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Principal: description: |+ The entity for which you are granting permission to invoke the Lambda function. This entity can be any valid AWS service principal, such as `s3.amazonaws.com` or `sns.amazonaws.com`, or, if you are granting cross-account permission, an AWS account ID. For example, you might want to allow a custom application in another AWS account to push events to Lambda by invoking your function. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement SourceAccount: description: |+ The AWS account ID (without hyphens) of the source owner. For example, if you specify an S3 bucket in the `SourceArn` property, this value is the bucket owner's account ID. You can use this property to ensure that all source principals are owned by a specific account. Important This property is not supported by all event sources. For more information, see the `SourceAccount` parameter for the [AddPermission](http://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html) action in the _AWS Lambda Developer Guide_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement SourceArn: description: |+ The ARN of a resource that is invoking your function. When granting Amazon Simple Storage Service (Amazon S3) permission to invoke your function, specify this property with the bucket ARN as its value. This ensures that events generated only from the specified bucket, not just any bucket from any AWS account that creates a mapping to your function, can invoke the function. Important This property is not supported by all event sources. For more information, see the `SourceArn` parameter for the [AddPermission](http://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html) action in the _AWS Lambda Developer Guide_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: '' examples: {} AWS::Lambda::Version: description: The `AWS::Lambda::Version` resource publishes a specified version of an AWS Lambda (Lambda) function. When publishing a new version of your function, Lambda copies the latest version of your function. For more information, see [Introduction to AWS Lambda Versioning](http://docs.aws.amazon.com/lambda/latest/dg/versioning-intro.html) in the _AWS Lambda Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html properties: CodeSha256: description: |+ The SHA-256 hash of the deployment package that you want to publish. This value must match the SHA-256 hash of the `$LATEST` version of the function. Specify this property to validate that you are publishing the correct package. _Required:_ No _Type_: String _Update requires_: Updates are not supported. required: 'no' type: String update_requires: Description: description: |+ A description of the version you are publishing. If you don't specify a value, Lambda copies the description from the `$LATEST` version of the function. _Required:_ No _Type_: String _Update requires_: Updates are not supported. required: 'no' type: String update_requires: FunctionName: description: |+ The Lambda function for which you want to publish a version. You can specify the function's name or its Amazon Resource Name (ARN). _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the ARN of the Lambda version, such as `arn:aws:lambda:us-west-2:123456789012:function:helloworld:1`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Version: description: |+ The published version of a Lambda version, such as `1`. examples: {} AWS::Logs::Destination: description: The `AWS::Logs::Destination` resource creates an Amazon CloudWatch Logs (CloudWatch Logs) destination, which enables you to specify a physical resource (such as an Kinesis stream) that subscribes to CloudWatch Logs log events from another AWS account. For more information, see [Cross-Account Log Data Sharing with Subscriptions](http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CrossAccountSubscriptions.html) in the _Amazon CloudWatch User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html properties: DestinationName: description: |+ The name of the CloudWatch Logs destination. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement DestinationPolicy: description: |+ An AWS Identity and Access Management (IAM) policy that specifies who can write to your destination. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption RoleArn: description: |+ The Amazon Resource Name (ARN) of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource (`TargetArn`). _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption TargetArn: description: |+ The ARN of the AWS resource that receives log events. Currently, you can specify only an Kinesis stream. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name, such as `TestDestination`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ The ARN of the CloudWatch Logs destination, such as `arn:aws:logs:us-east-2:123456789012:destination:MyDestination`. examples: {} AWS::Logs::LogGroup: description: The `AWS::Logs::LogGroup` resource creates an Amazon CloudWatch Logs log group that defines common properties for log streams, such as their retention and access control rules. Each log stream must belong to one log group. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html properties: LogGroupName: description: |+ A name for the log group. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the log group. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement RetentionInDays: description: |+ The number of days log events are kept in CloudWatch Logs. When a log event expires, CloudWatch Logs automatically deletes it. For valid values, see [PutRetentionPolicy](http://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutRetentionPolicy.html) in the _Amazon CloudWatch Logs API Reference_. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ The Amazon resource name (ARN) of the CloudWatch Logs log group, such as `arn:aws:logs:us-east-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*`. examples: {} AWS::Logs::LogStream: description: The `AWS::Logs::LogStream` resource creates an Amazon CloudWatch Logs log stream in a log group. A log stream represents the sequence of events coming from an application instance or resource that you are monitoring. For more information, see [Monitoring Log Files](http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/WhatIsCloudWatchLogs.html) in the _Amazon CloudWatch User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html properties: LogGroupName: description: |+ The name of the log group where the log stream is created. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement LogStreamName: description: |+ The name of the log stream to create. The name must be unique within the log group. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name, such as `MyAppLogStream`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Logs::MetricFilter: description: The `AWS::Logs::MetricFilter` resource creates a metric filter that describes how Amazon CloudWatch Logs extracts information from logs that you specify and transforms it into Amazon CloudWatch metrics. If you have multiple metric filters that are associated with a log group, all the filters are applied to the log streams in that group. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html properties: FilterPattern: description: |+ Describes the pattern that CloudWatch Logs follows to interpret each entry in a log. A log entry might contain fields such as timestamps, IP addresses, error codes, bytes transferred, and so on. You use the pattern to specify those fields and to specify what to look for in the log file. For example, if you're interested in error codes that begin with `1234`, your filter pattern might be `[timestamps, ip_addresses, error_codes = 1234*, size, ...]`. For more information, see [Filter and Pattern Syntax](http://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html#extract-log-event-values) in the _Amazon CloudWatch User Guide_. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption LogGroupName: description: |+ The name of an existing log group that you want to associate with this metric filter. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement MetricTransformations: description: |+ Describes how to transform data from a log into a CloudWatch metric. _Required:_ Yes _Type_: A list of [CloudWatch Logs MetricFilter MetricTransformation Property](aws-properties-logs-metricfilter-metrictransformation.html) Important Currently, you can specify only one metric transformation for each metric filter. If you want to specify multiple metric transformations, you must specify multiple metric filters. _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: |- A list of CloudWatch Logs MetricFilter MetricTransformation Property update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::Logs::SubscriptionFilter: description: The `AWS::Logs::SubscriptionFilter` resource creates an Amazon CloudWatch Logs (CloudWatch Logs) subscription filter that defines which log events are delivered to your Kinesis stream or AWS Lambda (Lambda) function and where to send them. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html properties: DestinationArn: description: |+ The Amazon Resource Name (ARN) of the Kinesis stream, Kinesis Firehose delivery stream, or Lambda function that you want to use as the subscription feed destination. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement FilterPattern: description: |+ The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/FilterAndPatternSyntax.html) in the _Amazon CloudWatch User Guide_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement LogGroupName: description: |+ The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement RoleArn: description: |+ An IAM role that grants CloudWatch Logs permission to put data into the specified Kinesis stream. For Lambda and CloudWatch Logs destinations, don't specify this property because CloudWatch Logs gets the necessary permissions from the destination resource. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::OpsWorks::App: description: Defines an AWS OpsWorks app for an AWS OpsWorks stack. The app specifies the code that you want to run on an application server. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html properties: AppSource: description: |+ The information required to retrieve an app from a repository. _Required:_ No _Type_: [AWS OpsWorks Source Type](aws-properties-opsworks-stack-source.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS OpsWorks Source Type update_requires: no_interruption Attributes: description: |+ One or more user-defined key-value pairs to be added to the app attributes bag. _Required:_ No _Type_: A list of key-value pairs _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: A list of key-value pairs update_requires: no_interruption Description: description: |+ A description of the app. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption DataSources: description: |+ A list of databases to associate with the AWS OpsWorks app. _Required:_ No _Type_: List of [AWS OpsWorks App DataSource](aws-properties-opsworks-app-datasource.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Domains: description: |+ The app virtual host settings, with multiple domains separated by commas. For example, `'www.example.com`, `example.com'`. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption EnableSsl: description: |+ Whether to enable SSL for this app. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption Environment: description: |+ The environment variables to associate with the AWS OpsWorks app. _Required:_ No _Type_: List of [AWS OpsWorks App Environment](aws-properties-opsworks-app-environment.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Name: description: |+ The name of the AWS OpsWorks app. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Shortname: description: |+ The app short name, which is used internally by AWS OpsWorks and by Chef recipes. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement SslConfiguration: description: |+ The SSL configuration _Required:_ No _Type_: [AWS OpsWorks SslConfiguration Type](aws-properties-opsworks-app-sslconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- AWS OpsWorks SslConfiguration Type update_requires: no_interruption StackId: description: |+ The ID of the AWS OpsWorks stack to associate this app with. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Type: description: |+ The app type. Each supported type is associated with a particular layer. For more information, see [CreateApp](http://docs.aws.amazon.com/opsworks/latest/APIReference/API_CreateApp.html) in the _AWS OpsWorks Stacks API Reference_. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For example: Copy{ "Ref": "myApp" } For the AWS OpsWorks stack `myApp`, `Ref` returns the ID of the AWS OpsWorks app. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::OpsWorks::ElasticLoadBalancerAttachment: description: Attaches an Elastic Load Balancing load balancer to an AWS OpsWorks layer that you specify. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elbattachment.html properties: ElasticLoadBalancerName: description: |+ Elastic Load Balancing load balancer name. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption LayerId: description: |+ The AWS OpsWorks layer ID that the Elastic Load Balancing load balancer will be attached to. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::OpsWorks::Instance: description: Creates an Amazon Elastic Compute Cloud (Amazon EC2) instance for an AWS OpsWorks stack. Instances for AWS OpsWorks stacks handle the work of serving applications and balancing traffic, for example. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html properties: AgentVersion: description: |+ The version of the AWS OpsWorks agent that AWS OpsWorks installs on each instance. AWS OpsWorks sends commands to the agent to performs tasks on your instances, such as starting Chef runs. For valid values, see the `AgentVersion` parameter for the [CreateInstance](http://docs.aws.amazon.com/opsworks/latest/APIReference/API_CreateInstance.html) action in the _AWS OpsWorks Stacks API Reference_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption AmiId: description: |+ The ID of the custom Amazon Machine Image (AMI) to be used to create the instance. For more information about custom AMIs, see [Using Custom AMIs](http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html) in the _AWS OpsWorks User Guide_. Note If you specify this property, you must set the `Os` property to `Custom`. _Required:_ No _Type_: String _Update requires_: Updates are not supported. required: 'no' type: String update_requires: Architecture: description: |+ The instance architecture. _Required:_ No _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: String update_requires: some_interruptions AutoScalingType: description: |+ For scaling instances, the type of scaling. If you specify load-based scaling, do not specify a time-based scaling configuration. For valid values, see [CreateInstance](http://docs.aws.amazon.com/opsworks/latest/APIReference/API_CreateInstance.html) in the _AWS OpsWorks Stacks API Reference_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement AvailabilityZone: description: |+ The instance Availability Zone. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement BlockDeviceMappings: description: |+ A list of block devices that are mapped to the AWS OpsWorks instance. For more information, see the `BlockDeviceMappings` parameter for the [CreateInstance](http://docs.aws.amazon.com/opsworks/latest/APIReference/API_CreateInstance.html) action in the _AWS OpsWorks Stacks API Reference_. _Required:_ No _Type_: List of [AWS OpsWorks Instance BlockDeviceMapping](aws-properties-opsworks-instance-blockdevicemapping.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement EbsOptimized: description: |+ Whether the instance is optimized for Amazon Elastic Block Store (Amazon EBS) I/O. If you specify an Amazon EBS-optimized instance type, AWS OpsWorks enables EBS optimization by default. For more information, see [Amazon EBS–Optimized Instances](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) in the _Amazon EC2 User Guide for Linux Instances_. _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement ElasticIps: description: |+ A list of Elastic IP addresses to associate with the instance. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Hostname: description: |+ The name of the instance host. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption InstallUpdatesOnBoot: description: |+ Whether to install operating system and package updates when the instance boots. _Required:_ No _Type_: Boolean _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: Boolean update_requires: some_interruptions InstanceType: description: |+ The instance type, which must be supported by AWS OpsWorks. For more information, see [CreateInstance](http://docs.aws.amazon.com/opsworks/latest/APIReference/API_CreateInstance.html) in the _AWS OpsWorks Stacks API Reference_. If you specify an Amazon EBS-optimized instance type, AWS OpsWorks enables EBS optimization by default. For more information about Amazon EBS-optimized instance types, see [Amazon EBS–Optimized Instances](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) in the _Amazon EC2 User Guide for Linux Instances_. _Required:_ Yes _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'yes' type: String update_requires: some_interruptions LayerIds: description: |+ The IDs of the AWS OpsWorks layers to associate with this instance. _Required:_ Yes _Type_: List of String values _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'yes' type: List update_requires: some_interruptions Os: description: |+ The instance operating system. For more information, see [CreateInstance](http://docs.aws.amazon.com/opsworks/latest/APIReference/API_CreateInstance.html) in the _AWS OpsWorks Stacks API Reference_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement RootDeviceType: description: |+ The root device type of the instance. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement SshKeyName: description: |+ The SSH key name of the instance. _Required:_ No _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: String update_requires: some_interruptions StackId: description: |+ The ID of the AWS OpsWorks stack that this instance will be associated with. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement SubnetId: description: |+ The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks to launch the instance in a different subnet. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Tenancy: description: |+ The tenancy of the instance. For more information, see the `Tenancy` parameter for the [CreateInstance](http://docs.aws.amazon.com/opsworks/latest/APIReference/API_CreateInstance.html) action in the _AWS OpsWorks Stacks API Reference_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement TimeBasedAutoScaling: description: |+ The time-based scaling configuration for the instance. _Required:_ No _Type_: [AWS OpsWorks TimeBasedAutoScaling Type](aws-properties-opsworks-instance-timebasedautoscaling.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: |- AWS OpsWorks TimeBasedAutoScaling Type update_requires: replacement VirtualizationType: description: |+ The instance's virtualization type, `paravirtual` or `hvm`. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Volumes: description: |+ A list of AWS OpsWorks volume IDs to associate with the instance. For more information, see [AWS::OpsWorks::Volume](aws-resource-opsworks-volume.html). _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For example: Copy{ "Ref": "myInstance1" } For the AWS OpsWorks instance `myInstance1`, `Ref` returns the AWS OpsWorks instance ID. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). AvailabilityZone: description: "- \n\n`AvailabilityZone`\n\nThe Availability Zone of the AWS OpsWorks instance, such as `us-east-2a`.\n\n" PrivateDnsName: description: "- \n\n`PrivateDnsName`\n\nThe private DNS name of the AWS OpsWorks instance.\n\n" PrivateIp: description: "- \n\n`PrivateIp`\n\nThe private IP address of the AWS OpsWorks instance, such as `192.0.2.0`.\n\n" PublicDnsName: description: "- \n\n`PublicDnsName`\n\nThe public DNS name of the AWS OpsWorks instance.\n\n" PublicIp: description: "- \n\n`PublicIp`\n\nThe public IP address of the AWS OpsWorks instance, such as `192.0.2.0`.\n\nNote\n\nUse this attribute only when the AWS OpsWorks instance is in an AWS OpsWorks layer that auto-assigns public IP addresses.\n\n" examples: {} AWS::OpsWorks::Layer: description: Creates an AWS OpsWorks layer. A layer defines, for example, which packages and applications are installed and how they are configured. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html properties: Attributes: description: |+ One or more user-defined key-value pairs to be added to the stack attributes bag. _Required:_ No _Type_: A list of key-value pairs _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: A list of key-value pairs update_requires: no_interruption AutoAssignElasticIps: description: |+ Whether to automatically assign an Elastic IP address to Amazon EC2 instances in this layer. _Required:_ Yes _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Boolean update_requires: no_interruption AutoAssignPublicIps: description: |+ For AWS OpsWorks stacks that are running in a VPC, whether to automatically assign a public IP address to Amazon EC2 instances in this layer. _Required:_ Yes _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Boolean update_requires: no_interruption CustomInstanceProfileArn: description: |+ The Amazon Resource Name (ARN) of an IAM instance profile that is to be used for the Amazon EC2 instances in this layer. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption CustomJson: description: |+ A custom stack configuration and deployment attributes that AWS OpsWorks installs on the layer's instances. For more information, see the `CustomJson` parameter for the [CreateLayer](http://docs.aws.amazon.com/opsworks/latest/APIReference/API_CreateLayer.html) action in the _AWS OpsWorks Stacks API Reference_. _Required:_ No _Type_: JSON object required: 'no' type: JSON update_requires: CustomRecipes: description: |+ Custom event recipes for this layer. _Required:_ No _Type_: [AWS OpsWorks Recipes Type](aws-properties-opsworks-layer-recipes.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS OpsWorks Recipes Type update_requires: no_interruption CustomSecurityGroupIds: description: |+ Custom security group IDs for this layer. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption EnableAutoHealing: description: |+ Whether to automatically heal Amazon EC2 instances that have become disconnected or timed out. _Required:_ Yes _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Boolean update_requires: no_interruption InstallUpdatesOnBoot: description: |+ Whether to install operating system and package updates when the instance boots. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption LifecycleEventConfiguration: description: |+ The lifecycle events for the AWS OpsWorks layer. _Required:_ No _Type_: [AWS OpsWorks Layer LifeCycleConfiguration](aws-properties-opsworks-layer-lifecycleeventconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- AWS OpsWorks Layer LifeCycleConfiguration update_requires: no_interruption LoadBasedAutoScaling: description: |+ The load-based scaling configuration for the AWS OpsWorks layer. _Required:_ No _Type_: [AWS OpsWorks LoadBasedAutoScaling Type](aws-properties-opsworks-layer-loadbasedautoscaling.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- AWS OpsWorks LoadBasedAutoScaling Type update_requires: no_interruption Name: description: |+ The AWS OpsWorks layer name. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Packages: description: |+ The packages for this layer. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Shortname: description: |+ The layer short name, which is used internally by AWS OpsWorks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. The name can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '\_', and '.'. Important If you update a property that requires the layer to be replaced, you must specify a new short name. You cannot have multiple layers with the same short name. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption StackId: description: |+ The ID of the AWS OpsWorks stack that this layer will be associated with. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Tags: description: |+ Specifies an arbitrary set of tags (key–value pairs) to associate with this AWS OpsWorks layer. Use tags to manage your resources. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption Type: description: |+ The layer type. A stack cannot have more than one layer of the same type, except for the `custom` type. You can have any number of `custom` types. For more information, see [CreateLayer](http://docs.aws.amazon.com/opsworks/latest/APIReference/API_CreateLayer.html) in the _AWS OpsWorks Stacks API Reference_. Important If you update a property that requires the layer to be replaced, you must specify a new type unless you have a `custom` type. You can have any number of `custom` types. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement VolumeConfigurations: description: |+ Describes the Amazon EBS volumes for this layer. _Required:_ No _Type_: A list of [AWS OpsWorks VolumeConfiguration Type](aws-properties-opsworks-layer-volumeconfig.html) _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: |- A list of AWS OpsWorks VolumeConfiguration Type update_requires: some_interruptions return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For example: Copy{ "Ref": "myLayer" } For the AWS OpsWorks layer `myLayer`, `Ref` returns the AWS OpsWorks layer ID. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::OpsWorks::Stack: description: Creates an AWS OpsWorks stack. An AWS OpsWorks stack represents a set of instances that you want to manage collectively, typically because they have a common purpose such as serving PHP applications. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html properties: AgentVersion: description: |+ The AWS OpsWorks agent version that you want to use. The agent communicates with the service and handles tasks such as initiating Chef runs in response to lifecycle events. For valid values, see the [AgentVersion](http://docs.aws.amazon.com/opsworks/latest/APIReference/API_CreateStack.html#opsworks-CreateStack-request-AgentVersion) parameter for the `CreateStack` action in the _AWS OpsWorks Stacks API Reference_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Attributes: description: |+ One or more user-defined key-value pairs to be added to the stack attributes bag. _Required:_ No _Type_: A list of key-value pairs _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: A list of key-value pairs update_requires: no_interruption ChefConfiguration: description: |+ Describes the Chef configuration. For more information, see the [CreateStack ChefConfiguration](http://docs.aws.amazon.com/opsworks/latest/APIReference/API_CreateStack.html#opsworks-CreateStack-request-ChefConfiguration) parameter in the _AWS OpsWorks Stacks API Reference_. Note To enable Berkshelf, you must select a Chef version in the `ConfigurationManager` property that supports Berkshelf. _Required:_ No _Type_: [AWS OpsWorks ChefConfiguration Type](aws-properties-opsworks-stack-chefconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- AWS OpsWorks ChefConfiguration Type update_requires: no_interruption CloneAppIds: description: |+ If you're cloning an AWS OpsWorks stack, a list of AWS OpsWorks application stack IDs from the source stack to include in the cloned stack. _Required:_ No _Type_: List of String values _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: List update_requires: replacement ClonePermissions: description: |+ If you're cloning an AWS OpsWorks stack, indicates whether to clone the source stack's permissions. _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement ConfigurationManager: description: |+ Describes the configuration manager. When you create a stack, you use the configuration manager to specify the Chef version. For supported Chef versions, see the [CreateStack ConfigurationManager](http://docs.aws.amazon.com/opsworks/latest/APIReference/API_CreateStack.html#opsworks-CreateStack-request-ConfigurationManager) parameter in the _AWS OpsWorks Stacks API Reference_. _Required:_ No _Type_: [AWS OpsWorks StackConfigurationManager Type](aws-properties-opsworks-stack-stackconfigmanager.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- AWS OpsWorks StackConfigurationManager Type update_requires: no_interruption CustomCookbooksSource: description: |+ Contains the information required to retrieve a cookbook from a repository. _Required:_ No _Type_: [AWS OpsWorks Source Type](aws-properties-opsworks-stack-source.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS OpsWorks Source Type update_requires: no_interruption CustomJson: description: |+ A user-defined custom JSON object. The custom JSON is used to override the corresponding default stack configuration JSON values. For more information, see [CreateStack](http://docs.aws.amazon.com/opsworks/latest/APIReference/API_CreateStack.html) in the _AWS OpsWorks Stacks API Reference_. Important AWS CloudFormation submits all JSON attributes as strings, including any Boolean or number attributes. If you have recipes that expect booleans or numbers, you must modify the recipes to accept strings and to interpret those strings as booleans or numbers. _Required:_ No _Type_: JSON object _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: JSON update_requires: no_interruption DefaultAvailabilityZone: description: |+ The stack's default Availability Zone, which must be in the specified region. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption DefaultInstanceProfileArn: description: |+ The Amazon Resource Name (ARN) of an IAM instance profile that is the default profile for all of the stack's Amazon EC2 instances. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption DefaultOs: description: |+ The stack's default operating system. For more information, see [CreateStack](http://docs.aws.amazon.com/opsworks/latest/APIReference/API_CreateStack.html) in the _AWS OpsWorks Stacks API Reference_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption DefaultRootDeviceType: description: |+ The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see [CreateStack](http://docs.aws.amazon.com/opsworks/latest/APIReference/API_CreateStack.html) in the _AWS OpsWorks Stacks API Reference_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption DefaultSshKeyName: description: |+ A default SSH key for the stack instances. You can override this value when you create or update an instance. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption DefaultSubnetId: description: |+ The stack's default subnet ID. All instances are launched into this subnet unless you specify another subnet ID when you create the instance. _Required:_ Conditional. If you specify the `VpcId` property, you must specify this property. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption EcsClusterArn: description: |+ The Amazon Resource Name (ARN) of the Amazon Elastic Container Service (Amazon ECS) cluster to register with the AWS OpsWorks stack. Note If you specify a cluster that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the cluster. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption ElasticIps: description: |+ A list of Elastic IP addresses to register with the AWS OpsWorks stack. Note If you specify an IP address that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the IP address. _Required:_ No _Type_: List of [AWS OpsWorks Stack ElasticIp](aws-properties-opsworks-stack-elasticip.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption HostnameTheme: description: |+ The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. For more information, see [CreateStack](http://docs.aws.amazon.com/opsworks/latest/APIReference/API_CreateStack.html) in the _AWS OpsWorks Stacks API Reference_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Name: description: |+ The name of the AWS OpsWorks stack. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption RdsDbInstances: description: |+ The Amazon Relational Database Service (Amazon RDS) DB instance to register with the AWS OpsWorks stack. Note If you specify a DB instance that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the DB instance. _Required:_ No _Type_: List of [AWS OpsWorks Stack RdsDbInstance](aws-properties-opsworks-stack-rdsdbinstance.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption ServiceRoleArn: description: |+ The AWS Identity and Access Management (IAM) role that AWS OpsWorks uses to work with AWS resources on your behalf. You must specify an Amazon Resource Name (ARN) for an existing IAM role. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement SourceStackId: description: |+ If you're cloning an AWS OpsWorks stack, the stack ID of the source AWS OpsWorks stack to clone. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Tags: description: |+ Specifies an arbitrary set of tags (key–value pairs) to associate with this AWS OpsWorks stack. Use tags to manage your resources. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption UseCustomCookbooks: description: |+ Whether the stack uses custom cookbooks. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption UseOpsworksSecurityGroups: description: |+ Whether to associate the AWS OpsWorks built-in security groups with the stack's layers. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption VpcId: description: |+ The ID of the VPC that the stack is to be launched into, which must be in the specified region. All instances are launched into this VPC. If you specify this property, you must specify the `DefaultSubnetId` property. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For example: Copy{ "Ref": "myStack" } For the AWS OpsWorks stack `myStack`, `Ref` returns the AWS OpsWorks stack ID. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::OpsWorks::UserProfile: description: The `AWS::OpsWorks::UserProfile` resource configures SSH access for users who require access to instances in an AWS OpsWorks stack. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html properties: AllowSelfManagement: description: |+ Indicates whether users can use the AWS OpsWorks **My Settings** page to specify their own SSH public key. For more information, see [Setting an IAM User's Public SSH Key](http://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html) in the _AWS OpsWorks User Guide_. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption IamUserArn: description: |+ The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) user to associate with this configuration. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement SshPublicKey: description: |+ The public SSH key that is associated with the IAM user. To access instances, the IAM user must have or be given the corresponding private key. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption SshUsername: description: |+ The user's SSH user name. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the IAM user ARN, such as `arn:aws:iam::123456789012:user/opsworksuser`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). SshUsername: description: "- \n\n`SshUsername`\n\nThe user's SSH user name, as a string.\n\n" examples: {} AWS::OpsWorks::Volume: description: The `AWS::OpsWorks::Volume` resource registers an Amazon Elastic Block Store (Amazon EBS) volume with an AWS OpsWorks stack. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html properties: Ec2VolumeId: description: |+ The ID of the Amazon EBS volume to register with the AWS OpsWorks stack. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement MountPoint: description: |+ The mount point for the Amazon EBS volume, such as `/mnt/disk1`. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Name: description: |+ A name for the Amazon EBS volume. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption StackId: description: |+ The ID of the AWS OpsWorks stack that AWS OpsWorks registers the volume to. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the AWS OpsWorks volume ID, such as `1ab23cd4-92ff-4501-b37c-example`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::RDS::DBCluster: description: |- The `AWS::RDS::DBCluster` resource creates a cluster, such as an Aurora for Amazon RDS (Amazon Aurora) DB cluster. Amazon Aurora is a fully managed, MySQL-compatible, relational database engine. For more information, see [Aurora on Amazon RDS](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html) in the _Amazon Relational Database Service User Guide_. Note Currently, you can create this resource only in regions in which Amazon Aurora is supported. The default DeletionPolicy for `AWS::RDS::DBCluster` resources is `Snapshot`. For more information about how AWS CloudFormation deletes resources, see [DeletionPolicy Attribute](aws-attribute-deletionpolicy.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html properties: AvailabilityZones: description: |+ A list of Availability Zones (AZs) in which DB instances in the cluster can be created. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement BackupRetentionPeriod: description: |+ The number of days for which automatic backups are retained. For more information, see [CreateDBCluster](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html) in the _Amazon Relational Database Service API Reference_. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) or [some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). For more information, see [ModifyDBInstance](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) in the _Amazon Relational Database Service API Reference_. required: 'no' type: Number update_requires: some_interruptions DatabaseName: description: |+ The name of your database. If you don't provide a name, Amazon Relational Database Service (Amazon RDS) won't create a database in this DB cluster. For naming constraints, see [Naming Constraints in Amazon RDS](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the _Amazon Relational Database Service User Guide_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement DBClusterParameterGroupName: description: |+ The name of the DB cluster parameter group to associate with this DB cluster. For the default value, see the `DBClusterParameterGroupName` parameter of the [CreateDBCluster](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html) action in the _Amazon Relational Database Service API Reference_. _Required:_ No _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: String update_requires: some_interruptions DBSubnetGroupName: description: |+ A DB subnet group that you want to associate with this DB cluster. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Engine: description: |+ The name of the database engine that you want to use for this DB cluster. For valid values, see the `Engine` parameter of the [CreateDBCluster](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html) action in the _Amazon Relational Database Service API Reference_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement EngineVersion: description: |+ The version number of the database engine that you want to use. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement KmsKeyId: description: |+ The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef`. If you enable the `StorageEncrypted` property but don't specify this property, the default master key is used. If you specify this property, you must set the `StorageEncrypted` property to `true`. If you specify the `SnapshotIdentifier`, do not specify this property. The value is inherited from the snapshot DB cluster. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement). required: 'no' type: String update_requires: replacement MasterUsername: description: |+ The master user name for the DB instance. _Required:_ Conditional. You must specify this property unless you specify the `SnapshotIdentifier` property. In that case, do not specify this property. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement). required: conditional type: String update_requires: replacement MasterUserPassword: description: |+ The password for the master database user. _Required:_ Conditional. You must specify this property unless you specify the `SnapshotIdentifier` property. In that case, do not specify this property. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption Port: description: |+ The port number on which the DB instances in the cluster can accept connections. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption PreferredBackupWindow: description: |+ if automated backups are enabled (see the `BackupRetentionPeriod` property), the daily time range in UTC during which you want to create automated backups. For valid values, see the `PreferredBackupWindow` parameter of the [CreateDBInstance](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) action in the _Amazon Relational Database Service API Reference_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption PreferredMaintenanceWindow: description: |+ The weekly time range (in UTC) during which system maintenance can occur. For valid values, see the `PreferredMaintenanceWindow` parameter of the [CreateDBInstance](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) action in the _Amazon Relational Database Service API Reference_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) or [some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). For more information, see [ModifyDBInstance](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) in the _Amazon Relational Database Service API Reference_. required: 'no' type: String update_requires: some_interruptions ReplicationSourceIdentifier: description: |+ The Amazon Resource Name (ARN) of the source Amazon RDS MySQL DB instance or DB cluster, if this DB cluster is created as a Read Replica. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption SnapshotIdentifier: description: |+ The identifier for the DB cluster snapshot from which you want to restore. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement StorageEncrypted: description: |+ Indicates whether the DB instances in the cluster are encrypted. If you specify the `SnapshotIdentifier` property, do not specify this property. The value is inherited from the snapshot DB cluster. _Required:_ Conditional. If you specify the `KmsKeyId` property, you must enable encryption. _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement). required: conditional type: Boolean update_requires: replacement Tags: description: |+ The tags that you want to attach to this DB cluster. _Required:_ No _Type_: A list of [resource tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: A list of resource tags update_requires: no_interruption VpcSecurityGroupIds: description: |+ A list of VPC security groups to associate with this DB cluster. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Endpoint.Address: description: |+ The connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.``us-east-2``.rds.amazonaws.com`. Endpoint.Port: description: |+ The port number on which the Amazon Redshift cluster accepts connections. For example: `5439`. ReadEndpoint.Address: description: |+ The reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.``us-east-2``.rds.amazonaws.com`. examples: {} AWS::RDS::DBClusterParameterGroup: description: |- The `AWS::RDS::DBClusterParameterGroup` resource creates a new Amazon Relational Database Service (Amazon RDS) database (DB) cluster parameter group. For more information about DB cluster parameter groups, see [Appendix: DB Cluster and DB Instance Parameters](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Appendix.ParameterGroups.html) in the _Amazon Relational Database Service User Guide_. Note Applying a parameter group to a DB cluster might require instances to reboot, resulting in a database outage while the instances reboot. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html properties: Description: description: |+ A friendly description for this DB cluster parameter group. _Required:_ Yes _Type:_ String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Family: description: |+ The database family of this DB cluster parameter group, such as `aurora5.6`. _Required:_ Yes _Type:_ String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Parameters: description: |+ The parameters to set for this DB cluster parameter group. For a list of parameter keys, see [Appendix: DB Cluster and DB Instance Parameters](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Appendix.ParameterGroups.html) in the _Amazon Relational Database Service User Guide_. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance that is associated with the parameter group before the change can take effect. _Required:_ Yes _Type:_ A JSON object consisting of string key-value pairs, as shown in the following example: Copy"Parameters" : { "Key1" : "Value1", "Key2" : "Value2", "Key3" : "Value3" } _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) or [some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt), depending on the parameters that you update. required: 'yes' type: |- A JSON object consisting of string key-value pairs, as shown in the following example: update_requires: some_interruptions Tags: description: |+ The tags that you want to attach to this parameter group. _Required:_ No _Type_: A list of [resource tags](aws-properties-resource-tags.html) _Update requires_: Updates are not supported. required: 'no' type: A list of resource tags update_requires: return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::RDS::DBInstance: description: |- The `AWS::RDS::DBInstance` type creates an Amazon Relational Database Service (Amazon RDS) DB instance. For detailed information about configuring RDS DB instances, see [CreateDBInstance](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html). Important If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](protect-stack-resources.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html properties: AllocatedStorage: description: |+ The allocated storage size, specified in gigabytes (GB). If any value is set in the `Iops` parameter, `AllocatedStorage` must be at least 100 GB, which corresponds to the minimum `Iops` value of 1,000. If you increase the `Iops` value (in 1,000 IOPS increments), then you must also increase the `AllocatedStorage` value (in 100-GB increments). _Required:_ Conditional. This property is required except when you specify the `DBClusterIdentifier` property or when you create a read replica from AWS CloudFormation by using the `AWS::RDS::DBInstance` resource. In these cases, don't specify this property. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption AllowMajorVersionUpgrade: description: |+ If you update the `EngineVersion` property to a version that's different from the DB instance's current major version, set this property to `true`. For more information, see [ModifyDBInstance](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) in the _Amazon Relational Database Service API Reference_. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption AutoMinorVersionUpgrade: description: |+ Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window. The default value is `true`. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) or [some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). For more information, see [ModifyDBInstance](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) in the _Amazon Relational Database Service API Reference_. required: 'no' type: Boolean update_requires: some_interruptions AvailabilityZone: description: |+ The name of the Availability Zone where the DB instance is located. You can't set the `AvailabilityZone` parameter if the `MultiAZ` parameter is set to `true`. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement BackupRetentionPeriod: description: |+ The number of days during which automatic DB snapshots are retained. Important If this DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) or [some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). For more information, see [ModifyDBInstance](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) in the _Amazon Relational Database Service API Reference_. required: 'no' type: String update_requires: some_interruptions CharacterSetName: description: |+ For supported engines, specifies the character set to associate with the DB instance. For more information, see [Appendix: Oracle Character Sets Supported in Amazon RDS](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.OracleCharacterSets.html) in the _Amazon Relational Database Service User Guide_. If you specify the `DBSnapshotIdentifier` or `SourceDBInstanceIdentifier` property, don't specify this property. The value is inherited from the snapshot or source DB instance. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement CopyTagsToSnapshot: description: |+ Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. By default, Amazon RDS doesn't copy tags to snapshots. Amazon RDS doesn't copy tags with the `aws::` prefix unless it's the DB instance's final snapshot (the snapshot when you delete the DB instance). _Required_: No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption DBClusterIdentifier: description: |+ The name of an existing DB cluster that this instance is associated with. If you specify this property, specify `aurora` for the `Engine` property and don't specify any of the following properties: `AllocatedStorage`, `BackupRetentionPeriod`, `CharacterSetName`, `DBName`, `DBSecurityGroups`, `MasterUsername`, `MasterUserPassword`, `OptionGroupName`, `PreferredBackupWindow`, `PreferredMaintenanceWindow`, `Port`, `SourceDBInstanceIdentifier`, `StorageType`, or `VPCSecurityGroups`. Amazon RDS assigns the first DB instance in the cluster as the primary, and additional DB instances as replicas. If you specify this property, the default deletion policy is `Delete`. Otherwise, the default deletion policy is `Snapshot`. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement DBInstanceClass: description: |+ The name of the compute and memory capacity classes of the DB instance. _Required:_ Yes _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'yes' type: String update_requires: some_interruptions DBInstanceIdentifier: description: |+ A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement DBName: description: |+ The name of the DB instance that was provided at the time of creation, if one was specified. This same name is returned for the life of the DB instance. Important If you specify the `DBSnapshotIdentifier` property, AWS CloudFormation ignores this property. If you restore DB instances from snapshots, this property doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement DBParameterGroupName: description: |+ The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](aws-properties-rds-dbparametergroup.html) resource created in the template. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) or [some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. required: 'no' type: String update_requires: some_interruptions DBSecurityGroups: description: "A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to [AWS::RDS::DBSecurityGroup](aws-properties-rds-security-group.html) resources created in the template.\n\nIf you set `DBSecurityGroups`, you must not set [VPCSecurityGroups](aws-properties-rds-database-instance.html#cfn-rds-dbinstance-vpcsecuritygroups), and vice versa. Also, note that the `EC2VpcId` property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use `VPCSecurityGroups`.\n\nImportant\n\nIf you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS:\n\n- \n\n`AllocatedStorage`\n\n- \n\n`AutoMinorVersionUpgrade`\n\n- \n\n`AvailabilityZone`\n\n- \n\n`BackupRetentionPeriod`\n\n- \n\n`CharacterSetName`\n\n- \n\n`DBInstanceClass`\n\n- \n\n`DBName`\n\n- \n\n`DBParameterGroupName`\n\n- \n\n`DBSecurityGroups`\n\n- \n\n`DBSubnetGroupName`\n\n- \n\n`Engine`\n\n- \n\n`EngineVersion`\n\n- \n\n`Iops`\n\n- \n\n`LicenseModel`\n\n- \n\n`MasterUsername`\n\n- \n\n`MasterUserPassword`\n\n- \n\n`MultiAZ`\n\n- \n\n`OptionGroupName`\n\n- \n\n`PreferredBackupWindow`\n\n- \n\n`PreferredMaintenanceWindow`\n\nAll other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as `StorageType`, `StorageEncrypted`, or `KmsKeyId`. If you're already using the `DBSecurityGroups` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.\n\n_Required:_ No\n\n_Type_: List of String values\n\n_Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n\n" required: 'no' type: List update_requires: no_interruption DBSnapshotIdentifier: description: |+ The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the `DBSnapshotIdentifier` property is an empty string or the `AWS::RDS::DBInstance` declaration has no `DBSnapshotIdentifier` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as the `MasterUsername` and `MasterUserPassword` properties. For information about the properties that you can specify, see the [RestoreDBInstanceFromDBSnapshot](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html) action in the _Amazon Relational Database Service API Reference_. Important If you specify this property, AWS CloudFormation ignores the `DBName` property. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement DBSubnetGroupName: description: |+ A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the _Amazon Relational Database Service Developer Guide_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Domain: description: |+ For an Amazon RDS DB instance that's running Microsoft SQL Server, the Active Directory directory ID to create the instance in. Amazon RDS uses Windows Authentication to authenticate users that connect to the DB instance. For more information, see [Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server](http://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_SQLServerWinAuth.html) in the _Amazon Relational Database Service User Guide_. If you specify this property, you must specify a SQL Server engine for the `Engine` property. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption DomainIAMRoleName: description: |+ The name of an IAM role that Amazon RDS uses when calling the AWS Directory Service APIs. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Engine: description: |+ The database engine that the DB instance uses. This property is optional when you specify the `DBSnapshotIdentifier` property to create DB instances. For valid values, see the `Engine` parameter of the [CreateDBInstance](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) action in the _Amazon Relational Database Service API Reference_. If you specify `aurora` as the database engine, you must also specify the `DBClusterIdentifier` property. Note If you've specified `oracle-se` or `oracle-se1` as the database engine, you can update the database engine to `oracle-se2` without the database instance being replaced. For information on the deprecation of support for Oracle version 12.1.0.1, see [Deprecation of Oracle 12.1.0.1](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Oracle.html#Oracle.Concepts.Deprecate.12101) in the _Amazon Relational Database Service User Guide_. _Required:_ Conditional _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement EngineVersion: description: |+ The version number of the database engine that the DB instance uses. _Required:_ No _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: String update_requires: some_interruptions Iops: description: |+ The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than `1000`. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with `1000` IOPS and `200` GB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](http://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the _Amazon Relational Database Service User Guide_. _Required:_ Conditional. If you specify `io1` for the `StorageType` property, you must specify this property. _Type_: Number _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: Number update_requires: no_interruption KmsKeyId: description: |+ The ARN of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the DB instance, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef`. If you enable the `StorageEncrypted` property but don't specify this property, AWS CloudFormation uses the default master key. If you specify this property, you must set the `StorageEncrypted` property to `true`. If you specify the `SourceDBInstanceIdentifier` property, the value is inherited from the source DB instance if the read replica is created in the same region. If you specify this property when you create a read replica from an unencrypted DB instance, the read replica is encrypted. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. If you specify `DBSecurityGroups`, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the _Amazon Relational Database Service User Guide_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement LicenseModel: description: |+ The license model of the DB instance. Note If `DBSecurityGroups` is specified, updating the license model requires its replacement. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption MasterUsername: description: |+ The master user name for the DB instance. Note If you specify the `SourceDBInstanceIdentifier` or `DBSnapshotIdentifier` property, don't specify this property. The value is inherited from the source DB instance or snapshot. _Required:_ Conditional _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement MasterUserPassword: description: |+ The master password for the DB instance. Note If you specify the `SourceDBInstanceIdentifier` or `DBSnapshotIdentifier` property, don't specify this property. The value is inherited from the source DB instance or snapshot. _Required:_ Conditional _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption MonitoringInterval: description: |+ The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance. To disable metrics collection, specify `0`. For default and valid values, see the `MonitoringInterval` parameter for the [CreateDBInstance](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) action in the _Amazon Relational Database Service API Reference_. _Required:_ Conditional. If you specify the `MonitoringRoleArn` property, specify a value other than `0` for `MonitoringInterval`. _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) or [some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). For more information, see [ModifyDBInstance](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) in the _Amazon Relational Database Service API Reference_. required: conditional type: Number update_requires: some_interruptions MonitoringRoleArn: description: |+ The ARN of the AWS Identity and Access Management (IAM) role that permits Amazon RDS to send enhanced monitoring metrics to Amazon CloudWatch, for example, `arn:aws:iam::123456789012:role/emaccess`. For information on creating a monitoring role, see [To create an IAM role for Amazon RDS Enhanced Monitoring](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole) in the _Amazon Relational Database Service User Guide_. _Required:_ Conditional. If you specify a value other than `0` for the `MonitoringInterval` property, specify a value for `MonitoringRoleArn`. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption MultiAZ: description: |+ Specifies if the database instance is a multiple Availability Zone deployment. You can't set the `AvailabilityZone` parameter if the `MultiAZ` parameter is set to true. Amazon Aurora storage is replicated across all the Availability Zones and doesn't require the `MultiAZ` option to be set. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption OptionGroupName: description: |+ The option group that this DB instance is associated with. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Port: description: |+ The port for the instance. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement PreferredBackupWindow: description: |+ The daily time range during which automated backups are performed if automated backups are enabled, as determined by the `BackupRetentionPeriod` property. For valid values, see the `PreferredBackupWindow` parameter for the [CreateDBInstance](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) action in the _Amazon Relational Database Service API Reference_. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption PreferredMaintenanceWindow: description: |+ The weekly time range (in UTC) during which system maintenance can occur. For valid values, see the `PreferredMaintenanceWindow` parameter for the [CreateDBInstance](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) action in the _Amazon Relational Database Service API Reference_. Note This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) or [some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). For more information, see [ModifyDBInstance](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) in the _Amazon Relational Database Service API Reference_. required: 'no' type: String update_requires: some_interruptions PubliclyAccessible: description: |+ Indicates whether the DB instance is an internet-facing instance. If you specify `true`, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify `false`, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the `PubliclyAccessible` parameter in [CreateDBInstance](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the _Amazon Relational Database Service API Reference_. If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the `DependsOn` attribute to declare a dependency on the VPC-gateway attachment. For more information, see [DependsOn Attribute](aws-attribute-dependson.html). Note If you specify `DBSecurityGroups`, AWS CloudFormation ignores this property. To specify a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the _Amazon Relational Database Service User Guide_. _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement SourceDBInstanceIdentifier: description: "If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](http://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the _Amazon Relational Database Service Developer Guide_.\n\nThe `SourceDBInstanceIdentifier` property determines whether a DB instance is a read replica. If you remove the `SourceDBInstanceIdentifier` property from your template and then update your stack, AWS CloudFormation deletes the read replica and creates a new DB instance (not a read replica).\n\nImportant\n\n- \n\nIf you specify a source DB instance that uses VPC security groups, we recommend that you specify the `VPCSecurityGroups` property. If you don't specify the property, the read replica inherits the value of the `VPCSecurityGroups` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's `VPCSecurityGroups` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues.\n\n- \n\nRead replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica.\n\n- \n\nIf you specify `SourceDBInstanceIdentifier`, don't set the `MultiAZ` property to `true`, and don't specify the `DBSnapshotIdentifier` property. You can't deploy read replicas in multiple Availability Zones, and you can't create a read replica from a snapshot.\n\n- \n\nDon't set the `BackupRetentionPeriod`, `DBName`, `MasterUsername`, `MasterUserPassword`, and `PreferredBackupWindow` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas.\n\n- \n\nIf the source DB instance is in a different region than the read replica, specify an ARN for a valid DB instance. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the _Amazon Relational Database Service User Guide_.\n\n- \n\nFor DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances.\n\n_Required:_ No\n\n_Type_: String\n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n\n" required: 'no' type: String update_requires: replacement SourceRegion: description: |+ The ID of the region that contains the source DB instance for the read replica. _Required:_ No _Type:_ String _Update requires:_ [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement StorageEncrypted: description: |+ Indicates whether the DB instance is encrypted. If you specify the `DBClusterIdentifier`, `DBSnapshotIdentifier`, or `SourceDBInstanceIdentifier` property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. _Required:_ Conditional. If you specify the `KmsKeyId` property, you must enable encryption. _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: Boolean update_requires: replacement StorageType: description: |+ The storage type associated with this DB instance. For the default and valid values, see the `StorageType` parameter of the [CreateDBInstance](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) action in the _Amazon Relational Database Service API Reference_. _Required:_ No _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: String update_requires: some_interruptions Tags: description: |+ An arbitrary set of tags (key–value pairs) for this DB instance. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption Timezone: description: |+ The time zone of the DB instance, which you can specify to match the time zone of your applications. To see which engines support time zones, see the `Timezone` parameter for the [CreateDBInstance](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) action in the _Amazon Relational Database Service API Reference_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement VPCSecurityGroups: description: "A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](aws-properties-ec2-security-group.html) resources created in the template.\n\nIf you set `VPCSecurityGroups`, you must not set [DBSecurityGroups](aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa.\n\nImportant\n\nYou can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:\n\n- \n\nYou can't revert to using an RDS security group after you establish a VPC security group membership.\n\n- \n\nWhen you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.\n\n- \n\nTo use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property.\n\nTo avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template.\n\n_Required:_ No\n\n_Type_: List of String values\n\n_Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n\n" required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When you provide the RDS DB instance's logical name to the `Ref` intrinsic function, `Ref` returns the `DBInstanceIdentifier`. For example: `mystack-mydb-ea5ugmfvuaxg`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Endpoint.Address: description: "- \n\n**Endpoint.Address**\n\nThe connection endpoint for the database. For example: `mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.``us-east-2``.rds.amazonaws.com`.\n\n" Endpoint.Port: description: "- \n\n**Endpoint.Port**\n\nThe port number on which the database accepts connections. For example: `3306`.\n\n" examples: {} AWS::RDS::DBParameterGroup: description: |- Creates a custom parameter group for an RDS database family. For more information about RDS parameter groups, see [Working with DB Parameter Groups](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the _Amazon Relational Database Service User Guide_. This type can be declared in a template and referenced in the `DBParameterGroupName` parameter of [AWS::RDS::DBInstance](aws-properties-rds-database-instance.html). Note Applying a ParameterGroup to a DBInstance may require the instance to reboot, resulting in a database outage for the duration of the reboot. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html properties: Description: description: |+ A friendly description of the RDS parameter group. For example, `"My Parameter Group"`. _Required:_ Yes _Type:_ String _Update requires_: Updates are not supported. required: 'yes' type: String update_requires: Family: description: |+ The database family of this RDS parameter group. For example, `"MySQL5.1"`. _Required:_ Yes _Type:_ String _Update requires_: Updates are not supported. required: 'yes' type: String update_requires: Parameters: description: |+ The parameters to set for this RDS parameter group. _Required:_ No _Type:_ A JSON object consisting of string key-value pairs, as shown in the following example: Copy "Parameters" : { "Key1" : "Value1", "Key2" : "Value2", "Key3" : "Value3" } _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) or [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Changes to dynamic parameters are applied immediately. During an update, if you have static parameters (whether they were changed or not), triggers AWS CloudFormation to reboot the associated DB instance without failover. required: 'no' type: |- A JSON object consisting of string key-value pairs, as shown in the following example: update_requires: some_interruptions Tags: description: |+ The tags that you want to attach to the RDS parameter group. _Required:_ No _Type_: A list of [resource tags](aws-properties-resource-tags.html). _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: A list of resource tags. update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For example: Copy{ "Ref": "MyDBParameterGroup" } For the RDS::DBParameterGroup with the logical ID "MyDBParameterGroup", `Ref` will return the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::RDS::DBSecurityGroup: description: |- The AWS::RDS::DBSecurityGroup type is used to create or update an Amazon RDS DB Security Group. For more information about DB security groups, see [Working with DB Security Groups](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithSecurityGroups.html) in the _Amazon Relational Database Service Developer Guide_. For details on the settings for DB security groups, see [CreateDBSecurityGroup](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBSecurityGroup.html). Note If you use DB security groups, the settings that you can specify for your DB instances are limited. For more information, see the [DBSecurityGroups](aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property. When you specify an AWS::RDS::DBSecurityGroup as an argument to the `Ref` function, AWS CloudFormation returns the value of the `DBSecurityGroupName`. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html properties: EC2VpcId: description: |+ The Id of the VPC. Indicates which VPC this DB Security Group should belong to. Important The `EC2VpcId` property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use `VPCSecurityGroups`. _Type_: String _Required_: Conditional. Must be specified to create a DB Security Group for a VPC; may not be specified otherwise. _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement DBSecurityGroupIngress: description: |+ Network ingress authorization for an Amazon EC2 security group or an IP address range. _Type_: List of [RDS Security Group Rules](aws-properties-rds-security-group-rule.html). _Required_: Yes _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: List update_requires: no_interruption GroupDescription: description: |+ Description of the security group. _Type_: String _Required_: Yes _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Tags: description: |+ The tags that you want to attach to the Amazon RDS DB security group. _Required:_ No _Type_: A list of [resource tags](aws-properties-resource-tags.html). _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: A list of resource tags. update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::RDS::DBSecurityGroupIngress: description: |- The AWS::RDS::DBSecurityGroupIngress type enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. For more information about DB security groups, see [Working with DB security groups](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithSecurityGroups.html) This type supports updates. For more information about updating stacks, see [AWS CloudFormation Stacks Updates](using-cfn-updating-stacks.html). For details about the settings for DB security group ingress, see [AuthorizeDBSecurityGroupIngress](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_AuthorizeDBSecurityGroupIngress.html). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html properties: CIDRIP: description: |+ The IP range to authorize. For an overview of CIDR ranges, go to the [Wikipedia Tutorial](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: type: String update_requires: no_interruption DBSecurityGroupName: description: |+ The name (ARN) of the [AWS::RDS::DBSecurityGroup](aws-properties-rds-security-group.html) to which this ingress will be added. _Type_: String _Required:_ Yes _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption EC2SecurityGroupId: description: |+ The ID of the VPC or EC2 security group to authorize. For VPC DB security groups, use EC2SecurityGroupId. For EC2 security groups, use EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId. _Type_: String _Required:_ No _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption EC2SecurityGroupName: description: |+ The name of the EC2 security group to authorize. For VPC DB security groups, use EC2SecurityGroupId. For EC2 security groups, use EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId. _Type_: String _Required:_ No _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption EC2SecurityGroupOwnerId: description: |+ The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, use EC2SecurityGroupId. For EC2 security groups, use EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId. _Type_: String _Required:_ No _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::RDS::DBSubnetGroup: description: The AWS::RDS::DBSubnetGroup type creates an RDS database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnet-group.html properties: DBSubnetGroupDescription: description: |+ The description for the DB Subnet Group. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption SubnetIds: description: |+ The EC2 Subnet IDs for the DB Subnet Group. _Required:_ Yes _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: List update_requires: no_interruption Tags: description: |+ The tags that you want to attach to the RDS database subnet group. _Required:_ No _Type_: A list of [resource tags](aws-properties-resource-tags.html) in key-value format. _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- A list of resource tags in key-value format. update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::RDS::DBSubnetGroup` resource to the intrinsic `Ref` function, the function returns the name of the DB subnet group, such as `mystack-mydbsubnetgroup-0a12bc456789de0fg`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::RDS::EventSubscription: description: Use the `AWS::RDS::EventSubscription` resource to get notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service. For more information, see [Using Amazon RDS Event Notification](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) in the _Amazon Relational Database Service User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html properties: Enabled: description: |+ Indicates whether to activate the subscription. If you don't specify this property, AWS CloudFormation activates the subscription. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption EventCategories: description: |+ A list of event categories that you want to subscribe to for a given source type. If you don't specify this property, you are notified about all event categories. For more information, see [Using Amazon RDS Event Notification](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) in the _Amazon Relational Database Service User Guide_. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption SnsTopicArn: description: |+ The Amazon Resource Name (ARN) of an Amazon SNS topic that you want to send event notifications to. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement SourceIds: description: |+ A list of identifiers for which Amazon RDS provides notification events. If you don't specify a value, notifications are provided for all sources. If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, all other values must be database instance IDs. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption SourceType: description: |+ The type of source for which Amazon RDS provides notification events. For example, if you want to be notified of events generated by a database instance, set this parameter to `db-instance`. If you don't specify a value, notifications are provided for all source types. For valid values, see the `SourceType` parameter for the [CreateEventSubscription](http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateEventSubscription.html) action in the _Amazon Relational Database Service API Reference_. _Required:_ Conditional. If you specify the `SourceIds` or `EventCategories` property, you must specify this property. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) if you're removing this property after it was previously specified. All other updates require [no interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). required: conditional type: String update_requires: replacement return_values: Ref: description: '' examples: {} AWS::RDS::OptionGroup: description: Use the `AWS::RDS::OptionGroup` resource to create an option group that can make managing data and databases easier. For more information about option groups, see [Working with Option Groups](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithOptionGroups.html) in the _Amazon Relational Database Service User Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html properties: EngineName: description: |+ The name of the database engine that this option group is associated with. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement MajorEngineVersion: description: |+ The major version number of the database engine that this option group is associated with. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement OptionGroupDescription: description: |+ A description of the option group. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement OptionConfigurations: description: |+ The configurations for this option group. _Required:_ Yes _Type_: List of [Amazon RDS OptionGroup OptionConfiguration](aws-properties-rds-optiongroup-optionconfigurations.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: List update_requires: replacement Tags: description: |+ An arbitrary set of tags (key–value pairs) for this option group. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For example: Copy{ "Ref": "myOptionGroup" } For the `myOptionGroup` resource, `Ref` returns the name of the option group. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Redshift::Cluster: description: Use the `AWS::Redshift::Cluster` resource to create an Amazon Redshift cluster. A _cluster_ is a fully managed data warehouse that consists of a set of compute nodes. For more information about default and valid values, see [CreateCluster](http://docs.aws.amazon.com/redshift/latest/APIReference/API_CreateCluster.html) in the _Amazon Redshift API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html properties: AllowVersionUpgrade: description: |+ When a new version of Amazon Redshift is released, tells whether upgrades can be applied to the engine that is running on the cluster. The upgrades are applied during the maintenance window. The default value is `true`. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption AutomatedSnapshotRetentionPeriod: description: |+ The number of days that automated snapshots are retained. The default value is `1`. To disable automated snapshots, set the value to `0`. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption AvailabilityZone: description: |+ The Amazon Elastic Compute Cloud (Amazon EC2) Availability Zone in which you want to provision your Amazon Redshift cluster. For example, if you have several EC2 instances running in a specific Availability Zone, you might want the cluster to be provisioned in the same zone to decrease network latency. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement ClusterParameterGroupName: description: |+ The name of the parameter group that you want to associate with this cluster. _Required:_ No _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'no' type: String update_requires: some_interruptions ClusterSecurityGroups: description: |+ A list of security groups that you want to associate with this cluster. Applies to EC2-Classic. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption ClusterSubnetGroupName: description: |+ The name of a cluster subnet group that you want to associate with this cluster. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement ClusterType: description: |+ The type of cluster. Specify `single-node` or `multi-node` (default). _Required:_ Yes _Type_: String _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: 'yes' type: String update_requires: some_interruptions ClusterVersion: description: |+ The version of the Amazon Redshift engine that you want to deploy on the cluster. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption DBName: description: |+ The name of the first database that will be created when the cluster is created. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement ElasticIp: description: |+ The Elastic IP (EIP) address for the cluster. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Encrypted: description: |+ Indicates whether the data in the cluster is encrypted at rest. The default value is `false`. _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement HsmClientCertificateIdentifier: description: |+ Specifies the name of the hardware security module (HSM) client certificate that the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption HsmConfigurationIdentifier: description: |+ The name of the HSM configuration that contains the information that the Amazon Redshift cluster can use to retrieve and store keys in an HSM. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption IamRoles: description: |+ A list of AWS Identity and Access Management (IAM) roles that the cluster can use to access other AWS services. Supply the IAM roles by their Amazon Resource Name (ARN). You can provide a maximum of 10 IAM roles in a single request. A cluster can have a maximum of 10 IAM roles associated with it at a time. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption KmsKeyId: description: |+ The ID of the AWS Key Management Service (AWS KMS) key that you want to use to encrypt data in the cluster. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement LoggingProperties: description: |+ Configures Amazon Redshift to create audit log files, containing logging information such as queries and connection attempts, for this cluster. _Required:_ No _Type_: [Amazon Redshift LoggingProperties](aws-properties-redshift-cluster-loggingproperties.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon Redshift LoggingProperties update_requires: no_interruption MasterUsername: description: |+ The user name that is associated with the master user account for this cluster. You must specify values for `MasterUserName` and `MasterUserPassword`. However, if you're restoring from an Amazon Redshift snapshot, AWS CloudFormation ignores the specified values and uses the values that are stored in the snapshot. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement MasterUserPassword: description: |+ The password associated with the master user account for this cluster. You must specify values for `MasterUserName` and `MasterUserPassword`. However, if you're restoring from an Amazon Redshift snapshot, AWS CloudFormation ignores the specified values and uses the values that are stored in the snapshot. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption NodeType: description: |+ The node type that is provisioned for this cluster. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption NumberOfNodes: description: |+ The number of compute nodes in the cluster. If you specify `multi-node` for the `ClusterType` parameter, you must specify a number greater than `1`. Important You can't specify this parameter for a single-node cluster. _Required:_ Conditional _Type_: Integer _Update requires_: [Some interruptions](using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) required: conditional type: Number update_requires: some_interruptions OwnerAccount: description: |+ When you restore from a snapshot from another AWS account, the 12-digit AWS account ID that contains that snapshot. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Port: description: |+ The port number on which the cluster accepts incoming connections. The default value is `5439`. _Required:_ No _Type_: Integer _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Number update_requires: replacement PreferredMaintenanceWindow: description: |+ The weekly time range (in UTC) during which automated cluster maintenance can occur. The format of the time range is `ddd:hh24:mi-ddd:hh24:mi`. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption PubliclyAccessible: description: |+ Indicates whether the cluster can be accessed from a public network. _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement SnapshotClusterIdentifier: description: |+ The name of the cluster that the source snapshot was created from. For more information about restoring from a snapshot, see the [RestoreFromClusterSnapshot](http://docs.aws.amazon.com/redshift/latest/APIReference/API_RestoreFromClusterSnapshot.html) action in the _Amazon Redshift API Reference_. _Required:_ No _Required:_ Conditional. This property is required if your IAM policy includes a restriction on the cluster name and the resource element specifies anything other than the wildcard character (`*`) for the cluster name. _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: update_requires: replacement SnapshotIdentifier: description: |+ The name of the snapshot from which to create a new cluster. _Required:_ Conditional. If you specified the `SnapshotClusterIdentifier` property, you must specify this property. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement Tags: description: |+ Specifies an arbitrary set of tags (key–value pairs) to associate with this cluster. Use tags to manage your resources. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption VpcSecurityGroupIds: description: |+ A list of VPC security groups that are associated with this cluster. _Required:_ No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For example: Copy{ "Ref": "myCluster" } For the Amazon Redshift cluster `myCluster`, `Ref` returns the name of the cluster. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Endpoint.Address: description: |+ The connection endpoint for the Amazon Redshift cluster. For example: `examplecluster.cg034hpkmmjt.us-east-1.redshift.amazonaws.com` . Endpoint.Port: description: |+ The port number on which the Amazon Redshift cluster accepts connections. For example: `5439`. examples: {} AWS::Redshift::ClusterParameterGroup: description: Creates an Amazon Redshift parameter group that you can associate with an Amazon Redshift cluster. The parameters in the group apply to all the databases that you create in the cluster. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html properties: Description: description: |+ A description of the parameter group. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement ParameterGroupFamily: description: |+ The Amazon Redshift engine version that applies to this cluster parameter group. The cluster engine version determines the set of parameters that you can specify in the `Parameters` property. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Parameters: description: |+ A list of parameter names and values that are allowed by the Amazon Redshift engine version that you specified in the `ParameterGroupFamily` property. For more information, see [Amazon Redshift Parameter Groups](http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) in the _Amazon Redshift Cluster Management Guide_. _Required:_ No _Type_: [Amazon Redshift Parameter Type](aws-property-redshift-clusterparametergroup-parameter.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- Amazon Redshift Parameter Type update_requires: no_interruption Tags: description: |+ Specifies an arbitrary set of tags (key–value pairs) to associate with this parameter group. Use tags to manage your resources. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For example: Copy{ "Ref": "myClusterParameterGroup" } For the Amazon Redshift cluster parameter group `myClusterParameterGroup`, `Ref` returns the name of the cluster parameter group. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Redshift::ClusterSecurityGroup: description: Creates an Amazon Redshift security group. You use security groups to control access to Amazon Redshift clusters that are not in a VPC. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroup.html properties: Description: description: |+ A description of the security group. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Tags: description: |+ Specifies an arbitrary set of tags (key–value pairs) to associate with this security group. Use tags to manage your resources. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For example: Copy{ "Ref": "myClusterSecurityGroup" } For the Amazon Redshift cluster security group `myClusterSecurityGroup`, `Ref` returns the name of the cluster security group. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Redshift::ClusterSecurityGroupIngress: description: Specifies inbound (ingress) rules for an Amazon Redshift security group. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroupingress.html properties: ClusterSecurityGroupName: description: |+ The name of the Amazon Redshift security group that will be associated with the ingress rule. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement CIDRIP: description: |+ The IP address range that has inbound access to the Amazon Redshift security group. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement EC2SecurityGroupName: description: |+ The Amazon EC2 security group that will be added the Amazon Redshift security group. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement EC2SecurityGroupOwnerId: description: |+ The 12-digit AWS account number of the owner of the Amazon EC2 security group that is specified by the `EC2SecurityGroupName` parameter. _Required:_ Conditional. If you specify the `EC2SecurityGroupName` property, you must specify this property. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement return_values: Ref: description: '' examples: {} AWS::Redshift::ClusterSubnetGroup: description: Creates an Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon VPC when creating an Amazon Redshift subnet group. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersubnetgroup.html properties: Description: description: |+ A description of the subnet group. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption SubnetIds: description: |+ A list of VPC subnet IDs. You can modify a maximum of 20 subnets. _Required:_ Yes _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: List update_requires: no_interruption Tags: description: |+ Specifies an arbitrary set of tags (key–value pairs) to associate with this subnet group. Use tags to manage your resources. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For example: Copy{ "Ref": "myClusterSubnetGroup" } For the Amazon Redshift cluster subnet group `myClusterSubnetGroup`, `Ref` returns the name of the cluster subnet group. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Route53::HealthCheck: description: Use the `AWS::Route53::HealthCheck` resource to check the health of your resources before Amazon Route 53 responds to a DNS query. For more information, see [How Health Checks Work in Simple Amazon Route 53 Configurations](http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-simple-configs.html) in the _Amazon Route 53 Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html properties: HealthCheckConfig: description: |+ An Amazon Route 53 health check. _Required:_ Yes _Type_: [Amazon Route 53 HealthCheckConfig](aws-properties-route53-healthcheck-healthcheckconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: |- Amazon Route 53 HealthCheckConfig update_requires: no_interruption HealthCheckTags: description: |+ An arbitrary set of tags (key–value pairs) for this health check. _Required:_ No _Type_: A list of [Amazon Route 53 HealthCheckTags](aws-properties-route53-healthcheck-healthchecktags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- A list of Amazon Route 53 HealthCheckTags update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the health check ID, such as `e0a123b4-4dba-4650-935e-example`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::Route53::HostedZone: description: The `AWS::Route53::HostedZone` resource creates a hosted zone, which can contain a collection of record sets for a domain. You cannot create a hosted zone for a top-level domain (TLD). For more information, see [POST CreateHostedZone](http://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateHostedZone.html) or [POST CreateHostedZone (Private)](http://docs.aws.amazon.com/Route53/latest/APIReference/API-create-hosted-zone-private.html) in the _Amazon Route 53 API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html properties: HostedZoneConfig: description: |+ A complex type that contains an optional comment about your hosted zone. _Required:_ No _Type_: [Amazon Route 53 HostedZoneConfig Property](aws-properties-route53-hostedzone-hostedzoneconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- Amazon Route 53 HostedZoneConfig Property update_requires: no_interruption HostedZoneTags: description: |+ An arbitrary set of tags (key–value pairs) for this hosted zone. _Required:_ No _Type_: List of [Amazon Route 53 HostedZoneTags](aws-properties-route53-hostedzone-hostedzonetags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Name: description: |+ The name of the domain. For resource record types that include a domain name, specify a fully qualified domain name. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement QueryLoggingConfig: description: |+ The configuration for DNS query logging. _Required:_ No _Type_: [Amazon Route 53 QueryLoggingConfig](aws-properties-route53-hostedzone-queryloggingconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon Route 53 QueryLoggingConfig update_requires: no_interruption VPCs: description: |+ One or more VPCs that you want to associate with this hosted zone. When you specify this property, AWS CloudFormation creates a private hosted zone. _Required:_ No _Type_: List of [Amazon Route 53 HostedZoneVPCs](aws-resource-route53-hostedzone-hostedzonevpcs.html) If this property was specified previously and you're modifying values, updates require [no interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt). If this property wasn't specified and you add values, updates require [replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement). Also, if this property was specified and you remove all values, updates require [replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement). required: 'no' type: List update_requires: return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For example: Copy{ "Ref": "myHostedZone" } `Ref` returns the hosted zone ID, such as `Z23ABC4XYZL05B`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). NameServers: description: |+ Returns the set of name servers for the specific hosted zone. For example: `ns1.example.com`. This attribute is not supported for private hosted zones. examples: {} AWS::Route53::RecordSet: description: |- The `AWS::Route53::RecordSet` type can be used as a standalone resource or as an embedded property in the [AWS::Route53::RecordSetGroup](aws-properties-route53-recordsetgroup.html) type. Note that some `AWS::Route53::RecordSet` properties are valid only when used within `AWS::Route53::RecordSetGroup`. For more information about constraints and values for each property, see [POST CreateHostedZone](http://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateHostedZone.html) for hosted zones and [POST ChangeResourceRecordSet](http://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html) for resource record sets. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html properties: AliasTarget: description: |+ _Alias resource record sets only:_ Information about the domain to which you are redirecting traffic. If you specify this property, do not specify the `TTL` property. The alias uses a TTL value from the alias target record. For more information about alias resource record sets, see [Creating Alias Resource Record Sets](http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/CreatingAliasRRSets.html) in the _Amazon Route 53 Developer Guide_ and [POST ChangeResourceRecordSets](http://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html#API_ChangeResourceRecordSets_RequestAliasSyntax) in the Amazon Route 53 API reference. _Required:_ Conditional. Required if you are creating an alias resource record set. _Type_: [AliasTarget](aws-properties-route53-aliastarget.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: AliasTarget update_requires: no_interruption Comment: description: |+ Any comments that you want to include about the hosted zone. Important If the record set is part of a record set group, this property isn't valid. Don't specify this property. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Failover: description: |+ Designates the record set as a `PRIMARY` or `SECONDARY` failover record set. When you have more than one resource performing the same function, you can configure Amazon Route 53 to check the health of your resources and use only health resources to respond to DNS queries. You cannot create nonfailover resource record sets that have the same `Name` and `Type` property values as failover resource record sets. For more information, see the [Failover](http://docs.aws.amazon.com/Route53/latest/APIReference/API_ResourceRecordSet.html#Route53-Type-ResourceRecordSet-Failover) content in the _Amazon Route 53 API Reference_. If you specify this property, you must specify the `SetIdentifier` property. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption GeoLocation: description: |+ Describes how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. This property is not compatible with the `Region` property. _Required:_ No _Type_: [Amazon Route 53 Record Set GeoLocation Property](aws-properties-route53-recordset-geolocation.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- Amazon Route 53 Record Set GeoLocation Property update_requires: no_interruption HealthCheckId: description: |+ The health check ID that you want to apply to this record set. Amazon Route 53 returns this resource record set in response to a DNS query only while record set is healthy. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption HostedZoneId: description: |+ The ID of the hosted zone. _Required:_ Conditional. You must specify either the `HostedZoneName` or `HostedZoneId`, but you cannot specify both. If this record set is part of a record set group, do not specify this property. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement HostedZoneName: description: |+ The name of the domain for the hosted zone where you want to add the record set. When you create a stack using an `AWS::Route53::RecordSet` that specifies `HostedZoneName`, AWS CloudFormation attempts to find a hosted zone whose name matches the `HostedZoneName`. If AWS CloudFormation cannot find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack. If you have multiple hosted zones with the same domain name, you must explicitly specify the hosted zone using `HostedZoneId`. _Required:_ Conditional. You must specify either the `HostedZoneName` or `HostedZoneId`, but you cannot specify both. If this record set is part of a record set group, do not specify this property. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement Name: description: |+ The name of the domain. You must specify a fully qualified domain name that ends with a period as the last label indication. If you omit the final period, Amazon Route 53 adds it. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Region: description: "Latency resource record sets only: The Amazon EC2 region where the resource that is specified in this resource record set resides. The resource typically is an AWS resource, for example, Amazon EC2 instance or an Elastic Load Balancing load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.\n\nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Amazon Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 region. Amazon Route 53 then returns the value that is associated with the selected resource record set.\n\nThe following restrictions must be followed:\n\n- \n\nYou can only specify one resource record per latency resource record set.\n\n- \n\nYou can only create one latency resource record set for each Amazon EC2 region.\n\n- \n\nYou are not required to create latency resource record sets for all Amazon EC2 regions. Amazon Route 53 will choose the region with the best latency from among the regions for which you create latency resource record sets.\n\n- \n\nYou cannot create both weighted and latency resource record sets that have the same values for the Name and Type elements.\n\n- \n\nThis property is not compatible with the `GeoLocation` property.\n\nTo see a list of regions by service, see [Regions and Endpoints](http://docs.aws.amazon.com/general/latest/gr/rande.html) in the _AWS General Reference_.\n\n" required: type: update_requires: ResourceRecords: description: |+ List of resource records to add. Each record should be in the format appropriate for the record type specified by the `Type` property. For information about different record types and their record formats, see [Values for Basic Resource Record Sets](http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resource-record-sets-values-basic.html) and [Appendix: Domain Name Format](http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html) in the _Amazon Route 53 Developer Guide_. _Required:_ Conditional. If you don't specify the `AliasTarget` property, you must specify this property. If you are creating an alias resource record set, do not specify this property. _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: List update_requires: no_interruption SetIdentifier: description: |+ A unique identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type. _Required:_ Conditional. Required if you are creating a weighted, latency, failover, or geolocation resource record set. For more information, see the [SetIdentifier](http://docs.aws.amazon.com/Route53/latest/APIReference/API_ResourceRecordSet.html#Route53-Type-ResourceRecordSet-SetIdentifier) content in the _Amazon Route 53 Developer Guide_. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption TTL: description: |+ The resource record cache time to live (TTL), in seconds. If you specify this property, do not specify the `AliasTarget` property. For alias target records, the alias uses a TTL value from the target. If you specify this property, you must specify the `ResourceRecords` property. _Required:_ Conditional. If you don't specify the `AliasTarget` property, you must specify this property. If you are creating an alias resource record set, do not specify this property. _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: String update_requires: no_interruption Type: description: |+ The type of records to add. For valid values, see the [Type](http://docs.aws.amazon.com/Route53/latest/APIReference/API_ResourceRecordSet.html#Route53-Type-ResourceRecordSet-Type) content in the _Amazon Route 53 API Reference_. In AWS CloudFormation, you cannot modify the NS and SOA records for a hosted zone created automatically by Amazon Route 53. Specifically, you can't create or delete NS or SOA records for the root domain of your hosted zone, but you can create them for subdomains to delegate. For example, for hosted zone `mydomain.net`, you cannot create an NS record for `mydomain.net` but you can create an NS record for `nnnn.mydomain.net` for delegation. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Weight: description: |+ _Weighted resource record sets only:_ Among resource record sets that have the same combination of DNS name and type, a value that determines what portion of traffic for the current resource record set is routed to the associated location. For more information about weighted resource record sets, see [Setting Up Weighted Resource Record Sets](http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/WeightedResourceRecordSets.html) in the _Amazon Route 53 Developer Guide_. _Required:_ Conditional. Required if you are creating a weighted resource record set. _Type_: Number. Weight expects integer values. _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: conditional type: Number. Weight expects integer values. update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::Route53::RecordSetGroup: description: The `AWS::Route53::RecordSetGroup` resource creates record sets for a hosted zone. For more information about constraints and values for each property, see [POST CreateHostedZone](http://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateHostedZone.html) for hosted zones and [POST ChangeResourceRecordSet](http://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html) for resource record sets. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordsetgroup.html properties: Comment: description: |+ Any comments you want to include about the hosted zone. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption HostedZoneId: description: |+ The ID of the hosted zone. _Required_: Conditional: You must specify either the `HostedZoneName` or `HostedZoneId`, but you cannot specify both. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement HostedZoneName: description: |+ The name of the domain for the hosted zone where you want to add the record set. When you create a stack using an `AWS::Route53::RecordSet` that specifies `HostedZoneName`, AWS CloudFormation attempts to find a hosted zone whose name matches the `HostedZoneName`. If AWS CloudFormation cannot find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack. If you have multiple hosted zones with the same domain name, you must explicitly specify the hosted zone using `HostedZoneId`. _Required_: Conditional. You must specify either the `HostedZoneName` or `HostedZoneId`, but you cannot specify both. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement RecordSets: description: |+ List of resource record sets to add. The maximum number of records is 1,000. _Required:_ Yes _Type_:: List of [AWS::Route53::RecordSet](aws-properties-route53-recordset.html) objects, as shown in the following example: Copy"RecordSets" : [ { "Name" : "mysite.example.com.", "Type" : "CNAME", "TTL" : "900", "SetIdentifier" : "Frontend One", "Weight" : "4", "ResourceRecords" : ["example-ec2.amazonaws.com"] }, { "Name" : "mysite.example.com.", "Type" : "CNAME", "TTL" : "900", "SetIdentifier" : "Frontend Two", "Weight" : "6", "ResourceRecords" : ["example-ec2-larger.amazonaws.com"] } ] _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: List update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::S3::Bucket: description: |- The `AWS::S3::Bucket` resource creates an Amazon Simple Storage Service (Amazon S3) bucket in the same AWS Region where you create the AWS CloudFormation stack. To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. For Amazon S3 buckets, you can choose to _retain_ the bucket or to _delete_ the bucket. For more information, see [DeletionPolicy Attribute](aws-attribute-deletionpolicy.html). Important You can delete only empty buckets. Deletion fails for buckets that have contents. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html properties: AccessControl: description: |+ A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACLs in the Amazon S3 documentation](http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the _Amazon Simple Storage Service Developer Guide_. _Required:_ No _Type_: String _Valid values_: `AuthenticatedRead` | `AwsExecRead` | `BucketOwnerRead` | `BucketOwnerFullControl` | `LogDeliveryWrite` | `Private` | `PublicRead` | `PublicReadWrite` _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption AccelerateConfiguration: description: |+ Configuration for the transfer acceleration state. For more information, see [Amazon S3 Transfer Acceleration](http://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the _Amazon Simple Storage Service Developer Guide_. _Required:_ No _Type_: [Amazon S3 Bucket AccelerateConfiguration](aws-properties-s3-bucket-accelerateconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon S3 Bucket AccelerateConfiguration update_requires: no_interruption AnalyticsConfigurations: description: |+ The configuration and any analyses for the analytics filter of an Amazon S3 bucket. Duplicates not allowed. _Required_: No _Type_: List of [Amazon S3 Bucket AnalyticsConfiguration](aws-properties-s3-bucket-analyticsconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption BucketName: description: |+ A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. For more information, see [Name Type](aws-properties-name.html). The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement CorsConfiguration: description: |+ Rules that define cross-origin resource sharing of objects in this bucket. For more information, see [Enabling Cross-Origin Resource Sharing](http://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the _Amazon Simple Storage Service Developer Guide_. _Required:_ No _Type_: [Amazon S3 Bucket CorsConfiguration](aws-properties-s3-bucket-cors.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon S3 Bucket CorsConfiguration update_requires: no_interruption InventoryConfigurations: description: |+ The inventory configuration for an Amazon S3 bucket. Duplicates not allowed. _Required_: No _Type_: List of [Amazon S3 Bucket InventoryConfiguration](aws-properties-s3-bucket-inventoryconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption LifecycleConfiguration: description: |+ Rules that define how Amazon S3 manages objects during their lifetime. For more information, see [Object Lifecycle Management](http://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the _Amazon Simple Storage Service Developer Guide_. _Required:_ No _Type_: [Amazon S3 Bucket LifecycleConfiguration](aws-properties-s3-bucket-lifecycleconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon S3 Bucket LifecycleConfiguration update_requires: no_interruption LoggingConfiguration: description: |+ Settings that define where logs are stored. _Required:_ No _Type_: [Amazon S3 Bucket LoggingConfiguration](aws-properties-s3-bucket-loggingconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon S3 Bucket LoggingConfiguration update_requires: no_interruption MetricsConfigurations: description: |+ Settings that define a metrics configuration for the CloudWatch request metrics from the bucket. _Required_: No _Type_: List of [Amazon S3 Bucket MetricsConfiguration](aws-properties-s3-bucket-metricsconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) Duplicates not allowed. required: 'no' type: List update_requires: no_interruption NotificationConfiguration: description: |+ Configuration that defines how Amazon S3 handles bucket notifications. _Required:_ No _Type_: [Amazon S3 Bucket NotificationConfiguration](aws-properties-s3-bucket-notificationconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon S3 Bucket NotificationConfiguration update_requires: no_interruption ReplicationConfiguration: description: |+ Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the `VersioningConfiguration` property. Amazon S3 can store replicated objects in only one destination (S3 bucket). The destination bucket must already exist and be in a different AWS Region than your source bucket. _Required:_ No _Type_: [Amazon S3 Bucket ReplicationConfiguration](aws-properties-s3-bucket-replicationconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon S3 Bucket ReplicationConfiguration update_requires: no_interruption Tags: description: |+ An arbitrary set of tags (key-value pairs) for this S3 bucket. Important We recommend limiting the number of tags to seven. Applying more than seven tags prevents the AWS CLI and the AWS CloudFormation console and API actions from listing the tags for the S3 bucket. _Required:_ No _Type_: [AWS CloudFormation Resource Tags](aws-properties-resource-tags.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: AWS CloudFormation Resource Tags update_requires: no_interruption VersioningConfiguration: description: |+ Enables multiple variants of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them. _Required:_ No _Type_: [Amazon S3 Bucket VersioningConfiguration](aws-properties-s3-bucket-versioningconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon S3 Bucket VersioningConfiguration update_requires: no_interruption WebsiteConfiguration: description: |+ Information used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](http://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). _Required:_ No _Type_: [Website Configuration Type](aws-properties-s3-websiteconfiguration.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: |- Website Configuration Type update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. Example: `mystack-mybucket-kdwwxmddtr2g`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ Returns the Amazon Resource Name (ARN) of the specified bucket. Example: `arn:aws:s3:::mybucket` DomainName: description: |+ Returns the IPv4 DNS name of the specified bucket. Example: `mystack-mybucket-kdwwxmddtr2g.s3.amazonaws.com` DualStackDomainName: description: |+ Returns the IPv6 DNS name of the specified bucket. Example:` mystack-mybucket-kdwwxmddtr2g.s3.dualstack.``us-east-2``.amazonaws.com/` For more information about dual-stack endpoints, see [Using Amazon S3 Dual-Stack Endpoints](https://docs.aws.amazon.com/AmazonS3/latest/dev/dual-stack-endpoints.html). WebsiteURL: description: |+ Returns the Amazon S3 website endpoint for the specified bucket. Example (IPv4): `http://mystack-mybucket-kdwwxmddtr2g.s3-website-``us-east-2``.amazonaws.com/` Example (IPv6): `http://mystack-mybucket-kdwwxmddtr2g.s3.dualstack.``us-east-2``.amazonaws.com/` examples: {} AWS::S3::BucketPolicy: description: |- The AWS::S3::BucketPolicy type applies an Amazon S3 bucket policy to an Amazon S3 bucket. AWS::S3::BucketPolicy Snippet: [Declaring an Amazon S3 Bucket Policy](quickref-iam.html#scenario-bucket-policy) url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html properties: Bucket: description: |+ The Amazon S3 bucket that the policy applies to. _Required:_ Yes _Type_: String You cannot update this property. If you want to add or remove a bucket from a bucket policy, you must modify your AWS CloudFormation template by creating a new bucket policy resource and removing the old one. Then use the modified template to update your AWS CloudFormation stack. required: 'yes' type: String update_requires: PolicyDocument: description: |+ A policy document containing permissions to add to the specified bucket. For more information, see [Access Policy Language Overview](http://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the _Amazon Simple Storage Service Developer Guide_. _Required:_ Yes _Type_: JSON object _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: JSON update_requires: no_interruption return_values: Ref: description: "The following sample is a bucket policy that is attached to the `myExampleBucket` bucket and allows GET requests that originate from `www.example.com` and `example.com`:\n\n#### JSON\n\n Copy\"SampleBucketPolicy\" : {\n \"Type\" : \"AWS::S3::BucketPolicy\",\n \"Properties\" : {\n \"Bucket\" : {\"Ref\" : \"myExampleBucket\"},\n \"PolicyDocument\": {\n \"Statement\":[{\n \t \"Action\":[\"s3:GetObject\"],\n \ \t \"Effect\":\"Allow\",\n \t \"Resource\": { \"Fn::Join\" : [\"\", [\"arn:aws:s3:::\", { \"Ref\" : \"myExampleBucket\" } , \"/*\"]]},\n \ \t \"Principal\":\"*\",\n \"Condition\":{\n \"StringLike\":{\n \ \"aws:Referer\":[\n \"http://www.example.com/*\",\n \ \"http://example.com/*\"\n ]\n }\n \ }\n }]\n }\n }\n }\n\n#### YAML\n\n \ CopySampleBucketPolicy: \n Type: \"AWS::S3::BucketPolicy\"\n Properties: \n Bucket: \n Ref: \"myExampleBucket\"\n PolicyDocument: \n Statement: \n - \n Action: \n - \"s3:GetObject\"\n Effect: \"Allow\"\n Resource: \n Fn::Join: \n - \"\"\n - \n - \"arn:aws:s3:::\"\n - \n Ref: \"myExampleBucket\"\n - \"/*\"\n Principal: \"*\"\n Condition: \n StringLike: \n aws:Referer: \n - \"http://www.example.com/*\"\n - \"http://example.com/*\"" examples: {} AWS::SDB::Domain: description: |- Use the `AWS::SDB::Domain` resource to declare an Amazon SimpleDB domain. When you specify `AWS::SDB::Domain` as an argument in a `Ref` function, AWS CloudFormation returns the value of the `DomainName`. Important The `AWS::SDB::Domain` resource does not allow any updates, including metadata updates. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-simpledb.html properties: Description: description: |+ Information about the Amazon SimpleDB domain. _Required:_ No _Type_: String _Update requires_: Updates are not supported. required: 'no' type: String update_requires: return_values: Ref: description: '' examples: {} AWS::ServiceDiscovery::Instance: description: The `AWS::ServiceDiscovery::Instance` resource specifies information about an instance that Amazon Route 53 creates. For more information, see [Instance](http://docs.aws.amazon.com/Route53/latest/APIReference/API_autonaming_Instance.html) in the _Amazon Route 53 API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html properties: InstanceAttributes: description: "A string map that contains attribute keys and values. Supported attribute keys include the following:\n\n- \n\n`AWS_INSTANCE_PORT`: The port on the endpoint that you want Amazon Route 53 to perform health checks on. This value is also used for the port value in an SRV record if the service that you specify includes an SRV record. You can also specify a default port that is applied to all instances in the `Service` configuration. For more information, see [CreateService](http://docs.aws.amazon.com/Route53/latest/APIReference/API_autonaming_CreateService.html) in the _Amazon Route 53 API Reference_.\n\n- \n\n`AWS_INSTANCE_IPV4`: If the service that you specify contains a resource record set template for an A record, the IPv4 address that you want Amazon Route 53 to use for the value of the A record.\n\n- \n\n`AWS_INSTANCE_IPV6`: If the service that you specify contains a resource record set template for an AAAA record, the IPv6 address that you want Amazon Route 53 to use for the value of the AAAA record.\n\n_Required_: Yes\n\n_Type_: JSON object\n\n_Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n\n" required: 'yes' type: JSON update_requires: no_interruption InstanceId: description: "An identifier that you want to associate with the instance. Note the following:\n\n- \n\nYou can use this value to update an existing instance.\n\n- \n\nTo associate a new instance, you must specify a value that is unique among instances that you associate by using the same service.\n\n_Required_: Yes\n\n_Type_: String\n\n_Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement)\n\n" required: 'yes' type: String update_requires: replacement ServiceId: description: |+ The ID of the service that you want to use for settings for the resource record sets and health check that Amazon Route 53 will create. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When you pass the logical ID of an `AWS::ServiceDiscovery::Instance` resource to the intrinsic `Ref` function, the function returns the value of `Id` for the instance. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::ServiceDiscovery::PrivateDnsNamespace: description: The `AWS::ServiceDiscovery::PrivateDnsNamespace` resource specifies information about a private namespace for Amazon Route 53. Use a private namespace when you want to route traffic inside an Amazon VPC. For more information, see [CreatePrivateDnsNamespace](http://docs.aws.amazon.com/Route53/latest/APIReference/API_autonaming_CreatePrivateDnsNamespace.html) in the _Amazon Route 53 API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html properties: Description: description: |+ A description for the namespace. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Vpc: description: |+ The ID of the Amazon VPC that you want to associate the namespace with. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Name: description: |+ The name that you want to assign to this namespace. When you create a namespace, Amazon Route 53 automatically creates a hosted zone that has the same name as the namespace. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When you pass the logical ID of an `AWS::ServiceDiscovery::PrivateDnsNamespace` resource to the intrinsic `Ref` function, the function returns the value of `Id` for the namespace. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Id: description: |+ The ID of the private namespace. Arn: description: |+ The Amazon Resource Name (ARN) of the private namespace. examples: {} AWS::ServiceDiscovery::PublicDnsNamespace: description: The `AWS::ServiceDiscovery::PublicDnsNamespace` resource specifies information about a public namespace for Amazon Route 53. Use a public namespace when you want to route internet traffic to your resources. For more information, see [CreatePublicDnsNamespace](http://docs.aws.amazon.com/Route53/latest/APIReference/API_autonaming_CreatePublicDnsNamespace.html) in the _Amazon Route 53 API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-publicdnsnamespace.html properties: Description: description: |+ A description for the namespace. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Name: description: |+ The name that you want to assign to this namespace. When you create a namespace, Amazon Route 53 automatically creates a hosted zone that has the same name as the namespace. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When you pass the logical ID of an `AWS::ServiceDiscovery::PublicDnsNamespace` resource to the intrinsic `Ref` function, the function returns the value of `Id` for the namespace. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Id: description: |+ The ID of the public namespace. Arn: description: |+ The Amazon Resource Name (ARN) of the public namespace. examples: {} AWS::ServiceDiscovery::Service: description: The `AWS::ServiceDiscovery::Service` resource defines a template for up to five records and an optional health check that you want Amazon Route 53 to create when you register an instance. For more information, see [CreateService](http://docs.aws.amazon.com/Route53/latest/APIReference/API_autonaming_CreateService.html) in the _Amazon Route 53 API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html properties: Description: description: |+ A description for the service. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption DnsConfig: description: |+ A complex type that contains information about the resource record sets that you want Amazon Route 53 to create when you register an instance. _Required_: Yes _Type_: [Amazon Route 53 ServiceDiscovery DnsConfig](aws-properties-servicediscovery-service-dnsconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Amazon Route 53 ServiceDiscovery DnsConfig update_requires: no_interruption HealthCheckConfig: description: |+ A complex type that contains settings for an optional health check. If you specify settings for a health check, Amazon Route 53 associates the health check with all the resource record sets that you specify in `DnsConfig`. _Required_: No _Type_: [Amazon Route 53 ServiceDiscovery HealthCheckConfig](aws-properties-servicediscovery-service-healthcheckconfig.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon Route 53 ServiceDiscovery HealthCheckConfig update_requires: no_interruption Name: description: |+ The name that you want to assign to the service. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When you pass the logical ID of an `AWS::ServiceDiscovery::Service` resource to the intrinsic `Ref` function, the function returns the value of `Id` for the service. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Id: description: |+ The ID of the service. Arn: description: |+ The Amazon Resource Name (ARN) of the service. Name: description: |+ The name that you assigned to the service. examples: {} AWS::SNS::Subscription: description: The `AWS::SNS::Subscription` resource subscribes an endpoint to an Amazon Simple Notification Service (Amazon SNS) topic. The owner of the endpoint must confirm the subscription before Amazon SNS creates the subscription. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html properties: Endpoint: description: |+ The endpoint that receives notifications from the Amazon SNS topic. The endpoint value depends on the protocol that you specify. For more information, see the [Subscribe Endpoint](http://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) parameter in the _Amazon Simple Notification Service API Reference_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Protocol: description: |+ The subscription's protocol. For more information, see the [Subscribe Protocol](http://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) parameter in the _Amazon Simple Notification Service API Reference_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement TopicArn: description: |+ The Amazon Resource Name (ARN) of the topic to subscribe to. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: '' examples: {} AWS::SNS::Topic: description: The `AWS::SNS::Topic` type creates an Amazon Simple Notification Service (Amazon SNS) topic. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html properties: DisplayName: description: |+ A developer-defined string that can be used to identify this SNS topic. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Subscription: description: |+ The SNS subscriptions (endpoints) for this topic. _Required:_ No _Type_: List of [SNS Subscriptions](aws-properties-sns-subscription.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption TopicName: description: |+ A name for the topic. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- For the `AWS::SNS::Topic` resource, the `Ref` intrinsic function returns the topic ARN, for example: `arn:aws:sns:us-east-1:123456789012:mystack-mytopic-NZJ5JSMVGFIE`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). TopicName: description: |+ Returns the name for an Amazon SNS topic. examples: {} AWS::SNS::TopicPolicy: description: The `AWS::SNS::TopicPolicy` resource associates Amazon SNS topics with a policy. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html properties: PolicyDocument: description: |+ A policy document that contains permissions to add to the specified SNS topics. _Required:_ Yes JSON or YAML _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: update_requires: no_interruption Topics: description: |+ The Amazon Resource Names (ARN) of the topics to which you want to add the policy. You can use the [Ref function](intrinsic-function-reference-ref.html) to specify an [AWS::SNS::Topic](aws-properties-sns-topic.html) resource. _Required:_ Yes _Type_: A list of Amazon SNS topics ARNs _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: A list of Amazon SNS topics ARNs update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::SQS::Queue: description: |- The `AWS::SQS::Queue` resource creates an Amazon Simple Queue Service (Amazon SQS) queue. For more information about creating FIFO (first-in-first-out) queues, see the tutorial [Create a queue using AWS CloudFormation](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-create-queue.html#create-queue-cloudformation) in the _Amazon Simple Queue Service Developer Guide_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html properties: ContentBasedDeduplication: description: |+ For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the `ContentBasedDeduplication` attribute for the [CreateQueue](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) action in the _Amazon Simple Queue Service API Reference_. _Required:_ No _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Boolean update_requires: no_interruption DelaySeconds: description: |+ The time in seconds that the delivery of all messages in the queue is delayed. You can specify an integer value of `0` to `900` (15 minutes). The default value is `0`. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption FifoQueue: description: |+ Indicates whether this queue is a FIFO queue. For more information, see [FIFO (First-In-First-Out) Queues](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the _Amazon Simple Queue Service Developer Guide_. _Required:_ No _Type_: Boolean _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: Boolean update_requires: replacement KmsMasterKeyId: description: |+ The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK. To use the AWS managed CMK for Amazon SQS, specify the alias `alias/aws/sqs`. For more information, see [CreateQueue](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the _Amazon Simple Queue Service API Reference_, [Protecting Data Using Server-Side Encryption (SSE) and AWS KMS](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the _Amazon Simple Queue Service Developer Guide_, or **Customer Master Keys** in the [AWS Key Management Service Best Practices](https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption KmsDataKeyReusePeriodSeconds: description: |+ The length of time in seconds that Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). Note A shorter time period provides better security, but results in more calls to AWS KMS, which might incur charges after Free Tier. For more information, see [How Does the Data Key Reuse Period Work?](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the _Amazon Simple Queue Service Developer Guide_. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption MaximumMessageSize: description: |+ The limit of how many bytes that a message can contain before Amazon SQS rejects it. You can specify an integer value from `1024` bytes (1 KiB) to `262144` bytes (256 KiB). The default value is `262144` (256 KiB). _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption MessageRetentionPeriod: description: |+ The number of seconds that Amazon SQS retains a message. You can specify an integer value from `60` seconds (1 minute) to `1209600` seconds (14 days). The default value is `345600` seconds (4 days). _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption QueueName: description: |+ A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the `.fifo` suffix. For more information, see [FIFO (First-In-First-Out) Queues](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the _Amazon Simple Queue Service Developer Guide_. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the queue name. For more information, see [Name Type](aws-properties-name.html). Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement ReceiveMessageWaitTimeSeconds: description: |+ 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, as opposed to returning an empty response if a message isn't yet available. You can specify an integer from `1` to `20`. The short polling is used as the default or when you specify `0` for this property. For more information, see [Amazon SQS Long Poll](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html). _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption RedrivePolicy: description: |+ Specifies an existing dead letter queue to receive messages after the source queue (this queue) fails to process a message a specified number of times. _Required:_ No _Type_: [Amazon SQS RedrivePolicy](aws-properties-sqs-queues-redrivepolicy.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Amazon SQS RedrivePolicy update_requires: no_interruption VisibilityTimeout: description: |+ 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. Values must be from 0 to 43200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds. For more information about Amazon SQS queue visibility timeouts, see [Visibility Timeout](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html) in the _Amazon Simple Queue Service Developer Guide_. _Required:_ No _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: Number update_requires: no_interruption return_values: Ref: description: |- The `AWS::SQS::Queue` type returns the queue URL. For example: `https://sqs.``us-east-2``.amazonaws.com/123456789012/aa4-MyQueue-Z5NOSZO2PZE9`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Arn: description: |+ Returns the Amazon Resource Name (ARN) of the queue. For example: `arn:aws:sqs:``us-east-2``:123456789012:mystack-myqueue-15PG5C2FC1CW8`. QueueName: description: |+ Returns the queue name. For example: `mystack-myqueue-1VF9BKQH5BJVI` examples: {} AWS::SQS::QueuePolicy: description: |- The AWS::SQS::QueuePolicy type applies a policy to Amazon SQS queues. AWS::SQS::QueuePolicy Snippet: [Declaring an Amazon SQS Policy](quickref-iam.html#scenario-sqs-policy) url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html properties: PolicyDocument: description: |+ A policy document that contains the permissions for the specified Amazon SQS queues. For more information about Amazon SQS policies, see [Creating Custom Policies Using the Access Policy Language](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the _Amazon Simple Queue Service Developer Guide_. _Required:_ Yes _Type_: JSON object _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: JSON update_requires: no_interruption Queues: description: |+ The URLs of the queues to which you want to add the policy. You can use the [Ref function](intrinsic-function-reference-ref.html) to specify an [AWS::SQS::Queue](aws-properties-sqs-queues.html) resource. _Required:_ Yes _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: List update_requires: no_interruption return_values: Ref: description: '' examples: {} AWS::SSM::Association: description: The `AWS::SSM::Association` resource associates an Amazon EC2 Systems Manager (SSM) document with EC2 instances that contain a configuration agent to process the document. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html properties: DocumentVersion: description: |+ The version of the SSM document to associate with the target. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption InstanceId: description: |+ The ID of the instance that the SSM document is associated with. _Required:_ Conditional. You must specify the `InstanceId` or `Targets` property. _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: String update_requires: replacement Name: description: |+ The name of the SSM document. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Parameters: description: |+ Parameter values that the SSM document uses at runtime. _Required:_ No _Type_: String to list-of-strings map _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String to list-of-strings map update_requires: no_interruption ScheduleExpression: description: |+ A Cron expression that specifies when the association is applied to the target. For more on working with Cron expressions, see [Working with Cron and Rate Expressions for Systems Manager](http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-cron.html). _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Targets: description: |+ The targets that the SSM document sends commands to. _Required:_ Conditional. You must specify the `InstanceId` or `Targets` property. _Type_: List of [Amazon EC2 Systems Manager Association Targets](aws-properties-ssm-association-targets.html) _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: conditional type: List update_requires: replacement return_values: Ref: description: '' examples: {} AWS::SSM::Document: description: The `AWS::SSM::Document` resource creates an Amazon EC2 Systems Manager (SSM) document that describes an instance configuration, which you can use to set up and run commands on your instances. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html properties: Content: description: |+ A JSON object that describes an instance configuration. For more information, see [Creating SSM Documents](http://docs.aws.amazon.com/AWSEC2/latest/DeveloperGuide/create-ssm-doc.html) in the _Amazon EC2 User Guide for Linux Instances_. Note The `Content` property is a non-stringified property. For more information about automation actions, see [Systems Manager Automation Actions](http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ami-actions.html) in the _Amazon EC2 Systems Manager User Guide_. _Required:_ Yes _Type_: JSON object _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: JSON update_requires: replacement DocumentType: description: |+ The type of document to create that relates to the purpose of your document, such as running commands, bootstrapping software, or automating tasks. For valid values, see the [CreateDocument](http://docs.aws.amazon.com/ssm/latest/APIReference/API_CreateDocument.html) action in the _Amazon EC2 Systems Manager API Reference_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When you pass the logical ID of an `AWS::SSM::Document` resource to the intrinsic `Ref` function, the function returns the SSM document name, such as `ssm-myinstanceconfig-ABCNPH3XCAO6`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::SSM::MaintenanceWindow: description: The `AWS::SSM::MaintenanceWindow` resource represents general information about a Maintenance Window for Amazon EC2 Systems Manager. Maintenance Windows let you define a schedule for when to perform potentially disruptive actions on your instances—such as patching an operating system (OS), updating drivers, or installing software. Each Maintenance Window has a schedule, a duration, a set of registered targets, and a set of registered tasks. For more information, see [Systems Manager Maintenance Windows](http://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-maintenance.html) in the _Amazon EC2 Systems Manager User Guide_ and [CreateMaintenanceWindow](http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateMaintenanceWindow.html) in the _Amazon EC2 Systems Manager API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html properties: Description: description: |+ A description of the Maintenance Window. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption AllowUnassociatedTargets: description: |+ Enables a Maintenance Window task to execute on managed instances, even if you haven't registered those instances as targets. If this is enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the Maintenance Window. _Required_: Yes _Type_: Boolean _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Boolean update_requires: no_interruption Cutoff: description: |+ The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution. _Required_: Yes _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Number update_requires: no_interruption Schedule: description: |+ The schedule of the Maintenance Window in the form of a cron or rate expression. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Duration: description: |+ The duration of the Maintenance Window in hours. _Required_: Yes _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Number update_requires: no_interruption Name: description: |+ The name of the Maintenance Window. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::SSM::MaintenanceWindow` resource to the intrinsic `Ref` function, the function returns the physical ID of the resource, such as `mw-abcde1234567890yz`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::SSM::MaintenanceWindowTarget: description: The `AWS::SSM::MaintenanceWindowTarget` resource registers a target with a Maintenance Window for Amazon EC2 Systems Manager. For more information, see [RegisterTargetWithMaintenanceWindow](http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_RegisterTargetWithMaintenanceWindow.html) in the _Amazon EC2 Systems Manager API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html properties: OwnerInformation: description: |+ A user-provided value to include in any events in CloudWatch Events that are raised while running tasks for these targets in this Maintenance Window. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Description: description: |+ A description for the target. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption WindowId: description: |+ The ID of the Maintenance Window to register the target with. _Required_: Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement ResourceType: description: |+ The type of target that's being registered with the Maintenance Window. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Targets: description: "The targets, either instances or tags.\n\n- \n\nSpecify instances by using `Key=instanceids,Values=instanceid1,instanceid2`.\n\n- \n\nSpecify tags by using `Key=tag name,Values=tag\n value`.\n\n_Required_: Yes\n\n_Type_: List of [SSM MaintenanceWindowTarget Targets](aws-properties-ssm-maintenancewindowtarget-targets.html)\n\n_Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n\n" required: 'yes' type: List update_requires: no_interruption Name: description: |+ An optional name for the target. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::SSM::MaintenanceWindowTarget` resource to the intrinsic `Ref` function, the function returns the physical ID of the resource, such as `12a345b6-bbb7-4bb6-90b0-8c9577a2d2b9`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::SSM::MaintenanceWindowTask: description: The `AWS::SSM::MaintenanceWindowTask` resource defines information about a task for a Maintenance Window for Amazon EC2 Systems Manager. For more information, see [RegisterTaskWithMaintenanceWindow](http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_RegisterTaskWithMaintenanceWindow.html) in the _Amazon EC2 Systems Manager API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html properties: MaxErrors: description: |+ The maximum number of errors allowed before this task stops being scheduled. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Description: description: |+ A description of the task. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption ServiceRoleArn: description: |+ The role that's used when the task is executed. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Priority: description: |+ The priority of the task in the Maintenance Window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel. _Required_: Yes _Type_: Integer _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: Number update_requires: no_interruption MaxConcurrency: description: |+ The maximum number of targets that you can run this task for, in parallel. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Targets: description: "The targets, either instances or tags.\n\n- \n\nSpecify instances using `Key=instanceids,Values=instanceid1,instanceid2`.\n\n- \n\nSpecify tags using `Key=tag\n name,Values=tag value`.\n\n_Required_: Yes\n\n_Type_: List of [SSM MaintenanceWindowTask Target](aws-properties-ssm-maintenancewindowtask-target.html)\n\n_Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)\n\n" required: 'yes' type: List update_requires: no_interruption Name: description: |+ The task name. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption TaskArn: description: |+ The resource that the task uses during execution. For `RUN_COMMAND` and `AUTOMATION` task types, `TaskArn` is the SSM document name or Amazon Resource Name (ARN). For `LAMBDA` tasks, `TaskArn` is the function name or ARN. For `STEP_FUNCTION` tasks, `TaskArn` is the state machine ARN. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption TaskInvocationParameters: description: |+ The parameters for task execution. _Required_: No _Type_: [SSM MaintenanceWindowTask TaskInvocationParameters](aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: SSM MaintenanceWindowTask TaskInvocationParameters update_requires: no_interruption WindowId: description: |+ The ID of the Maintenance Window where the task is registered. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement TaskParameters: description: |+ The parameters to pass to the task when it's executed. _Required_: No _Type_: JSON object _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: JSON update_requires: no_interruption TaskType: description: |+ The type of task. Valid values: `RUN_COMMAND`, `AUTOMATION`, `LAMBDA`, `STEP_FUNCTION`. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption LoggingInfo: description: |+ Information about an Amazon S3 bucket to write task-level logs to. _Required_: No _Type_: [SSM MaintenanceWindowTask LoggingInfo](aws-properties-ssm-maintenancewindowtask-logginginfo.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: SSM MaintenanceWindowTask LoggingInfo update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::SSM::MaintenanceWindowTask` resource to the intrinsic `Ref` function, the function returns the physical ID of the resource, such as `12a345b6-bbb7-4bb6-90b0-8c9577a2d2b9`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::SSM::Parameter: description: The `AWS::SSM::Parameter` resource creates an Amazon EC2 Systems Manager (SSM) parameter in Parameter Store. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html properties: Name: description: |+ The name of the parameter. Names must not be prefixed with `aws` or `ssm`. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement Description: description: |+ Information about the parameter that you want to add to the system. _Required:_ No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption Type: description: |+ The type of parameter. Valid values include the following: `String` or `StringList`. Note AWS CloudFormation doesn't support the `SecureString` parameter type. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption Value: description: |+ The parameter value. Value must not nest another parameter. Do not use `{{}}` in the value. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::SSM::Parameter` resource to the intrinsic `Ref` function, the function returns the Name of the SSM parameter. For example, `ssm-myparameter-ABCNPH3XCAO6`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Type: description: |+ Returns the type of the parameter. Valid values are `String` or `StringList`. Value: description: |+ Returns the value of the parameter. examples: {} AWS::SSM::PatchBaseline: description: The `AWS::SSM::PatchBaseline` resource defines the basic information for an Amazon EC2 Systems Manager patch baseline. A patch baseline defines which patches are approved for installation on your instances. For more information, see [CreatePatchBaseline](http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreatePatchBaseline.html) in the _Amazon EC2 Systems Manager API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html properties: OperatingSystem: description: |+ Defines the operating system that the patch baseline applies to. Supported operating systems include `WINDOWS`, `AMAZON_LINUX`, `UBUNTU`, and `REDHAT_ENTERPRISE_LINUX`. The default value is `WINDOWS`. _Required_: No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement ApprovedPatches: description: |+ A list of explicitly approved patches for the baseline. _Required_: No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption PatchGroups: description: |+ The names of the patch groups to register with the patch baseline. _Required_: No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Description: description: |+ A description of the patch baseline. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption ApprovedPatchesComplianceLevel: description: |+ The compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. Valid compliance severity levels include the following: `CRITICAL`, `HIGH`, `MEDIUM`, `LOW`, `INFORMATIONAL`, and `UNSPECIFIED`. The default value is `UNSPECIFIED`. _Required_: No _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: String update_requires: no_interruption ApprovalRules: description: |+ A set of rules that are used to include patches in the baseline. _Required_: No _Type_: [SSM PatchBaseline RuleGroup](aws-properties-ssm-patchbaseline-rulegroup.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: SSM PatchBaseline RuleGroup update_requires: no_interruption GlobalFilters: description: |+ A set of global filters that are used to exclude patches from the baseline. _Required_: No _Type_: [SSM PatchBaseline PatchFilterGroup](aws-properties-ssm-patchbaseline-patchfiltergroup.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: SSM PatchBaseline PatchFilterGroup update_requires: no_interruption Name: description: |+ The name of the patch baseline. _Required_: Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption RejectedPatches: description: |+ A list of explicitly rejected patches for the baseline. _Required_: No _Type_: List of String values _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When you pass the logical ID of an `AWS::SSM::PatchBaseline` resource to the intrinsic `Ref` function, the function returns the physical ID of the resource, such as `pb-abcde1234567890yz`. Note The ID of the default patch baseline provided by AWS is an ARN—for example `arn:aws:ssm:us-west-2:123456789012:patchbaseline/abcde1234567890yz`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::StepFunctions::Activity: description: |- Use the `AWS::StepFunctions::Activity` resource to create an AWS Step Functions activity. For information about creating an activity and creating a state machine with an activity, see [Tutorial: An Activity State Machine](http://docs.aws.amazon.com/step-functions/latest/dg/activity-tutorial.html) in the _AWS Step Functions Developer Guide_ and `CreateActivity` in the _AWS Step Functions API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html properties: Name: description: |+ The name of the activity to create. This name must be unique for your AWS account and region. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When you provide the logical ID of this resource to the `Ref` intrinsic function, `Ref` returns the ARN of the created activity. For example: Copy{ "Ref": "MyActivity" } Returns a value similar to the following: Copyarn:aws:states:us-east-1:111122223333:activity:myActivity For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Name: description: |+ Returns the name of the activity. For example: Copy{ "Fn::GetAtt": ["MyActivity", "Name"] } Returns a value similar to the following: CopymyActivity examples: {} AWS::StepFunctions::StateMachine: description: |- Use the `AWS::StepFunctions::StateMachine` resource to create an AWS Step Functions state machine. For information about creating state machines, see [Tutorial: A Lambda State Machine](http://docs.aws.amazon.com/step-functions/latest/dg/hello-lambda.html) in the _AWS Step Functions Developer Guide_ and `CreateStateMachine` in the _AWS Step Functions API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html properties: StateMachineName: description: |+ The name of the state machine. If you do not specify a name one will be generated that is similar to `MyStateMachine-1234abcdefgh`. For more information on creating a valid name see [Request Parameters](http://docs.aws.amazon.com/step-functions/latest/apireference/API_CreateStateMachine.html#API_CreateStateMachine_RequestSyntax) in the _AWS Step Functions API Reference_. _Required:_ No _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'no' type: String update_requires: replacement DefinitionString: description: |+ The Amazon States Language definition of the state machine. For more information, see [Amazon States Language](http://docs.aws.amazon.com/step-functions/latest/dg/concepts-awl.html) in the _AWS Step Functions Developer Guide_. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption RoleArn: description: |+ The Amazon Resource Name (ARN) of the IAM role to use for this state machine. _Required:_ Yes _Type_: String _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: String update_requires: no_interruption return_values: Ref: description: |- When you provide the logical ID of this resource to the `Ref` intrinsic function, `Ref` returns the ARN of the created state machine. For example: Copy{ "Ref": "MyStateMachine" } Returns a value similar to the following: Copyarn:aws:states:us-east-1:111122223333:stateMachine:HelloWorld-StateMachine For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). Name: description: |+ Returns the name of the state machine. For example: Copy{ "Fn::GetAtt": ["MyStateMachine", "Name"] } Returns the name of your state machine: CopyHelloWorld-StateMachine If you did not specify the name it will be similar to the following: CopyMyStateMachine-1234abcdefgh examples: {} AWS::WAF::ByteMatchSet: description: The `AWS::WAF::ByteMatchSet` resource creates an AWS WAF `ByteMatchSet` that identifies a part of a web request that you want to inspect. For more information, see [CreateByteMatchSet](http://docs.aws.amazon.com/waf/latest/APIReference/API_CreateByteMatchSet.html) in the _AWS WAF API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-bytematchset.html properties: ByteMatchTuples: description: |+ Settings for the `ByteMatchSet`, such as the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests. _Required:_ No _Type_: List of [AWS WAF ByteMatchSet ByteMatchTuples](aws-properties-waf-bytematchset-bytematchtuples.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Name: description: |+ A friendly name or description of the `ByteMatchSet`. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource physical ID, such as `1234a1a-a1b1-12a1-abcd-a123b123456`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::WAF::IPSet: description: The `AWS::WAF::IPSet` resource creates an AWS WAF `IPSet` that specifies which web requests to permit or block based on the IP addresses from which the requests originate. For more information, see [CreateIPSet](http://docs.aws.amazon.com/waf/latest/APIReference/API_CreateIPSet.html) in the _AWS WAF API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-ipset.html properties: IPSetDescriptors: description: |+ The IP address type and IP address range (in CIDR notation) from which web requests originate. If you associate the `IPSet` with a [web ACL](aws-resource-waf-webacl.html) that is associated with a Amazon CloudFront (CloudFront) distribution, this descriptor is the value of one of the following fields in the CloudFront access logs: `c-ip` If the viewer did not use an HTTP proxy or a load balancer to send the request `x-forwarded-for` If the viewer did use an HTTP proxy or a load balancer to send the request _Required:_ No _Type_: List of [AWS WAF IPSet IPSetDescriptors](aws-properties-waf-ipset-ipsetdescriptors.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Name: description: |+ If the viewer did not use an HTTP proxy or a load balancer to send the request required: type: update_requires: return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource physical ID, such as `1234a1a-a1b1-12a1-abcd-a123b123456`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::WAF::Rule: description: |- The `AWS::WAF::Rule` resource creates an AWS WAF rule that specifies a combination of `IPSet`, `ByteMatchSet`, and `SqlInjectionMatchSet` objects that identify the web requests to allow, block, or count. To implement rules, you must associate them with a [web ACL](aws-resource-waf-webacl.html). For more information, see [CreateRule](http://docs.aws.amazon.com/waf/latest/APIReference/API_CreateRule.html) in the _AWS WAF API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-rule.html properties: MetricName: description: |+ A friendly name or description for the metrics of the rule. For valid values, see the `MetricName` parameter for the [`CreateRule`](http://docs.aws.amazon.com/waf/latest/APIReference/API_CreateRule.html) action in the _AWS WAF API Reference_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Name: description: |+ A friendly name or description of the rule. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Predicates: description: |+ The `ByteMatchSet`, `IPSet`, `SizeConstraintSet`, `SqlInjectionMatchSet`, or `XssMatchSet` objects to include in a rule. If you add more than one predicate to a rule, a request must match all conditions in order to be allowed or blocked. _Required:_ No _Type_: List of [AWS WAF Rule Predicates](aws-properties-waf-rule-predicates.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource physical ID, such as `1234a1a-a1b1-12a1-abcd-a123b123456`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::WAF::SizeConstraintSet: description: The `AWS::WAF::SizeConstraintSet` resource specifies a size constraint that AWS WAF uses to check the size of a web request and which parts of the request to check. For more information, see [CreateSizeConstraintSet](http://docs.aws.amazon.com/waf/latest/APIReference/API_CreateSizeConstraintSet.html) in the _AWS WAF API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sizeconstraintset.html properties: Name: description: |+ A friendly name or description for the `SizeConstraintSet`. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement SizeConstraints: description: |+ The size constraint and the part of the web request to check. _Required:_ Yes _Type_: List of [AWS WAF SizeConstraintSet SizeConstraint](aws-properties-waf-sizeconstraintset-sizeconstraint.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource physical ID, such as `1234a1a-a1b1-12a1-abcd-a123b123456`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::WAF::SqlInjectionMatchSet: description: The `AWS::WAF::SqlInjectionMatchSet` resource creates an AWS WAF `SqlInjectionMatchSet`, which you use to allow, block, or count requests that contain malicious SQL code in a specific part of web requests. For more information, see [CreateSqlInjectionMatchSet](http://docs.aws.amazon.com/waf/latest/APIReference/API_CreateSqlInjectionMatchSet.html) in the _AWS WAF API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sqlinjectionmatchset.html properties: Name: description: |+ A friendly name or description of the `SqlInjectionMatchSet`. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement SqlInjectionMatchTuples: description: |+ The parts of web requests that you want AWS WAF to inspect for malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. _Required:_ No _Type_: List of [AWS WAF SqlInjectionMatchSet SqlInjectionMatchTuples](aws-properties-waf-sqlinjectionmatchset-sqlinjectionmatchtuples.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource physical ID, such as `1234a1a-a1b1-12a1-abcd-a123b123456`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::WAF::WebACL: description: The `AWS::WAF::WebACL` resource creates an AWS WAF web access control group (ACL) containing the rules that identify the Amazon CloudFront (CloudFront) web requests that you want to allow, block, or count. For more information, see [CreateWebACL](http://docs.aws.amazon.com/waf/latest/APIReference/API_CreateWebACL.html) in the _AWS WAF API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html properties: DefaultAction: description: |+ The action that you want AWS WAF to take when a request doesn't match the criteria in any of the rules that are associated with the web ACL. _Required:_ Yes _Type_: [AWS WAF WebACL Action](aws-properties-waf-webacl-action.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: AWS WAF WebACL Action update_requires: no_interruption MetricName: description: |+ A friendly name or description for the Amazon CloudWatch metric of this web ACL. For valid values, see the `MetricName` parameter of the [CreateWebACL](http://docs.aws.amazon.com/waf/latest/APIReference/API_CreateWebACL.html) action in the _AWS WAF API Reference_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Name: description: |+ A friendly name or description of the web ACL. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Rules: description: |+ The rules to associate with the web ACL and the settings for each rule. _Required:_ No _Type_: List of [AWS WAF WebACL Rules](aws-properties-waf-webacl-rules.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name, such as `1234a1a-a1b1-12a1-abcd-a123b123456`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::WAF::XssMatchSet: description: The `AWS::WAF::XssMatchSet` resource specifies the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and the name of the header to inspect. For more information, see [XssMatchSet](http://docs.aws.amazon.com/waf/latest/APIReference/API_XssMatchSet.html) in the _AWS WAF API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-xssmatchset.html properties: Name: description: |+ A friendly name or description for the `XssMatchSet`. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement XssMatchTuples: description: |+ The parts of web requests that you want to inspect for cross-site scripting attacks. _Required:_ No _Type_: List of [AWS WAF XssMatchSet XssMatchTuple](aws-properties-waf-xssmatchset-xssmatchtuple.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource physical ID, such as `1234a1a-a1b1-12a1-abcd-a123b123456`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::WAFRegional::ByteMatchSet: description: The `AWS::WAFRegional::ByteMatchSet` resource creates an AWS WAF Regional `ByteMatchSet` that identifies a part of a web request that you want to inspect. For more information, see [CreateByteMatchSet](http://docs.aws.amazon.com/waf/latest/APIReference/API_regional_CreateByteMatchSet.html) in the _AWS WAF Regional API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html properties: ByteMatchTuples: description: |+ Settings for the `ByteMatchSet`, such as the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests. _Required:_ No _Type_: List of [AWS WAF Regional ByteMatchSet ByteMatchTuples](aws-properties-wafregional-bytematchset-bytematchtuples.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Name: description: |+ A friendly name or description of the `ByteMatchSet`. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource physical ID, such as `1234a1a-a1b1-12a1-abcd-a123b123456`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::WAFRegional::IPSet: description: The `AWS::WAFRegional::IPSet` resource creates an AWS WAF Regional `IPSet` that specifies which web requests to permit or block based on the IP addresses from which the requests originate. For more information, see [CreateIPSet](http://docs.aws.amazon.com/waf/latest/APIReference/API_regional_CreateIPSet.html) in the _AWS WAF Regional API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ipset.html properties: IPSetDescriptors: description: |+ The IP address type and IP address range (in CIDR notation) from which web requests originate. If you associate the `IPSet` with a [web ACL](aws-resource-wafregional-webacl.html) that is associated with a Amazon CloudFront (CloudFront) distribution, this descriptor is the value of one of the following fields in the CloudFront access logs: `c-ip` If the viewer did not use an HTTP proxy or a load balancer to send the request `x-forwarded-for` If the viewer did use an HTTP proxy or a load balancer to send the request _Required:_ No _Type_: List of [AWS WAF Regional IPSet IPSetDescriptors](aws-properties-wafregional-ipset-ipsetdescriptors.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption Name: description: |+ If the viewer did not use an HTTP proxy or a load balancer to send the request required: type: update_requires: return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource physical ID, such as `1234a1a-a1b1-12a1-abcd-a123b123456`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::WAFRegional::Rule: description: |- The `AWS::WAFRegional::Rule` resource creates an AWS WAF Regional rule that specifies a combination of `IPSet`, `ByteMatchSet`, and `SqlInjectionMatchSet` objects that identify the web requests to allow, block, or count. To implement rules, you must associate them with a [web ACL](aws-resource-wafregional-webacl.html). For more information, see [CreateRule](http://docs.aws.amazon.com/waf/latest/APIReference/API_regional_CreateRule.html) in the _AWS WAF Regional API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-rule.html properties: MetricName: description: |+ A friendly name or description for the metrics of the rule. For valid values, see the `MetricName` parameter for the [`CreateRule`](http://docs.aws.amazon.com/waf/latest/APIReference/API_regional_CreateRule.html) action in the _AWS WAF Regional API Reference_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Name: description: |+ A friendly name or description of the rule. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Predicates: description: |+ The `ByteMatchSet`, `IPSet`, `SizeConstraintSet`, `SqlInjectionMatchSet`, or `XssMatchSet` objects to include in a rule. If you add more than one predicate to a rule, a request must match all conditions in order to be allowed or blocked. _Required:_ No _Type_: List of [AWS WAF Regional Rule Predicates](aws-properties-wafregional-rule-predicates.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource physical ID, such as `1234a1a-a1b1-12a1-abcd-a123b123456`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::WAFRegional::SizeConstraintSet: description: The `AWS::WAFRegional::SizeConstraintSet` resource specifies a size constraint that AWS WAF uses to check the size of a web request and which parts of the request to check. For more information, see [CreateSizeConstraintSet](http://docs.aws.amazon.com/waf/latest/APIReference/API_regional_CreateSizeConstraintSet.html) in the _AWS WAF Regional API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sizeconstraintset.html properties: Name: description: |+ A friendly name or description for the `SizeConstraintSet`. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement SizeConstraints: description: |+ The size constraint and the part of the web request to check. _Required:_ Yes _Type_: List of [AWS WAF Regional SizeConstraintSet SizeConstraint](aws-properties-wafregional-sizeconstraintset-sizeconstraint.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource physical ID, such as `1234a1a-a1b1-12a1-abcd-a123b123456`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::WAFRegional::SqlInjectionMatchSet: description: The `AWS::WAFRegional::SqlInjectionMatchSet` resource creates an AWS WAF Regional `SqlInjectionMatchSet`, which you use to allow, block, or count requests that contain malicious SQL code in a specific part of web requests. For more information, see [CreateSqlInjectionMatchSet](http://docs.aws.amazon.com/waf/latest/APIReference/API_regional_CreateSqlInjectionMatchSet.html) in the _AWS WAF Regional API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sqlinjectionmatchset.html properties: Name: description: |+ A friendly name or description of the `SqlInjectionMatchSet`. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement SqlInjectionMatchTuples: description: |+ The parts of web requests that you want AWS WAF to inspect for malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. _Required:_ No _Type_: List of [AWS WAF Regional SqlInjectionMatchSet SqlInjectionMatchTuples](aws-properties-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuples.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource physical ID, such as `1234a1a-a1b1-12a1-abcd-a123b123456`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::WAFRegional::WebACL: description: The `AWS::WAFRegional::WebACL` resource creates an AWS WAF Regional web access control group (ACL) containing the rules that identify the Amazon CloudFront (CloudFront) web requests that you want to allow, block, or count. For more information, see [CreateWebACL](http://docs.aws.amazon.com/waf/latest/APIReference/API_regional_CreateWebACL.html) in the _AWS WAF Regional API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html properties: DefaultAction: description: |+ The action that you want AWS WAF to take when a request doesn't match the criteria in any of the rules that are associated with the web ACL. _Required:_ Yes _Type_: [AWS WAF Regional WebACL Action](aws-properties-wafregional-webacl-action.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'yes' type: AWS WAF Regional WebACL Action update_requires: no_interruption MetricName: description: |+ A friendly name or description for the Amazon CloudWatch metric of this web ACL. For valid values, see the `MetricName` parameter of the [CreateWebACL](http://docs.aws.amazon.com/waf/latest/APIReference/API_regional_CreateWebACL.html) action in the _AWS WAF Regional API Reference_. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Name: description: |+ A friendly name or description of the web ACL. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement Rules: description: |+ The rules to associate with the web ACL and the settings for each rule. _Required:_ No _Type_: List of [AWS WAF Regional WebACL Rules](aws-properties-wafregional-webacl-rules.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name, such as `1234a1a-a1b1-12a1-abcd-a123b123456`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::WAFRegional::WebACLAssociation: description: The `AWS::WAFRegional::WebACLAssociation` resource associates an AWS WAF Regional web access control group (ACL) with a resource. For more information, see [AssociateWebACL](http://docs.aws.amazon.com/waf/latest/APIReference/API_regional_AssociateWebACL.html) in the _AWS WAF Regional API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webaclassociation.html properties: ResourceArn: description: |+ The Amazon Resource Name (ARN) of the resource to protect with the web ACL. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement WebACLId: description: |+ A unique identifier (ID) for the web ACL. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement return_values: Ref: description: '' examples: {} AWS::WAFRegional::XssMatchSet: description: The `AWS::WAFRegional::XssMatchSet` resource specifies the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and the name of the header to inspect. For more information, see [XssMatchSet](http://docs.aws.amazon.com/waf/latest/APIReference/API_regional_XssMatchSet.html) in the _AWS WAF Regional API Reference_. url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-xssmatchset.html properties: Name: description: |+ A friendly name or description for the `XssMatchSet`. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement XssMatchTuples: description: |+ The parts of web requests that you want to inspect for cross-site scripting attacks. _Required:_ No _Type_: List of [AWS WAF Regional XssMatchSet XssMatchTuple](aws-properties-wafregional-xssmatchset-xssmatchtuple.html) _Update requires_: [No interruption](using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) required: 'no' type: List update_requires: no_interruption return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource physical ID, such as `1234a1a-a1b1-12a1-abcd-a123b123456`. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {} AWS::WorkSpaces::Workspace: description: The `AWS::WorkSpaces::Workspace` resource creates an Amazon WorkSpaces workspace, which is a cloud-based desktop experience for end users. Before creating a Workspace in CloudFormation, you must register a Directory Service directory with Workspaces. This process is documented at [Register a Directory with Amazon WorkSpaces](http://docs.aws.amazon.com/workspaces/latest/adminguide/register-deregister-directory.html). For more information, see the [_Amazon WorkSpaces Administration Guide_](http://docs.aws.amazon.com/workspaces/latest/adminguide/). url: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html properties: BundleId: description: |+ The identifier of the bundle from which you want to create the workspace. A bundle specifies the details of the workspace, such as the installed applications and the size of CPU, memory, and storage. Use the [DescribeWorkspaceBundles](http://docs.aws.amazon.com/workspaces/latest/devguide/API_DescribeWorkspaceBundles.html) action to list the bundles that AWS offers. _Required:_ Yes _Type_: String _Update requires_: Updates are not supported.. To update this property, you must also update another property that triggers a replacement, such as the `UserName` property. required: 'yes' type: String update_requires: replacement DirectoryId: description: |+ The identifier of the AWS Directory Service directory in which you want to create the workspace. The directory must already be registered with Amazon WorkSpaces. Use the [DescribeWorkspaceDirectories](http://docs.aws.amazon.com/workspaces/latest/devguide/API_DescribeWorkspaceDirectories.html) action to list the directories that are available. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement UserName: description: |+ The name of the user to which the workspace is assigned. This user name must exist in the specified AWS Directory Service directory. _Required:_ Yes _Type_: String _Update requires_: [Replacement](using-cfn-updating-stacks-update-behaviors.html#update-replacement) required: 'yes' type: String update_requires: replacement RootVolumeEncryptionEnabled: description: |+ Indicates whether Amazon WorkSpaces encrypts data stored on the root volume (`C:` drive). _Required:_ No _Type_: Boolean _Update requires_: Updates are not supported.. To update this property, you must also update another property that triggers a replacement, such as the `UserName` property. required: 'no' type: Boolean update_requires: replacement UserVolumeEncryptionEnabled: description: |+ Indicates whether Amazon WorkSpaces encrypts data stored on the user volume (`D:` drive). _Required:_ No _Type_: Boolean _Update requires_: Updates are not supported.. To update this property, you must also update another property that triggers a replacement, such as the `UserName` property. required: 'no' type: Boolean update_requires: replacement VolumeEncryptionKey: description: |+ The AWS Key Management Service (AWS KMS) key ID that Amazon WorkSpaces uses to encrypt data stored on your workspace. _Required:_ No _Type_: String _Update requires_: Updates are not supported.. To update this property, you must also update another property that triggers a replacement, such as the `UserName` property. required: 'no' type: String update_requires: replacement return_values: Ref: description: |- When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource name. For more information about using the `Ref` function, see [Ref](intrinsic-function-reference-ref.html). examples: {}