diff --git a/samtranslator/schema/schema.json b/samtranslator/schema/schema.json index ffa17aeb0..c07d66964 100644 --- a/samtranslator/schema/schema.json +++ b/samtranslator/schema/schema.json @@ -75647,7 +75647,7 @@ "type": "string" }, "EventPattern": { - "markdownDescription": "An event pattern to use to filter events sent to the archive\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An event pattern to use to filter events sent to the archive\\. \n*Required*: No \n*Type*: Json \n*Maximum*: `4096` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventPattern", "type": "object" }, @@ -75729,7 +75729,7 @@ "title": "AuthParameters" }, "AuthorizationType": { - "markdownDescription": "The type of authorization to use for the connection\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `API_KEY | BASIC | OAUTH_CLIENT_CREDENTIALS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of authorization to use for the connection\\. \nOAUTH tokens are refreshed when a 401 or 407 response is returned\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `API_KEY | BASIC | OAUTH_CLIENT_CREDENTIALS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthorizationType", "type": "string" }, @@ -75775,12 +75775,12 @@ "additionalProperties": false, "properties": { "ApiKeyName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the API key to use for authorization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApiKeyName", "type": "string" }, "ApiKeyValue": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value for the API key to use for authorization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApiKeyValue", "type": "string" } @@ -75796,22 +75796,22 @@ "properties": { "ApiKeyAuthParameters": { "$ref": "#/definitions/AWS::Events::Connection.ApiKeyAuthParameters", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ApiKeyAuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The API Key parameters to use for authorization\\. \n*Required*: No \n*Type*: [ApiKeyAuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApiKeyAuthParameters" }, "BasicAuthParameters": { "$ref": "#/definitions/AWS::Events::Connection.BasicAuthParameters", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [BasicAuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The authorization parameters for Basic authorization\\. \n*Required*: No \n*Type*: [BasicAuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BasicAuthParameters" }, "InvocationHttpParameters": { "$ref": "#/definitions/AWS::Events::Connection.ConnectionHttpParameters", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ConnectionHttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint\\. \n*Required*: No \n*Type*: [ConnectionHttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InvocationHttpParameters" }, "OAuthParameters": { "$ref": "#/definitions/AWS::Events::Connection.OAuthParameters", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [OAuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The OAuth parameters to use for authorization\\. \n*Required*: No \n*Type*: [OAuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OAuthParameters" } }, @@ -75821,12 +75821,12 @@ "additionalProperties": false, "properties": { "Password": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The password associated with the user name to use for Basic authorization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Password", "type": "string" }, "Username": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The user name to use for Basic authorization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Username", "type": "string" } @@ -75841,12 +75841,12 @@ "additionalProperties": false, "properties": { "ClientID": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The client ID to use for OAuth authorization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClientID", "type": "string" }, "ClientSecret": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The client secret assciated with the client ID to use for OAuth authorization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClientSecret", "type": "string" } @@ -75891,23 +75891,23 @@ "additionalProperties": false, "properties": { "AuthorizationEndpoint": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The URL to the authorization endpoint when OAuth is specified as the authorization type\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\\x26=+$,A-Za-z0-9])+)([).!';/?:,])?$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthorizationEndpoint", "type": "string" }, "ClientParameters": { "$ref": "#/definitions/AWS::Events::Connection.ClientParameters", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: [ClientParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A `CreateConnectionOAuthClientRequestParameters` object that contains the client parameters for OAuth authorization\\. \n*Required*: Yes \n*Type*: [ClientParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClientParameters" }, "HttpMethod": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The method to use for the authorization request\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `GET | POST | PUT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HttpMethod", "type": "string" }, "OAuthHttpParameters": { "$ref": "#/definitions/AWS::Events::Connection.ConnectionHttpParameters", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ConnectionHttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A `ConnectionHttpParameters` object that contains details about the additional parameters to use for the connection\\. \n*Required*: No \n*Type*: [ConnectionHttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OAuthHttpParameters" } }, @@ -75922,17 +75922,17 @@ "additionalProperties": false, "properties": { "IsValueSecret": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the value is secret\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IsValueSecret", "type": "boolean" }, "Key": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The key for a query string parameter\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[^\\x00-\\x1F\\x7F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, "Value": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value associated with the key for the query string parameter\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Value", "type": "string" } @@ -75979,25 +75979,37 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A description for the endpoint\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "EventBuses": { "items": { "$ref": "#/definitions/AWS::Events::Endpoint.EndpointEventBus" }, + "markdownDescription": "The event buses being used by the endpoint\\. \n*Exactly*: `2` \n*Required*: Yes \n*Type*: List of [EndpointEventBus](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-endpointeventbus.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EventBuses", "type": "array" }, "Name": { + "markdownDescription": "The name of the endpoint\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `[\\.\\-_A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "ReplicationConfig": { - "$ref": "#/definitions/AWS::Events::Endpoint.ReplicationConfig" + "$ref": "#/definitions/AWS::Events::Endpoint.ReplicationConfig", + "markdownDescription": "Whether event replication was enabled or disabled for this endpoint\\. The default state is `ENABLED` which means you must supply a `RoleArn`\\. If you don't have a `RoleArn` or you don't want event replication enabled, set the state to `DISABLED`\\. \n*Required*: No \n*Type*: [ReplicationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-replicationconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReplicationConfig" }, "RoleArn": { + "markdownDescription": "The ARN of the role used by event replication for the endpoint\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^arn:aws[a-z-]*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" }, "RoutingConfig": { - "$ref": "#/definitions/AWS::Events::Endpoint.RoutingConfig" + "$ref": "#/definitions/AWS::Events::Endpoint.RoutingConfig", + "markdownDescription": "The routing configuration of the endpoint\\. \n*Required*: Yes \n*Type*: [RoutingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-routingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoutingConfig" } }, "required": [ @@ -76032,6 +76044,8 @@ "additionalProperties": false, "properties": { "EventBusArn": { + "markdownDescription": "The ARN of the event bus the endpoint is associated with\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^arn:aws[a-z-]*:events:[a-z]{2}-[a-z-]+-\\d+:\\d{12}:event-bus/[\\w.-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EventBusArn", "type": "string" } }, @@ -76044,10 +76058,14 @@ "additionalProperties": false, "properties": { "Primary": { - "$ref": "#/definitions/AWS::Events::Endpoint.Primary" + "$ref": "#/definitions/AWS::Events::Endpoint.Primary", + "markdownDescription": "The main Region of the endpoint\\. \n*Required*: Yes \n*Type*: [Primary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-primary.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Primary" }, "Secondary": { - "$ref": "#/definitions/AWS::Events::Endpoint.Secondary" + "$ref": "#/definitions/AWS::Events::Endpoint.Secondary", + "markdownDescription": "The Region that events are routed to when failover is triggered or event replication is enabled\\. \n*Required*: Yes \n*Type*: [Secondary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-secondary.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Secondary" } }, "required": [ @@ -76060,6 +76078,8 @@ "additionalProperties": false, "properties": { "HealthCheck": { + "markdownDescription": "The ARN of the health check used by the endpoint to determine whether failover is triggered\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1600` \n*Pattern*: `^arn:aws([a-z]|\\-)*:route53:::healthcheck/[\\-a-z0-9]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HealthCheck", "type": "string" } }, @@ -76072,6 +76092,8 @@ "additionalProperties": false, "properties": { "State": { + "markdownDescription": "The state of event replication\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "State", "type": "string" } }, @@ -76084,7 +76106,9 @@ "additionalProperties": false, "properties": { "FailoverConfig": { - "$ref": "#/definitions/AWS::Events::Endpoint.FailoverConfig" + "$ref": "#/definitions/AWS::Events::Endpoint.FailoverConfig", + "markdownDescription": "The failover configuration for an endpoint\\. This includes what triggers failover and what happens when it's triggered\\. \n*Required*: Yes \n*Type*: [FailoverConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-failoverconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FailoverConfig" } }, "required": [ @@ -76096,6 +76120,8 @@ "additionalProperties": false, "properties": { "Route": { + "markdownDescription": "Defines the secondary Region\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `9` \n*Maximum*: `20` \n*Pattern*: `^[\\-a-z0-9]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Route", "type": "string" } }, @@ -76145,7 +76171,7 @@ "type": "string" }, "Name": { - "markdownDescription": "The name of the new event bus\\. \nEvent bus names cannot contain the / character\\. You can't use the name `default` for a custom event bus, as this name is already used for your account's default event bus\\. \nIf this is a partner event bus, the name must exactly match the name of the partner event source that this event bus is matched to\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[/\\.\\-_A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the new event bus\\. \nCustom event bus names can't contain the `/` character, but you can use the `/` character in partner event bus names\\. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to\\. \nYou can't use the name `default` for a custom event bus, as this name is already used for your account's default event bus\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[/\\.\\-_A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -76153,7 +76179,7 @@ "items": { "$ref": "#/definitions/AWS::Events::EventBus.TagEntry" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of [TagEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-tagentry.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Tags to associate with the event bus\\. \n*Required*: No \n*Type*: List of [TagEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-tagentry.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -76188,12 +76214,12 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A string you can use to assign a value\\. The combination of tag keys and values can help you organize and categorize your resources\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, "Value": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value for the specified tag key\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Value", "type": "string" } @@ -76363,7 +76389,7 @@ "type": "string" }, "EventPattern": { - "markdownDescription": "The event pattern of the rule\\. For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide*\\. \n*Required*: Conditional \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The event pattern of the rule\\. For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide*\\. \n*Required*: Conditional \n*Type*: Json \n*Maximum*: `4096` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventPattern", "type": "object" }, @@ -76391,7 +76417,7 @@ "items": { "$ref": "#/definitions/AWS::Events::Rule.Target" }, - "markdownDescription": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule\\. \nTargets are the resources that are invoked when a rule is triggered\\. \nEach rule can have up to five \\(5\\) targets associated with it at one time\\.\nYou can configure the following as targets for Events: \n+ [API destination](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html) \n+ [API Gateway](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-gateway-target.html) \n+ Batch job queue\n+ CloudWatch group\n+ CodeBuild project\n+ CodePipeline\n+ EC2 `CreateSnapshot` API call\n+ EC2 Image Builder\n+ EC2 `RebootInstances` API call\n+ EC2 `StopInstances` API call\n+ EC2 `TerminateInstances` API call\n+ ECS task\n+ [Event bus in a different account or Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cross-account.html) \n+ [Event bus in the same account and Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-bus-to-bus.html) \n+ Firehose delivery stream\n+ Glue workflow\n+ [Incident Manager response plan](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-creation.html#incident-tracking-auto-eventbridge) \n+ Inspector assessment template\n+ Kinesis stream\n+ Lambda function\n+ Redshift cluster\n+ SageMaker Pipeline\n+ SNS topic\n+ SQS queue\n+ Step Functions state machine\n+ Systems Manager Automation\n+ Systems Manager OpsItem\n+ Systems Manager Run Command\nCreating rules with built\\-in targets is supported only in the AWS Management Console\\. The built\\-in targets are `EC2 CreateSnapshot API call`, `EC2 RebootInstances API call`, `EC2 StopInstances API call`, and `EC2 TerminateInstances API call`\\. \nFor some target types, `PutTargets` provides target\\-specific parameters\\. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the `KinesisParameters` argument\\. To invoke a command on multiple EC2 instances with one rule, you can use the `RunCommandParameters` field\\. \nTo be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions\\. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource\\-based policies\\. For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets`\\. For more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the *Amazon EventBridge User Guide*\\. \nIf another AWS account is in the same region and has granted you permission \\(using `PutPermission`\\), you can send events to that account\\. Set that account's event bus as a target of the rules in your account\\. To send the matched events to the other account, specify that account's event bus as the `Arn` value when you run `PutTargets`\\. If your account sends events to another account, your account is charged for each sent event\\. Each event sent to another account is charged as a custom event\\. The account receiving the event is not charged\\. For more information, see [Amazon EventBridge Pricing](http://aws.amazon.com/eventbridge/pricing/)\\. \n `Input`, `InputPath`, and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account\\.\nIf you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure\\. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide*\\. \nFor more information about enabling cross\\-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html)\\. \n **Input**, **InputPath**, and **InputTransformer** are mutually exclusive and optional parameters of a target\\. When a rule is triggered due to a matched event: \n+ If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format \\(unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target\\)\\.\n+ If **Input** is specified in the form of valid JSON, then the matched event is overridden with this constant\\.\n+ If **InputPath** is specified in the form of JSONPath \\(for example, `$.detail`\\), then only the part of the event specified in the path is passed to the target \\(for example, only the detail part of the event is passed\\)\\.\n+ If **InputTransformer** is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target\\.\nWhen you specify `InputPath` or `InputTransformer`, you must use JSON dot notation, not bracket notation\\. \nWhen you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked\\. Allow a short period of time for changes to take effect\\. \nThis action can partially fail if too many requests are made at the same time\\. If that happens, `FailedEntryCount` is non\\-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code\\. \n*Required*: No \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule\\. \nTargets are the resources that are invoked when a rule is triggered\\. \nEach rule can have up to five \\(5\\) targets associated with it at one time\\.\nYou can configure the following as targets for Events: \n+ [API destination](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html) \n+ [API Gateway](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-gateway-target.html) \n+ Batch job queue\n+ CloudWatch group\n+ CodeBuild project\n+ CodePipeline\n+ EC2 `CreateSnapshot` API call\n+ EC2 Image Builder\n+ EC2 `RebootInstances` API call\n+ EC2 `StopInstances` API call\n+ EC2 `TerminateInstances` API call\n+ ECS task\n+ [Event bus in a different account or Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cross-account.html) \n+ [Event bus in the same account and Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-bus-to-bus.html) \n+ Firehose delivery stream\n+ Glue workflow\n+ [Incident Manager response plan](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-creation.html#incident-tracking-auto-eventbridge) \n+ Inspector assessment template\n+ Kinesis stream\n+ Lambda function\n+ Redshift cluster\n+ SageMaker Pipeline\n+ SNS topic\n+ SQS queue\n+ Step Functions state machine\n+ Systems Manager Automation\n+ Systems Manager OpsItem\n+ Systems Manager Run Command\nCreating rules with built\\-in targets is supported only in the AWS Management Console\\. The built\\-in targets are `EC2 CreateSnapshot API call`, `EC2 RebootInstances API call`, `EC2 StopInstances API call`, and `EC2 TerminateInstances API call`\\. \nFor some target types, `PutTargets` provides target\\-specific parameters\\. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the `KinesisParameters` argument\\. To invoke a command on multiple EC2 instances with one rule, you can use the `RunCommandParameters` field\\. \nTo be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions\\. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource\\-based policies\\. For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets`\\. For more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the *Amazon EventBridge User Guide*\\. \nIf another AWS account is in the same region and has granted you permission \\(using `PutPermission`\\), you can send events to that account\\. Set that account's event bus as a target of the rules in your account\\. To send the matched events to the other account, specify that account's event bus as the `Arn` value when you run `PutTargets`\\. If your account sends events to another account, your account is charged for each sent event\\. Each event sent to another account is charged as a custom event\\. The account receiving the event is not charged\\. For more information, see [Amazon EventBridge Pricing](http://aws.amazon.com/eventbridge/pricing/)\\. \n `Input`, `InputPath`, and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account\\.\nIf you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure\\. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide*\\. \nFor more information about enabling cross\\-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html)\\. \n **Input**, **InputPath**, and **InputTransformer** are mutually exclusive and optional parameters of a target\\. When a rule is triggered due to a matched event: \n+ If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format \\(unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target\\)\\.\n+ If **Input** is specified in the form of valid JSON, then the matched event is overridden with this constant\\.\n+ If **InputPath** is specified in the form of JSONPath \\(for example, `$.detail`\\), then only the part of the event specified in the path is passed to the target \\(for example, only the detail part of the event is passed\\)\\.\n+ If **InputTransformer** is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target\\.\nWhen you specify `InputPath` or `InputTransformer`, you must use JSON dot notation, not bracket notation\\. \nWhen you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked\\. Allow a short period of time for changes to take effect\\. \nThis action can partially fail if too many requests are made at the same time\\. If that happens, `FailedEntryCount` is non\\-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code\\. \n*Required*: No \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Targets", "type": "array" } @@ -76631,7 +76657,7 @@ "properties": { "HeaderParameters": { "additionalProperties": true, - "markdownDescription": "The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -76644,13 +76670,13 @@ "items": { "type": "string" }, - "markdownDescription": "The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards \\(\"\\*\"\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards \\(\"\\*\"\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PathParameterValues", "type": "array" }, "QueryStringParameters": { "additionalProperties": true, - "markdownDescription": "The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -76677,7 +76703,7 @@ "type": "object" }, "InputTemplate": { - "markdownDescription": "Input template where you specify placeholders that will be filled with the values of the keys from `InputPathsMap` to customize the data sent to the target\\. Enclose each `InputPathsMaps` value in brackets: <*value*> The InputTemplate must be valid JSON\\. \nIf `InputTemplate` is a JSON object \\(surrounded by curly braces\\), the following restrictions apply: \n+ The placeholder cannot be used as an object key\\.\nThe following example shows the syntax for using `InputPathsMap` and `InputTemplate`\\. \n ` \"InputTransformer\":` \n `{` \n `\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},` \n `\"InputTemplate\": \" is in state \"` \n `}` \nTo have the `InputTemplate` include quote marks within a JSON string, escape each quote marks with a slash, as in the following example: \n ` \"InputTransformer\":` \n `{` \n `\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},` \n `\"InputTemplate\": \" is in state \\\"\\\"\"` \n `}` \nThe `InputTemplate` can also be valid JSON with varibles in quotes or out, as in the following example: \n ` \"InputTransformer\":` \n `{` \n `\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},` \n `\"InputTemplate\": '{\"myInstance\": ,\"myStatus\": \" is in state \\\"\\\"\"}'` \n `}` \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `8192` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Input template where you specify placeholders that will be filled with the values of the keys from `InputPathsMap` to customize the data sent to the target\\. Enclose each `InputPathsMaps` value in brackets: <*value*> \nIf `InputTemplate` is a JSON object \\(surrounded by curly braces\\), the following restrictions apply: \n+ The placeholder cannot be used as an object key\\.\nThe following example shows the syntax for using `InputPathsMap` and `InputTemplate`\\. \n ` \"InputTransformer\":` \n `{` \n `\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},` \n `\"InputTemplate\": \" is in state \"` \n `}` \nTo have the `InputTemplate` include quote marks within a JSON string, escape each quote marks with a slash, as in the following example: \n ` \"InputTransformer\":` \n `{` \n `\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},` \n `\"InputTemplate\": \" is in state \\\"\\\"\"` \n `}` \nThe `InputTemplate` can also be valid JSON with varibles in quotes or out, as in the following example: \n ` \"InputTransformer\":` \n `{` \n `\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},` \n `\"InputTemplate\": '{\"myInstance\": ,\"myStatus\": \" is in state \\\"\\\"\"}'` \n `}` \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `8192` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InputTemplate", "type": "string" } @@ -76878,7 +76904,7 @@ "additionalProperties": false, "properties": { "MessageGroupId": { - "markdownDescription": "The FIFO message group ID to use as the target\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The FIFO message group ID to use as the target\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MessageGroupId", "type": "string" } @@ -76929,7 +76955,7 @@ }, "HttpParameters": { "$ref": "#/definitions/AWS::Events::Rule.HttpParameters", - "markdownDescription": "Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination\\. \nIf you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request\\. If you're using ApiDestinations, the corresponding Connection can also have these values configured\\. In case of any conflicting keys, values from the Connection take precedence\\. \n*Required*: No \n*Type*: [HttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination\\. \nIf you specify an API Gateway API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request\\. If you're using ApiDestinations, the corresponding Connection can also have these values configured\\. In case of any conflicting keys, values from the Connection take precedence\\. \n*Required*: No \n*Type*: [HttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HttpParameters" }, "Id": { @@ -76943,7 +76969,7 @@ "type": "string" }, "InputPath": { - "markdownDescription": "The value of the JSONPath that is used for extracting part of the matched event when passing it to the target\\. You must use JSON dot notation, not bracket notation\\. For more information about JSON paths, see [JSONPath](http://goessner.net/articles/JsonPath/)\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value of the JSONPath that is used for extracting part of the matched event when passing it to the target\\. You may use JSON dot notation or bracket notation\\. For more information about JSON paths, see [JSONPath](http://goessner.net/articles/JsonPath/)\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InputPath", "type": "string" }, diff --git a/schema_source/cloudformation-docs.json b/schema_source/cloudformation-docs.json index a73678ff9..9324ea326 100644 --- a/schema_source/cloudformation-docs.json +++ b/schema_source/cloudformation-docs.json @@ -10060,33 +10060,33 @@ "AWS::Events::Archive": { "ArchiveName": "The name for the archive to create\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `48` \n*Pattern*: `[\\.\\-_A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Description": "A description for the archive\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EventPattern": "An event pattern to use to filter events sent to the archive\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventPattern": "An event pattern to use to filter events sent to the archive\\. \n*Required*: No \n*Type*: Json \n*Maximum*: `4096` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RetentionDays": "The number of days to retain events for\\. Default value is 0\\. If set to 0, events are retained indefinitely \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SourceArn": "The ARN of the event bus that sends events to the archive\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1600` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Events::Connection": { "AuthParameters": "A `CreateConnectionAuthRequestParameters` object that contains the authorization parameters to use to authorize with the endpoint\\. \n*Required*: Yes \n*Type*: [AuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AuthorizationType": "The type of authorization to use for the connection\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `API_KEY | BASIC | OAUTH_CLIENT_CREDENTIALS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthorizationType": "The type of authorization to use for the connection\\. \nOAUTH tokens are refreshed when a 401 or 407 response is returned\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `API_KEY | BASIC | OAUTH_CLIENT_CREDENTIALS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A description for the connection to create\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name for the connection to create\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `[\\.\\-_A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Events::Connection ApiKeyAuthParameters": { - "ApiKeyName": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ApiKeyValue": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ApiKeyName": "The name of the API key to use for authorization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ApiKeyValue": "The value for the API key to use for authorization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Events::Connection AuthParameters": { - "ApiKeyAuthParameters": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ApiKeyAuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "BasicAuthParameters": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [BasicAuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InvocationHttpParameters": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ConnectionHttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OAuthParameters": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [OAuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ApiKeyAuthParameters": "The API Key parameters to use for authorization\\. \n*Required*: No \n*Type*: [ApiKeyAuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BasicAuthParameters": "The authorization parameters for Basic authorization\\. \n*Required*: No \n*Type*: [BasicAuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InvocationHttpParameters": "Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint\\. \n*Required*: No \n*Type*: [ConnectionHttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OAuthParameters": "The OAuth parameters to use for authorization\\. \n*Required*: No \n*Type*: [OAuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Events::Connection BasicAuthParameters": { - "Password": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Username": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Password": "The password associated with the user name to use for Basic authorization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Username": "The user name to use for Basic authorization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Events::Connection ClientParameters": { - "ClientID": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ClientSecret": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ClientID": "The client ID to use for OAuth authorization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ClientSecret": "The client secret assciated with the client ID to use for OAuth authorization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Events::Connection ConnectionHttpParameters": { "BodyParameters": "Contains additional body string parameters for the connection\\. \n*Required*: No \n*Type*: List of [Parameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -10094,24 +10094,51 @@ "QueryStringParameters": "Contains additional query string parameters for the connection\\. \n*Required*: No \n*Type*: List of [Parameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Events::Connection OAuthParameters": { - "AuthorizationEndpoint": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ClientParameters": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: [ClientParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "HttpMethod": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OAuthHttpParameters": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ConnectionHttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AuthorizationEndpoint": "The URL to the authorization endpoint when OAuth is specified as the authorization type\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\\x26=+$,A-Za-z0-9])+)([).!';/?:,])?$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ClientParameters": "A `CreateConnectionOAuthClientRequestParameters` object that contains the client parameters for OAuth authorization\\. \n*Required*: Yes \n*Type*: [ClientParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HttpMethod": "The method to use for the authorization request\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `GET | POST | PUT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OAuthHttpParameters": "A `ConnectionHttpParameters` object that contains details about the additional parameters to use for the connection\\. \n*Required*: No \n*Type*: [ConnectionHttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Events::Connection Parameter": { - "IsValueSecret": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Key": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Value": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "IsValueSecret": "Specifies whether the value is secret\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Key": "The key for a query string parameter\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[^\\x00-\\x1F\\x7F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The value associated with the key for the query string parameter\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Events::Endpoint": { + "Description": "A description for the endpoint\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventBuses": "The event buses being used by the endpoint\\. \n*Exactly*: `2` \n*Required*: Yes \n*Type*: List of [EndpointEventBus](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-endpointeventbus.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the endpoint\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `[\\.\\-_A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ReplicationConfig": "Whether event replication was enabled or disabled for this endpoint\\. The default state is `ENABLED` which means you must supply a `RoleArn`\\. If you don't have a `RoleArn` or you don't want event replication enabled, set the state to `DISABLED`\\. \n*Required*: No \n*Type*: [ReplicationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-replicationconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RoleArn": "The ARN of the role used by event replication for the endpoint\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^arn:aws[a-z-]*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RoutingConfig": "The routing configuration of the endpoint\\. \n*Required*: Yes \n*Type*: [RoutingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-routingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Events::Endpoint EndpointEventBus": { + "EventBusArn": "The ARN of the event bus the endpoint is associated with\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^arn:aws[a-z-]*:events:[a-z]{2}-[a-z-]+-\\d+:\\d{12}:event-bus/[\\w.-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Events::Endpoint FailoverConfig": { + "Primary": "The main Region of the endpoint\\. \n*Required*: Yes \n*Type*: [Primary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-primary.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Secondary": "The Region that events are routed to when failover is triggered or event replication is enabled\\. \n*Required*: Yes \n*Type*: [Secondary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-secondary.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Events::Endpoint Primary": { + "HealthCheck": "The ARN of the health check used by the endpoint to determine whether failover is triggered\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1600` \n*Pattern*: `^arn:aws([a-z]|\\-)*:route53:::healthcheck/[\\-a-z0-9]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Events::Endpoint ReplicationConfig": { + "State": "The state of event replication\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Events::Endpoint RoutingConfig": { + "FailoverConfig": "The failover configuration for an endpoint\\. This includes what triggers failover and what happens when it's triggered\\. \n*Required*: Yes \n*Type*: [FailoverConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-failoverconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Events::Endpoint Secondary": { + "Route": "Defines the secondary Region\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `9` \n*Maximum*: `20` \n*Pattern*: `^[\\-a-z0-9]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Events::EventBus": { "EventSourceName": "If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `aws\\.partner(/[\\.\\-_A-Za-z0-9]+){2,}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Name": "The name of the new event bus\\. \nEvent bus names cannot contain the / character\\. You can't use the name `default` for a custom event bus, as this name is already used for your account's default event bus\\. \nIf this is a partner event bus, the name must exactly match the name of the partner event source that this event bus is matched to\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[/\\.\\-_A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Tags": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of [TagEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-tagentry.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Name": "The name of the new event bus\\. \nCustom event bus names can't contain the `/` character, but you can use the `/` character in partner event bus names\\. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to\\. \nYou can't use the name `default` for a custom event bus, as this name is already used for your account's default event bus\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[/\\.\\-_A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Tags to associate with the event bus\\. \n*Required*: No \n*Type*: List of [TagEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-tagentry.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Events::EventBus TagEntry": { - "Key": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Value": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Key": "A string you can use to assign a value\\. The combination of tag keys and values can help you organize and categorize your resources\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The value for the specified tag key\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Events::EventBusPolicy": { "Action": "The action that you are enabling the other account to perform\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `events:[a-zA-Z]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -10129,12 +10156,12 @@ "AWS::Events::Rule": { "Description": "The description of the rule\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EventBusName": "The name or ARN of the event bus associated with the rule\\. If you omit this, the default event bus is used\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[/\\.\\-_A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "EventPattern": "The event pattern of the rule\\. For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide*\\. \n*Required*: Conditional \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventPattern": "The event pattern of the rule\\. For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide*\\. \n*Required*: Conditional \n*Type*: Json \n*Maximum*: `4096` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `[\\.\\-_A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RoleArn": "The Amazon Resource Name \\(ARN\\) of the role that is used for target invocation\\. \nIf you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a `RoleArn` with proper permissions in the `Target` structure, instead of here in this parameter\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1600` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ScheduleExpression": "The scheduling expression\\. For example, \"cron\\(0 20 \\* \\* ? \\*\\)\", \"rate\\(5 minutes\\)\"\\. For more information, see [Creating an Amazon EventBridge rule that runs on a schedule](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html)\\. \n*Required*: Conditional \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "State": "The state of the rule\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Targets": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule\\. \nTargets are the resources that are invoked when a rule is triggered\\. \nEach rule can have up to five \\(5\\) targets associated with it at one time\\.\nYou can configure the following as targets for Events: \n+ [API destination](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html) \n+ [API Gateway](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-gateway-target.html) \n+ Batch job queue\n+ CloudWatch group\n+ CodeBuild project\n+ CodePipeline\n+ EC2 `CreateSnapshot` API call\n+ EC2 Image Builder\n+ EC2 `RebootInstances` API call\n+ EC2 `StopInstances` API call\n+ EC2 `TerminateInstances` API call\n+ ECS task\n+ [Event bus in a different account or Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cross-account.html) \n+ [Event bus in the same account and Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-bus-to-bus.html) \n+ Firehose delivery stream\n+ Glue workflow\n+ [Incident Manager response plan](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-creation.html#incident-tracking-auto-eventbridge) \n+ Inspector assessment template\n+ Kinesis stream\n+ Lambda function\n+ Redshift cluster\n+ SageMaker Pipeline\n+ SNS topic\n+ SQS queue\n+ Step Functions state machine\n+ Systems Manager Automation\n+ Systems Manager OpsItem\n+ Systems Manager Run Command\nCreating rules with built\\-in targets is supported only in the AWS Management Console\\. The built\\-in targets are `EC2 CreateSnapshot API call`, `EC2 RebootInstances API call`, `EC2 StopInstances API call`, and `EC2 TerminateInstances API call`\\. \nFor some target types, `PutTargets` provides target\\-specific parameters\\. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the `KinesisParameters` argument\\. To invoke a command on multiple EC2 instances with one rule, you can use the `RunCommandParameters` field\\. \nTo be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions\\. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource\\-based policies\\. For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets`\\. For more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the *Amazon EventBridge User Guide*\\. \nIf another AWS account is in the same region and has granted you permission \\(using `PutPermission`\\), you can send events to that account\\. Set that account's event bus as a target of the rules in your account\\. To send the matched events to the other account, specify that account's event bus as the `Arn` value when you run `PutTargets`\\. If your account sends events to another account, your account is charged for each sent event\\. Each event sent to another account is charged as a custom event\\. The account receiving the event is not charged\\. For more information, see [Amazon EventBridge Pricing](http://aws.amazon.com/eventbridge/pricing/)\\. \n `Input`, `InputPath`, and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account\\.\nIf you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure\\. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide*\\. \nFor more information about enabling cross\\-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html)\\. \n **Input**, **InputPath**, and **InputTransformer** are mutually exclusive and optional parameters of a target\\. When a rule is triggered due to a matched event: \n+ If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format \\(unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target\\)\\.\n+ If **Input** is specified in the form of valid JSON, then the matched event is overridden with this constant\\.\n+ If **InputPath** is specified in the form of JSONPath \\(for example, `$.detail`\\), then only the part of the event specified in the path is passed to the target \\(for example, only the detail part of the event is passed\\)\\.\n+ If **InputTransformer** is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target\\.\nWhen you specify `InputPath` or `InputTransformer`, you must use JSON dot notation, not bracket notation\\. \nWhen you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked\\. Allow a short period of time for changes to take effect\\. \nThis action can partially fail if too many requests are made at the same time\\. If that happens, `FailedEntryCount` is non\\-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code\\. \n*Required*: No \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Targets": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule\\. \nTargets are the resources that are invoked when a rule is triggered\\. \nEach rule can have up to five \\(5\\) targets associated with it at one time\\.\nYou can configure the following as targets for Events: \n+ [API destination](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html) \n+ [API Gateway](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-gateway-target.html) \n+ Batch job queue\n+ CloudWatch group\n+ CodeBuild project\n+ CodePipeline\n+ EC2 `CreateSnapshot` API call\n+ EC2 Image Builder\n+ EC2 `RebootInstances` API call\n+ EC2 `StopInstances` API call\n+ EC2 `TerminateInstances` API call\n+ ECS task\n+ [Event bus in a different account or Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cross-account.html) \n+ [Event bus in the same account and Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-bus-to-bus.html) \n+ Firehose delivery stream\n+ Glue workflow\n+ [Incident Manager response plan](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-creation.html#incident-tracking-auto-eventbridge) \n+ Inspector assessment template\n+ Kinesis stream\n+ Lambda function\n+ Redshift cluster\n+ SageMaker Pipeline\n+ SNS topic\n+ SQS queue\n+ Step Functions state machine\n+ Systems Manager Automation\n+ Systems Manager OpsItem\n+ Systems Manager Run Command\nCreating rules with built\\-in targets is supported only in the AWS Management Console\\. The built\\-in targets are `EC2 CreateSnapshot API call`, `EC2 RebootInstances API call`, `EC2 StopInstances API call`, and `EC2 TerminateInstances API call`\\. \nFor some target types, `PutTargets` provides target\\-specific parameters\\. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the `KinesisParameters` argument\\. To invoke a command on multiple EC2 instances with one rule, you can use the `RunCommandParameters` field\\. \nTo be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions\\. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource\\-based policies\\. For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets`\\. For more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the *Amazon EventBridge User Guide*\\. \nIf another AWS account is in the same region and has granted you permission \\(using `PutPermission`\\), you can send events to that account\\. Set that account's event bus as a target of the rules in your account\\. To send the matched events to the other account, specify that account's event bus as the `Arn` value when you run `PutTargets`\\. If your account sends events to another account, your account is charged for each sent event\\. Each event sent to another account is charged as a custom event\\. The account receiving the event is not charged\\. For more information, see [Amazon EventBridge Pricing](http://aws.amazon.com/eventbridge/pricing/)\\. \n `Input`, `InputPath`, and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account\\.\nIf you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure\\. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide*\\. \nFor more information about enabling cross\\-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html)\\. \n **Input**, **InputPath**, and **InputTransformer** are mutually exclusive and optional parameters of a target\\. When a rule is triggered due to a matched event: \n+ If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format \\(unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target\\)\\.\n+ If **Input** is specified in the form of valid JSON, then the matched event is overridden with this constant\\.\n+ If **InputPath** is specified in the form of JSONPath \\(for example, `$.detail`\\), then only the part of the event specified in the path is passed to the target \\(for example, only the detail part of the event is passed\\)\\.\n+ If **InputTransformer** is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target\\.\nWhen you specify `InputPath` or `InputTransformer`, you must use JSON dot notation, not bracket notation\\. \nWhen you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked\\. Allow a short period of time for changes to take effect\\. \nThis action can partially fail if too many requests are made at the same time\\. If that happens, `FailedEntryCount` is non\\-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code\\. \n*Required*: No \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Events::Rule AwsVpcConfiguration": { "AssignPublicIp": "Specifies whether the task's elastic network interface receives a public IP address\\. You can specify `ENABLED` only when `LaunchType` in `EcsParameters` is set to `FARGATE`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -10178,13 +10205,13 @@ "TaskDefinitionArn": "The ARN of the task definition to use if the event target is an Amazon ECS task\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1600` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Events::Rule HttpParameters": { - "HeaderParameters": "The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PathParameterValues": "The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards \\(\"\\*\"\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "QueryStringParameters": "The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "HeaderParameters": "The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PathParameterValues": "The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards \\(\"\\*\"\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "QueryStringParameters": "The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Events::Rule InputTransformer": { "InputPathsMap": "Map of JSON paths to be extracted from the event\\. You can then insert these in the template in `InputTemplate` to produce the output you want to be sent to the target\\. \n `InputPathsMap` is an array key\\-value pairs, where each value is a valid JSON path\\. You can have as many as 100 key\\-value pairs\\. You must use JSON dot notation, not bracket notation\\. \nThe keys cannot start with \"AWS\\.\" \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InputTemplate": "Input template where you specify placeholders that will be filled with the values of the keys from `InputPathsMap` to customize the data sent to the target\\. Enclose each `InputPathsMaps` value in brackets: <*value*> The InputTemplate must be valid JSON\\. \nIf `InputTemplate` is a JSON object \\(surrounded by curly braces\\), the following restrictions apply: \n+ The placeholder cannot be used as an object key\\.\nThe following example shows the syntax for using `InputPathsMap` and `InputTemplate`\\. \n ` \"InputTransformer\":` \n `{` \n `\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},` \n `\"InputTemplate\": \" is in state \"` \n `}` \nTo have the `InputTemplate` include quote marks within a JSON string, escape each quote marks with a slash, as in the following example: \n ` \"InputTransformer\":` \n `{` \n `\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},` \n `\"InputTemplate\": \" is in state \\\"\\\"\"` \n `}` \nThe `InputTemplate` can also be valid JSON with varibles in quotes or out, as in the following example: \n ` \"InputTransformer\":` \n `{` \n `\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},` \n `\"InputTemplate\": '{\"myInstance\": ,\"myStatus\": \" is in state \\\"\\\"\"}'` \n `}` \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `8192` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "InputTemplate": "Input template where you specify placeholders that will be filled with the values of the keys from `InputPathsMap` to customize the data sent to the target\\. Enclose each `InputPathsMaps` value in brackets: <*value*> \nIf `InputTemplate` is a JSON object \\(surrounded by curly braces\\), the following restrictions apply: \n+ The placeholder cannot be used as an object key\\.\nThe following example shows the syntax for using `InputPathsMap` and `InputTemplate`\\. \n ` \"InputTransformer\":` \n `{` \n `\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},` \n `\"InputTemplate\": \" is in state \"` \n `}` \nTo have the `InputTemplate` include quote marks within a JSON string, escape each quote marks with a slash, as in the following example: \n ` \"InputTransformer\":` \n `{` \n `\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},` \n `\"InputTemplate\": \" is in state \\\"\\\"\"` \n `}` \nThe `InputTemplate` can also be valid JSON with varibles in quotes or out, as in the following example: \n ` \"InputTransformer\":` \n `{` \n `\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},` \n `\"InputTemplate\": '{\"myInstance\": ,\"myStatus\": \" is in state \\\"\\\"\"}'` \n `}` \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `8192` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Events::Rule KinesisParameters": { "PartitionKeyPath": "The JSON path to be extracted from the event and used as the partition key\\. For more information, see [Amazon Kinesis Streams Key Concepts](https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key) in the *Amazon Kinesis Streams Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -10227,7 +10254,7 @@ "PipelineParameterList": "List of Parameter names and values for SageMaker Model Building Pipeline execution\\. \n*Required*: No \n*Type*: List of [SageMakerPipelineParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameter.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Events::Rule SqsParameters": { - "MessageGroupId": "The FIFO message group ID to use as the target\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "MessageGroupId": "The FIFO message group ID to use as the target\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Events::Rule Tag": { "Key": "A string you can use to assign a value\\. The combination of tag keys and values can help you organize and categorize your resources\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -10238,10 +10265,10 @@ "BatchParameters": "If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters\\. For more information, see [Jobs](https://docs.aws.amazon.com/batch/latest/userguide/jobs.html) in the * AWS Batch User Guide*\\. \n*Required*: No \n*Type*: [BatchParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DeadLetterConfig": "The `DeadLetterConfig` that defines the target queue to send dead\\-letter queue events to\\. \n*Required*: No \n*Type*: [DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EcsParameters": "Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task\\. For more information about Amazon ECS tasks, see [Task Definitions ](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon EC2 Container Service Developer Guide*\\. \n*Required*: No \n*Type*: [EcsParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "HttpParameters": "Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination\\. \nIf you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request\\. If you're using ApiDestinations, the corresponding Connection can also have these values configured\\. In case of any conflicting keys, values from the Connection take precedence\\. \n*Required*: No \n*Type*: [HttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HttpParameters": "Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination\\. \nIf you specify an API Gateway API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request\\. If you're using ApiDestinations, the corresponding Connection can also have these values configured\\. In case of any conflicting keys, values from the Connection take precedence\\. \n*Required*: No \n*Type*: [HttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Id": "The ID of the target within the specified rule\\. Use this ID to reference the target when updating the rule\\. We recommend using a memorable and unique string\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `[\\.\\-_A-Za-z0-9]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Input": "Valid JSON text passed to the target\\. In this case, nothing from the event itself is passed to the target\\. For more information, see [The JavaScript Object Notation \\(JSON\\) Data Interchange Format](http://www.rfc-editor.org/rfc/rfc7159.txt)\\. \n*Required*: No \n*Type*: String \n*Maximum*: `8192` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InputPath": "The value of the JSONPath that is used for extracting part of the matched event when passing it to the target\\. You must use JSON dot notation, not bracket notation\\. For more information about JSON paths, see [JSONPath](http://goessner.net/articles/JsonPath/)\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InputPath": "The value of the JSONPath that is used for extracting part of the matched event when passing it to the target\\. You may use JSON dot notation or bracket notation\\. For more information about JSON paths, see [JSONPath](http://goessner.net/articles/JsonPath/)\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InputTransformer": "Settings to enable you to provide custom input to a target based on certain event data\\. You can extract one or more key\\-value pairs from the event and then use that data to send customized input to the target\\. \n*Required*: No \n*Type*: [InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KinesisParameters": "The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream\\. If you do not include this parameter, the default is to use the `eventId` as the partition key\\. \n*Required*: No \n*Type*: [KinesisParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RedshiftDataParameters": "Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster\\. \nIf you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events\\. \n*Required*: No \n*Type*: [RedshiftDataParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", diff --git a/schema_source/cloudformation.schema.json b/schema_source/cloudformation.schema.json index 90b6e0d87..486ca3a26 100644 --- a/schema_source/cloudformation.schema.json +++ b/schema_source/cloudformation.schema.json @@ -75647,7 +75647,7 @@ "type": "string" }, "EventPattern": { - "markdownDescription": "An event pattern to use to filter events sent to the archive\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An event pattern to use to filter events sent to the archive\\. \n*Required*: No \n*Type*: Json \n*Maximum*: `4096` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventPattern", "type": "object" }, @@ -75729,7 +75729,7 @@ "title": "AuthParameters" }, "AuthorizationType": { - "markdownDescription": "The type of authorization to use for the connection\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `API_KEY | BASIC | OAUTH_CLIENT_CREDENTIALS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of authorization to use for the connection\\. \nOAUTH tokens are refreshed when a 401 or 407 response is returned\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `API_KEY | BASIC | OAUTH_CLIENT_CREDENTIALS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthorizationType", "type": "string" }, @@ -75775,12 +75775,12 @@ "additionalProperties": false, "properties": { "ApiKeyName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the API key to use for authorization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApiKeyName", "type": "string" }, "ApiKeyValue": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value for the API key to use for authorization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApiKeyValue", "type": "string" } @@ -75796,22 +75796,22 @@ "properties": { "ApiKeyAuthParameters": { "$ref": "#/definitions/AWS::Events::Connection.ApiKeyAuthParameters", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ApiKeyAuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The API Key parameters to use for authorization\\. \n*Required*: No \n*Type*: [ApiKeyAuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApiKeyAuthParameters" }, "BasicAuthParameters": { "$ref": "#/definitions/AWS::Events::Connection.BasicAuthParameters", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [BasicAuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The authorization parameters for Basic authorization\\. \n*Required*: No \n*Type*: [BasicAuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BasicAuthParameters" }, "InvocationHttpParameters": { "$ref": "#/definitions/AWS::Events::Connection.ConnectionHttpParameters", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ConnectionHttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint\\. \n*Required*: No \n*Type*: [ConnectionHttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InvocationHttpParameters" }, "OAuthParameters": { "$ref": "#/definitions/AWS::Events::Connection.OAuthParameters", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [OAuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The OAuth parameters to use for authorization\\. \n*Required*: No \n*Type*: [OAuthParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OAuthParameters" } }, @@ -75821,12 +75821,12 @@ "additionalProperties": false, "properties": { "Password": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The password associated with the user name to use for Basic authorization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Password", "type": "string" }, "Username": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The user name to use for Basic authorization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Username", "type": "string" } @@ -75841,12 +75841,12 @@ "additionalProperties": false, "properties": { "ClientID": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The client ID to use for OAuth authorization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClientID", "type": "string" }, "ClientSecret": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The client secret assciated with the client ID to use for OAuth authorization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^[ \\t]*[^\\x00-\\x1F:\\x7F]+([ \\t]+[^\\x00-\\x1F:\\x7F]+)*[ \\t]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClientSecret", "type": "string" } @@ -75891,23 +75891,23 @@ "additionalProperties": false, "properties": { "AuthorizationEndpoint": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The URL to the authorization endpoint when OAuth is specified as the authorization type\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\\x26=+$,A-Za-z0-9])+)([).!';/?:,])?$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthorizationEndpoint", "type": "string" }, "ClientParameters": { "$ref": "#/definitions/AWS::Events::Connection.ClientParameters", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: [ClientParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A `CreateConnectionOAuthClientRequestParameters` object that contains the client parameters for OAuth authorization\\. \n*Required*: Yes \n*Type*: [ClientParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClientParameters" }, "HttpMethod": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The method to use for the authorization request\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `GET | POST | PUT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HttpMethod", "type": "string" }, "OAuthHttpParameters": { "$ref": "#/definitions/AWS::Events::Connection.ConnectionHttpParameters", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ConnectionHttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A `ConnectionHttpParameters` object that contains details about the additional parameters to use for the connection\\. \n*Required*: No \n*Type*: [ConnectionHttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OAuthHttpParameters" } }, @@ -75922,17 +75922,17 @@ "additionalProperties": false, "properties": { "IsValueSecret": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the value is secret\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IsValueSecret", "type": "boolean" }, "Key": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The key for a query string parameter\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[^\\x00-\\x1F\\x7F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, "Value": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value associated with the key for the query string parameter\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Value", "type": "string" } @@ -75979,25 +75979,37 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A description for the endpoint\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "EventBuses": { "items": { "$ref": "#/definitions/AWS::Events::Endpoint.EndpointEventBus" }, + "markdownDescription": "The event buses being used by the endpoint\\. \n*Exactly*: `2` \n*Required*: Yes \n*Type*: List of [EndpointEventBus](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-endpointeventbus.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EventBuses", "type": "array" }, "Name": { + "markdownDescription": "The name of the endpoint\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `[\\.\\-_A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "ReplicationConfig": { - "$ref": "#/definitions/AWS::Events::Endpoint.ReplicationConfig" + "$ref": "#/definitions/AWS::Events::Endpoint.ReplicationConfig", + "markdownDescription": "Whether event replication was enabled or disabled for this endpoint\\. The default state is `ENABLED` which means you must supply a `RoleArn`\\. If you don't have a `RoleArn` or you don't want event replication enabled, set the state to `DISABLED`\\. \n*Required*: No \n*Type*: [ReplicationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-replicationconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReplicationConfig" }, "RoleArn": { + "markdownDescription": "The ARN of the role used by event replication for the endpoint\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^arn:aws[a-z-]*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" }, "RoutingConfig": { - "$ref": "#/definitions/AWS::Events::Endpoint.RoutingConfig" + "$ref": "#/definitions/AWS::Events::Endpoint.RoutingConfig", + "markdownDescription": "The routing configuration of the endpoint\\. \n*Required*: Yes \n*Type*: [RoutingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-routingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoutingConfig" } }, "required": [ @@ -76032,6 +76044,8 @@ "additionalProperties": false, "properties": { "EventBusArn": { + "markdownDescription": "The ARN of the event bus the endpoint is associated with\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `^arn:aws[a-z-]*:events:[a-z]{2}-[a-z-]+-\\d+:\\d{12}:event-bus/[\\w.-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EventBusArn", "type": "string" } }, @@ -76044,10 +76058,14 @@ "additionalProperties": false, "properties": { "Primary": { - "$ref": "#/definitions/AWS::Events::Endpoint.Primary" + "$ref": "#/definitions/AWS::Events::Endpoint.Primary", + "markdownDescription": "The main Region of the endpoint\\. \n*Required*: Yes \n*Type*: [Primary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-primary.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Primary" }, "Secondary": { - "$ref": "#/definitions/AWS::Events::Endpoint.Secondary" + "$ref": "#/definitions/AWS::Events::Endpoint.Secondary", + "markdownDescription": "The Region that events are routed to when failover is triggered or event replication is enabled\\. \n*Required*: Yes \n*Type*: [Secondary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-secondary.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Secondary" } }, "required": [ @@ -76060,6 +76078,8 @@ "additionalProperties": false, "properties": { "HealthCheck": { + "markdownDescription": "The ARN of the health check used by the endpoint to determine whether failover is triggered\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1600` \n*Pattern*: `^arn:aws([a-z]|\\-)*:route53:::healthcheck/[\\-a-z0-9]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HealthCheck", "type": "string" } }, @@ -76072,6 +76092,8 @@ "additionalProperties": false, "properties": { "State": { + "markdownDescription": "The state of event replication\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "State", "type": "string" } }, @@ -76084,7 +76106,9 @@ "additionalProperties": false, "properties": { "FailoverConfig": { - "$ref": "#/definitions/AWS::Events::Endpoint.FailoverConfig" + "$ref": "#/definitions/AWS::Events::Endpoint.FailoverConfig", + "markdownDescription": "The failover configuration for an endpoint\\. This includes what triggers failover and what happens when it's triggered\\. \n*Required*: Yes \n*Type*: [FailoverConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-failoverconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FailoverConfig" } }, "required": [ @@ -76096,6 +76120,8 @@ "additionalProperties": false, "properties": { "Route": { + "markdownDescription": "Defines the secondary Region\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `9` \n*Maximum*: `20` \n*Pattern*: `^[\\-a-z0-9]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Route", "type": "string" } }, @@ -76145,7 +76171,7 @@ "type": "string" }, "Name": { - "markdownDescription": "The name of the new event bus\\. \nEvent bus names cannot contain the / character\\. You can't use the name `default` for a custom event bus, as this name is already used for your account's default event bus\\. \nIf this is a partner event bus, the name must exactly match the name of the partner event source that this event bus is matched to\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[/\\.\\-_A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the new event bus\\. \nCustom event bus names can't contain the `/` character, but you can use the `/` character in partner event bus names\\. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to\\. \nYou can't use the name `default` for a custom event bus, as this name is already used for your account's default event bus\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[/\\.\\-_A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -76153,7 +76179,7 @@ "items": { "$ref": "#/definitions/AWS::Events::EventBus.TagEntry" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of [TagEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-tagentry.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Tags to associate with the event bus\\. \n*Required*: No \n*Type*: List of [TagEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-tagentry.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -76188,12 +76214,12 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A string you can use to assign a value\\. The combination of tag keys and values can help you organize and categorize your resources\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, "Value": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value for the specified tag key\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Value", "type": "string" } @@ -76363,7 +76389,7 @@ "type": "string" }, "EventPattern": { - "markdownDescription": "The event pattern of the rule\\. For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide*\\. \n*Required*: Conditional \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The event pattern of the rule\\. For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide*\\. \n*Required*: Conditional \n*Type*: Json \n*Maximum*: `4096` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventPattern", "type": "object" }, @@ -76391,7 +76417,7 @@ "items": { "$ref": "#/definitions/AWS::Events::Rule.Target" }, - "markdownDescription": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule\\. \nTargets are the resources that are invoked when a rule is triggered\\. \nEach rule can have up to five \\(5\\) targets associated with it at one time\\.\nYou can configure the following as targets for Events: \n+ [API destination](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html) \n+ [API Gateway](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-gateway-target.html) \n+ Batch job queue\n+ CloudWatch group\n+ CodeBuild project\n+ CodePipeline\n+ EC2 `CreateSnapshot` API call\n+ EC2 Image Builder\n+ EC2 `RebootInstances` API call\n+ EC2 `StopInstances` API call\n+ EC2 `TerminateInstances` API call\n+ ECS task\n+ [Event bus in a different account or Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cross-account.html) \n+ [Event bus in the same account and Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-bus-to-bus.html) \n+ Firehose delivery stream\n+ Glue workflow\n+ [Incident Manager response plan](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-creation.html#incident-tracking-auto-eventbridge) \n+ Inspector assessment template\n+ Kinesis stream\n+ Lambda function\n+ Redshift cluster\n+ SageMaker Pipeline\n+ SNS topic\n+ SQS queue\n+ Step Functions state machine\n+ Systems Manager Automation\n+ Systems Manager OpsItem\n+ Systems Manager Run Command\nCreating rules with built\\-in targets is supported only in the AWS Management Console\\. The built\\-in targets are `EC2 CreateSnapshot API call`, `EC2 RebootInstances API call`, `EC2 StopInstances API call`, and `EC2 TerminateInstances API call`\\. \nFor some target types, `PutTargets` provides target\\-specific parameters\\. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the `KinesisParameters` argument\\. To invoke a command on multiple EC2 instances with one rule, you can use the `RunCommandParameters` field\\. \nTo be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions\\. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource\\-based policies\\. For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets`\\. For more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the *Amazon EventBridge User Guide*\\. \nIf another AWS account is in the same region and has granted you permission \\(using `PutPermission`\\), you can send events to that account\\. Set that account's event bus as a target of the rules in your account\\. To send the matched events to the other account, specify that account's event bus as the `Arn` value when you run `PutTargets`\\. If your account sends events to another account, your account is charged for each sent event\\. Each event sent to another account is charged as a custom event\\. The account receiving the event is not charged\\. For more information, see [Amazon EventBridge Pricing](http://aws.amazon.com/eventbridge/pricing/)\\. \n `Input`, `InputPath`, and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account\\.\nIf you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure\\. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide*\\. \nFor more information about enabling cross\\-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html)\\. \n **Input**, **InputPath**, and **InputTransformer** are mutually exclusive and optional parameters of a target\\. When a rule is triggered due to a matched event: \n+ If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format \\(unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target\\)\\.\n+ If **Input** is specified in the form of valid JSON, then the matched event is overridden with this constant\\.\n+ If **InputPath** is specified in the form of JSONPath \\(for example, `$.detail`\\), then only the part of the event specified in the path is passed to the target \\(for example, only the detail part of the event is passed\\)\\.\n+ If **InputTransformer** is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target\\.\nWhen you specify `InputPath` or `InputTransformer`, you must use JSON dot notation, not bracket notation\\. \nWhen you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked\\. Allow a short period of time for changes to take effect\\. \nThis action can partially fail if too many requests are made at the same time\\. If that happens, `FailedEntryCount` is non\\-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code\\. \n*Required*: No \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule\\. \nTargets are the resources that are invoked when a rule is triggered\\. \nEach rule can have up to five \\(5\\) targets associated with it at one time\\.\nYou can configure the following as targets for Events: \n+ [API destination](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html) \n+ [API Gateway](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-gateway-target.html) \n+ Batch job queue\n+ CloudWatch group\n+ CodeBuild project\n+ CodePipeline\n+ EC2 `CreateSnapshot` API call\n+ EC2 Image Builder\n+ EC2 `RebootInstances` API call\n+ EC2 `StopInstances` API call\n+ EC2 `TerminateInstances` API call\n+ ECS task\n+ [Event bus in a different account or Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cross-account.html) \n+ [Event bus in the same account and Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-bus-to-bus.html) \n+ Firehose delivery stream\n+ Glue workflow\n+ [Incident Manager response plan](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-creation.html#incident-tracking-auto-eventbridge) \n+ Inspector assessment template\n+ Kinesis stream\n+ Lambda function\n+ Redshift cluster\n+ SageMaker Pipeline\n+ SNS topic\n+ SQS queue\n+ Step Functions state machine\n+ Systems Manager Automation\n+ Systems Manager OpsItem\n+ Systems Manager Run Command\nCreating rules with built\\-in targets is supported only in the AWS Management Console\\. The built\\-in targets are `EC2 CreateSnapshot API call`, `EC2 RebootInstances API call`, `EC2 StopInstances API call`, and `EC2 TerminateInstances API call`\\. \nFor some target types, `PutTargets` provides target\\-specific parameters\\. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the `KinesisParameters` argument\\. To invoke a command on multiple EC2 instances with one rule, you can use the `RunCommandParameters` field\\. \nTo be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions\\. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource\\-based policies\\. For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets`\\. For more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the *Amazon EventBridge User Guide*\\. \nIf another AWS account is in the same region and has granted you permission \\(using `PutPermission`\\), you can send events to that account\\. Set that account's event bus as a target of the rules in your account\\. To send the matched events to the other account, specify that account's event bus as the `Arn` value when you run `PutTargets`\\. If your account sends events to another account, your account is charged for each sent event\\. Each event sent to another account is charged as a custom event\\. The account receiving the event is not charged\\. For more information, see [Amazon EventBridge Pricing](http://aws.amazon.com/eventbridge/pricing/)\\. \n `Input`, `InputPath`, and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account\\.\nIf you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure\\. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide*\\. \nFor more information about enabling cross\\-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html)\\. \n **Input**, **InputPath**, and **InputTransformer** are mutually exclusive and optional parameters of a target\\. When a rule is triggered due to a matched event: \n+ If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format \\(unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target\\)\\.\n+ If **Input** is specified in the form of valid JSON, then the matched event is overridden with this constant\\.\n+ If **InputPath** is specified in the form of JSONPath \\(for example, `$.detail`\\), then only the part of the event specified in the path is passed to the target \\(for example, only the detail part of the event is passed\\)\\.\n+ If **InputTransformer** is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target\\.\nWhen you specify `InputPath` or `InputTransformer`, you must use JSON dot notation, not bracket notation\\. \nWhen you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked\\. Allow a short period of time for changes to take effect\\. \nThis action can partially fail if too many requests are made at the same time\\. If that happens, `FailedEntryCount` is non\\-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code\\. \n*Required*: No \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Targets", "type": "array" } @@ -76631,7 +76657,7 @@ "properties": { "HeaderParameters": { "additionalProperties": true, - "markdownDescription": "The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -76644,13 +76670,13 @@ "items": { "type": "string" }, - "markdownDescription": "The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards \\(\"\\*\"\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards \\(\"\\*\"\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PathParameterValues", "type": "array" }, "QueryStringParameters": { "additionalProperties": true, - "markdownDescription": "The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -76677,7 +76703,7 @@ "type": "object" }, "InputTemplate": { - "markdownDescription": "Input template where you specify placeholders that will be filled with the values of the keys from `InputPathsMap` to customize the data sent to the target\\. Enclose each `InputPathsMaps` value in brackets: <*value*> The InputTemplate must be valid JSON\\. \nIf `InputTemplate` is a JSON object \\(surrounded by curly braces\\), the following restrictions apply: \n+ The placeholder cannot be used as an object key\\.\nThe following example shows the syntax for using `InputPathsMap` and `InputTemplate`\\. \n ` \"InputTransformer\":` \n `{` \n `\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},` \n `\"InputTemplate\": \" is in state \"` \n `}` \nTo have the `InputTemplate` include quote marks within a JSON string, escape each quote marks with a slash, as in the following example: \n ` \"InputTransformer\":` \n `{` \n `\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},` \n `\"InputTemplate\": \" is in state \\\"\\\"\"` \n `}` \nThe `InputTemplate` can also be valid JSON with varibles in quotes or out, as in the following example: \n ` \"InputTransformer\":` \n `{` \n `\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},` \n `\"InputTemplate\": '{\"myInstance\": ,\"myStatus\": \" is in state \\\"\\\"\"}'` \n `}` \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `8192` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Input template where you specify placeholders that will be filled with the values of the keys from `InputPathsMap` to customize the data sent to the target\\. Enclose each `InputPathsMaps` value in brackets: <*value*> \nIf `InputTemplate` is a JSON object \\(surrounded by curly braces\\), the following restrictions apply: \n+ The placeholder cannot be used as an object key\\.\nThe following example shows the syntax for using `InputPathsMap` and `InputTemplate`\\. \n ` \"InputTransformer\":` \n `{` \n `\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},` \n `\"InputTemplate\": \" is in state \"` \n `}` \nTo have the `InputTemplate` include quote marks within a JSON string, escape each quote marks with a slash, as in the following example: \n ` \"InputTransformer\":` \n `{` \n `\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},` \n `\"InputTemplate\": \" is in state \\\"\\\"\"` \n `}` \nThe `InputTemplate` can also be valid JSON with varibles in quotes or out, as in the following example: \n ` \"InputTransformer\":` \n `{` \n `\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},` \n `\"InputTemplate\": '{\"myInstance\": ,\"myStatus\": \" is in state \\\"\\\"\"}'` \n `}` \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `8192` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InputTemplate", "type": "string" } @@ -76878,7 +76904,7 @@ "additionalProperties": false, "properties": { "MessageGroupId": { - "markdownDescription": "The FIFO message group ID to use as the target\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The FIFO message group ID to use as the target\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MessageGroupId", "type": "string" } @@ -76929,7 +76955,7 @@ }, "HttpParameters": { "$ref": "#/definitions/AWS::Events::Rule.HttpParameters", - "markdownDescription": "Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination\\. \nIf you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request\\. If you're using ApiDestinations, the corresponding Connection can also have these values configured\\. In case of any conflicting keys, values from the Connection take precedence\\. \n*Required*: No \n*Type*: [HttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination\\. \nIf you specify an API Gateway API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request\\. If you're using ApiDestinations, the corresponding Connection can also have these values configured\\. In case of any conflicting keys, values from the Connection take precedence\\. \n*Required*: No \n*Type*: [HttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HttpParameters" }, "Id": { @@ -76943,7 +76969,7 @@ "type": "string" }, "InputPath": { - "markdownDescription": "The value of the JSONPath that is used for extracting part of the matched event when passing it to the target\\. You must use JSON dot notation, not bracket notation\\. For more information about JSON paths, see [JSONPath](http://goessner.net/articles/JsonPath/)\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value of the JSONPath that is used for extracting part of the matched event when passing it to the target\\. You may use JSON dot notation or bracket notation\\. For more information about JSON paths, see [JSONPath](http://goessner.net/articles/JsonPath/)\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InputPath", "type": "string" },