Class: AWSCDK::Events::CfnConnectionProps

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

Overview

Properties for defining a CfnConnection.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(authorization_type: nil, auth_parameters: nil, description: nil, invocation_connectivity_parameters: nil, kms_key_identifier: nil, name: nil) ⇒ CfnConnectionProps

Returns a new instance of CfnConnectionProps.

Parameters:

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

    The type of authorization to use for the connection.

  • auth_parameters (AWSCDK::IResolvable, AWSCDK::Events::CfnConnection::AuthParametersProperty, nil) (defaults to: nil) —

    The authorization parameters to use to authorize with the endpoint.

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

    A description for the connection to create.

  • invocation_connectivity_parameters (AWSCDK::IResolvable, AWSCDK::Events::CfnConnection::InvocationConnectivityParametersProperty, nil) (defaults to: nil) —

    For connections to private APIs, the parameters to use for invoking the API.

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

    The identifier of the AWS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection.

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

    The name for the connection to create.



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

def initialize(authorization_type: nil, auth_parameters: nil, description: nil, invocation_connectivity_parameters: nil, kms_key_identifier: nil, name: nil)
  @authorization_type = authorization_type
  Jsii::Type.check_type(@authorization_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authorizationType") unless @authorization_type.nil?
  @auth_parameters = auth_parameters.is_a?(Hash) ? ::AWSCDK::Events::CfnConnection::AuthParametersProperty.new(**auth_parameters.transform_keys(&:to_sym)) : auth_parameters
  Jsii::Type.check_type(@auth_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldmVudHMuQ2ZuQ29ubmVjdGlvbi5BdXRoUGFyYW1ldGVyc1Byb3BlcnR5In1dfX0=")), "authParameters") unless @auth_parameters.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @invocation_connectivity_parameters = invocation_connectivity_parameters.is_a?(Hash) ? ::AWSCDK::Events::CfnConnection::InvocationConnectivityParametersProperty.new(**invocation_connectivity_parameters.transform_keys(&:to_sym)) : invocation_connectivity_parameters
  Jsii::Type.check_type(@invocation_connectivity_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldmVudHMuQ2ZuQ29ubmVjdGlvbi5JbnZvY2F0aW9uQ29ubmVjdGl2aXR5UGFyYW1ldGVyc1Byb3BlcnR5In1dfX0=")), "invocationConnectivityParameters") unless @invocation_connectivity_parameters.nil?
  @kms_key_identifier = kms_key_identifier
  Jsii::Type.check_type(@kms_key_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyIdentifier") unless @kms_key_identifier.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
end

Instance Attribute Details

#auth_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

The authorization parameters to use to authorize with the endpoint.

You must include only authorization parameters for the AuthorizationType you specify.

Returns:

See Also:



43
44
45
 
# File 'events/cfn_connection_props.rb', line 43

def auth_parameters
  @auth_parameters
end

#authorization_type ⇒ String? (readonly)

The type of authorization to use for the connection.

OAUTH tokens are refreshed when a 401 or 407 response is returned.

Returns:

  • (String, nil)

See Also:



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

def authorization_type
  @authorization_type
end

#description ⇒ String? (readonly)

A description for the connection to create.

Returns:

  • (String, nil)

See Also:



48
49
50
 
# File 'events/cfn_connection_props.rb', line 48

def description
  @description
end

#invocation_connectivity_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

For connections to private APIs, the parameters to use for invoking the API.

For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .

Returns:

See Also:



55
56
57
 
# File 'events/cfn_connection_props.rb', line 55

def invocation_connectivity_parameters
  @invocation_connectivity_parameters
end

#kms_key_identifier ⇒ String? (readonly)

The identifier of the AWS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection.

The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to encrypt the connection.

For more information, see Identify and view keys in the AWS Key Management Service Developer Guide .

Returns:

  • (String, nil)

See Also:



66
67
68
 
# File 'events/cfn_connection_props.rb', line 66

def kms_key_identifier
  @kms_key_identifier
end

#name ⇒ String? (readonly)

The name for the connection to create.

Returns:

  • (String, nil)

See Also:



71
72
73
 
# File 'events/cfn_connection_props.rb', line 71

def name
  @name
end

Class Method Details

.jsii_properties ⇒ Object 



73
74
75
76
77
78
79
80
81
82
 
# File 'events/cfn_connection_props.rb', line 73

def self.jsii_properties
  {
    :authorization_type => "authorizationType",
    :auth_parameters => "authParameters",
    :description => "description",
    :invocation_connectivity_parameters => "invocationConnectivityParameters",
    :kms_key_identifier => "kmsKeyIdentifier",
    :name => "name",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'events/cfn_connection_props.rb', line 84

def to_jsii
  result = {}
  result.merge!({
    "authorizationType" => @authorization_type,
    "authParameters" => @auth_parameters,
    "description" => @description,
    "invocationConnectivityParameters" => @invocation_connectivity_parameters,
    "kmsKeyIdentifier" => @kms_key_identifier,
    "name" => @name,
  })
  result.compact
end