Class: AWSCDK::Events::CfnAPIDestinationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
events/cfn_api_destination_props.rb

Overview

Properties for defining a CfnApiDestination.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection_arn:, http_method:, invocation_endpoint:, description: nil, invocation_rate_limit_per_second: nil, name: nil) ⇒ CfnAPIDestinationProps

Returns a new instance of CfnAPIDestinationProps.

Parameters:

  • connection_arn (String) —

    The ARN of the connection to use for the API destination.

  • 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.

  • description (String, nil) (defaults to: nil) —

    A description for the API destination to create.

  • invocation_rate_limit_per_second (Numeric, nil) (defaults to: nil) —

    The maximum number of requests per second to send to the HTTP invocation endpoint.

  • name (String, nil) (defaults to: nil) —

    The name for the API destination to create.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'events/cfn_api_destination_props.rb', line 15

def initialize(connection_arn:, http_method:, invocation_endpoint:, description: nil, invocation_rate_limit_per_second: nil, name: nil)
  @connection_arn = connection_arn
  Jsii::Type.check_type(@connection_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectionArn")
  @http_method = http_method
  Jsii::Type.check_type(@http_method, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "httpMethod")
  @invocation_endpoint = invocation_endpoint
  Jsii::Type.check_type(@invocation_endpoint, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "invocationEndpoint")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @invocation_rate_limit_per_second = invocation_rate_limit_per_second
  Jsii::Type.check_type(@invocation_rate_limit_per_second, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "invocationRateLimitPerSecond") unless @invocation_rate_limit_per_second.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
end

Instance Attribute Details

#connection_arn ⇒ String (readonly)

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)

See Also:



36
37
38
 
# File 'events/cfn_api_destination_props.rb', line 36

def connection_arn
  @connection_arn
end

#description ⇒ String? (readonly)

A description for the API destination to create.

Returns:

  • (String, nil)

See Also:



51
52
53
 
# File 'events/cfn_api_destination_props.rb', line 51

def description
  @description
end

#http_method ⇒ String (readonly)

The method to use for the request to the HTTP invocation endpoint.

Returns:

  • (String)

See Also:



41
42
43
 
# File 'events/cfn_api_destination_props.rb', line 41

def http_method
  @http_method
end

#invocation_endpoint ⇒ String (readonly)

The URL to the HTTP invocation endpoint for the API destination.

Returns:

  • (String)

See Also:



46
47
48
 
# File 'events/cfn_api_destination_props.rb', line 46

def invocation_endpoint
  @invocation_endpoint
end

#invocation_rate_limit_per_second ⇒ Numeric? (readonly)

The maximum number of requests per second to send to the HTTP invocation endpoint.

Returns:

  • (Numeric, nil)

See Also:



56
57
58
 
# File 'events/cfn_api_destination_props.rb', line 56

def invocation_rate_limit_per_second
  @invocation_rate_limit_per_second
end

#name ⇒ String? (readonly)

The name for the API destination to create.

Returns:

  • (String, nil)

See Also:



61
62
63
 
# File 'events/cfn_api_destination_props.rb', line 61

def name
  @name
end

Class Method Details

.jsii_properties ⇒ Object 



63
64
65
66
67
68
69
70
71
72
 
# File 'events/cfn_api_destination_props.rb', line 63

def self.jsii_properties
  {
    :connection_arn => "connectionArn",
    :http_method => "httpMethod",
    :invocation_endpoint => "invocationEndpoint",
    :description => "description",
    :invocation_rate_limit_per_second => "invocationRateLimitPerSecond",
    :name => "name",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'events/cfn_api_destination_props.rb', line 74

def to_jsii
  result = {}
  result.merge!({
    "connectionArn" => @connection_arn,
    "httpMethod" => @http_method,
    "invocationEndpoint" => @invocation_endpoint,
    "description" => @description,
    "invocationRateLimitPerSecond" => @invocation_rate_limit_per_second,
    "name" => @name,
  })
  result.compact
end