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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_destination_arnString

The ARN of the API destination retrieved.

Returns:

  • (String)


1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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_stateString

The state of the API destination retrieved.

Returns:

  • (String)


1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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_arnString

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

Returns:

  • (String)


1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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_timeTime

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

Returns:

  • (Time)


1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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

#descriptionString

The description for the API destination retrieved.

Returns:

  • (String)


1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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_methodString

The method to use to connect to the HTTP endpoint.

Returns:

  • (String)


1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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_endpointString

The URL to use to connect to the HTTP endpoint.

Returns:

  • (String)


1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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_secondInteger

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)


1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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_timeTime

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

Returns:

  • (Time)


1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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

#nameString

The name of the API destination retrieved.

Returns:

  • (String)


1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 1709

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