Class: Aws::EventBridge::Types::CreateApiDestinationRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EventBridge::Types::CreateApiDestinationRequest
- Defined in:
- gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb
Overview
When making an API call, you may pass CreateApiDestinationRequest data as a hash:
{
name: "ApiDestinationName", # required
description: "ApiDestinationDescription",
connection_arn: "ConnectionArn", # required
invocation_endpoint: "HttpsEndpoint", # required
http_method: "POST", # required, accepts POST, GET, HEAD, OPTIONS, PUT, PATCH, DELETE
invocation_rate_limit_per_second: 1,
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#connection_arn ⇒ String
The ARN of the connection to use for the API destination.
-
#description ⇒ String
A description for the API destination to create.
-
#http_method ⇒ String
The method to use for the request to the HTTP invocation endpoint.
-
#invocation_endpoint ⇒ String
The URL to the HTTP invocation endpoint for the API destination.
-
#invocation_rate_limit_per_second ⇒ Integer
The maximum number of requests per second to send to the HTTP invocation endpoint.
-
#name ⇒ String
The name for the API destination to create.
Instance Attribute Details
#connection_arn ⇒ String
The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.
775 776 777 778 779 780 781 782 783 784 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 775 class CreateApiDestinationRequest < Struct.new( :name, :description, :connection_arn, :invocation_endpoint, :http_method, :invocation_rate_limit_per_second) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A description for the API destination to create.
775 776 777 778 779 780 781 782 783 784 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 775 class CreateApiDestinationRequest < Struct.new( :name, :description, :connection_arn, :invocation_endpoint, :http_method, :invocation_rate_limit_per_second) SENSITIVE = [] include Aws::Structure end |
#http_method ⇒ String
The method to use for the request to the HTTP invocation endpoint.
775 776 777 778 779 780 781 782 783 784 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 775 class CreateApiDestinationRequest < Struct.new( :name, :description, :connection_arn, :invocation_endpoint, :http_method, :invocation_rate_limit_per_second) SENSITIVE = [] include Aws::Structure end |
#invocation_endpoint ⇒ String
The URL to the HTTP invocation endpoint for the API destination.
775 776 777 778 779 780 781 782 783 784 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 775 class CreateApiDestinationRequest < Struct.new( :name, :description, :connection_arn, :invocation_endpoint, :http_method, :invocation_rate_limit_per_second) SENSITIVE = [] include Aws::Structure end |
#invocation_rate_limit_per_second ⇒ Integer
The maximum number of requests per second to send to the HTTP invocation endpoint.
775 776 777 778 779 780 781 782 783 784 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 775 class CreateApiDestinationRequest < Struct.new( :name, :description, :connection_arn, :invocation_endpoint, :http_method, :invocation_rate_limit_per_second) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name for the API destination to create.
775 776 777 778 779 780 781 782 783 784 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 775 class CreateApiDestinationRequest < Struct.new( :name, :description, :connection_arn, :invocation_endpoint, :http_method, :invocation_rate_limit_per_second) SENSITIVE = [] include Aws::Structure end |