ApiDestination
Contains details about an API destination.
Contents
- ApiDestinationArn
-
The ARN of the API destination.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:api-destination\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$Required: No
- ApiDestinationState
-
The state of the API destination.
Type: String
Valid Values:
ACTIVE | INACTIVERequired: No
- ConnectionArn
-
The ARN of the connection specified for the API destination.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$Required: No
- CreationTime
-
A time stamp for the time that the API destination was created.
Type: Timestamp
Required: No
- HttpMethod
-
The method to use to connect to the HTTP endpoint.
Type: String
Valid Values:
POST | GET | HEAD | OPTIONS | PUT | PATCH | DELETERequired: No
- InvocationEndpoint
-
The URL to the endpoint for the API destination.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\x26=+$,A-Za-z0-9])+)([).!';/?:,])?$Required: No
- InvocationRateLimitPerSecond
-
The maximum number of invocations per second to send to the HTTP endpoint.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- LastModifiedTime
-
A time stamp for the time that the API destination was last modified.
Type: Timestamp
Required: No
- Name
-
The name of the API destination.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_A-Za-z0-9]+Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: