Class: Aws::EventBridge::Types::CreateApiDestinationRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb

Overview

Note:

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,
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:

  • (String) 


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.

Returns:

  • (String) 


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.

Returns:

  • (String) 


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.

Returns:

  • (String) 


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.

Returns:

  • (Integer) 


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.

Returns:

  • (String) 


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