Class: Aws::CloudWatchEvents::Types::DescribeApiDestinationResponse

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchEvents::Types::DescribeApiDestinationResponse

Defined in:

gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #api_destination_arn ⇒ String

  The ARN of the API destination retrieved.

• #api_destination_state ⇒ String

  The state of the API destination retrieved.

• #connection_arn ⇒ String

  The ARN of the connection specified for the API destination retrieved.

• #creation_time ⇒ Time

  A time stamp for the time that the API destination was created.

• #description ⇒ String

  The description for the API destination retrieved.

• #http_method ⇒ String

  The method to use to connect to the HTTP endpoint.

• #invocation_endpoint ⇒ String

  The URL to use to connect to the HTTP endpoint.

• #invocation_rate_limit_per_second ⇒ Integer

  The maximum number of invocations per second to specified for the API destination.

• #last_modified_time ⇒ Time

  A time stamp for the time that the API destination was last modified.

• #name ⇒ String

  The name of the API destination retrieved.

Instance Attribute Details

#api_destination_arn ⇒ String

The ARN of the API destination retrieved.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1269

class DescribeApiDestinationResponse < Struct.new(
  :api_destination_arn,
  :name,
  :description,
  :api_destination_state,
  :connection_arn,
  :invocation_endpoint,
  :http_method,
  :invocation_rate_limit_per_second,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#api_destination_state ⇒ String

The state of the API destination retrieved.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1269

class DescribeApiDestinationResponse < Struct.new(
  :api_destination_arn,
  :name,
  :description,
  :api_destination_state,
  :connection_arn,
  :invocation_endpoint,
  :http_method,
  :invocation_rate_limit_per_second,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#connection_arn ⇒ String

The ARN of the connection specified for the API destination retrieved.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1269

class DescribeApiDestinationResponse < Struct.new(
  :api_destination_arn,
  :name,
  :description,
  :api_destination_state,
  :connection_arn,
  :invocation_endpoint,
  :http_method,
  :invocation_rate_limit_per_second,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

A time stamp for the time that the API destination was created.

Returns:

• (Time)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1269

class DescribeApiDestinationResponse < Struct.new(
  :api_destination_arn,
  :name,
  :description,
  :api_destination_state,
  :connection_arn,
  :invocation_endpoint,
  :http_method,
  :invocation_rate_limit_per_second,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description for the API destination retrieved.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1269

class DescribeApiDestinationResponse < Struct.new(
  :api_destination_arn,
  :name,
  :description,
  :api_destination_state,
  :connection_arn,
  :invocation_endpoint,
  :http_method,
  :invocation_rate_limit_per_second,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#http_method ⇒ String

The method to use to connect to the HTTP endpoint.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1269

class DescribeApiDestinationResponse < Struct.new(
  :api_destination_arn,
  :name,
  :description,
  :api_destination_state,
  :connection_arn,
  :invocation_endpoint,
  :http_method,
  :invocation_rate_limit_per_second,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#invocation_endpoint ⇒ String

The URL to use to connect to the HTTP endpoint.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1269

class DescribeApiDestinationResponse < Struct.new(
  :api_destination_arn,
  :name,
  :description,
  :api_destination_state,
  :connection_arn,
  :invocation_endpoint,
  :http_method,
  :invocation_rate_limit_per_second,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#invocation_rate_limit_per_second ⇒ Integer

The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.

Returns:

• (Integer)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1269

class DescribeApiDestinationResponse < Struct.new(
  :api_destination_arn,
  :name,
  :description,
  :api_destination_state,
  :connection_arn,
  :invocation_endpoint,
  :http_method,
  :invocation_rate_limit_per_second,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ Time

A time stamp for the time that the API destination was last modified.

Returns:

• (Time)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1269

class DescribeApiDestinationResponse < Struct.new(
  :api_destination_arn,
  :name,
  :description,
  :api_destination_state,
  :connection_arn,
  :invocation_endpoint,
  :http_method,
  :invocation_rate_limit_per_second,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the API destination retrieved.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1269

class DescribeApiDestinationResponse < Struct.new(
  :api_destination_arn,
  :name,
  :description,
  :api_destination_state,
  :connection_arn,
  :invocation_endpoint,
  :http_method,
  :invocation_rate_limit_per_second,
  :creation_time,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end