class Amazonite::EventBridge::CreateConnectionRequest

Included Modules

Defined in:

eventbridge/create_connection_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(name : String, authorization_type : ConnectionAuthorizationType, auth_parameters : CreateConnectionAuthRequestParameters, description : String | Nil = nil, invocation_connectivity_parameters : ConnectivityResourceParameters | Nil = nil, kms_key_identifier : String | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def auth_parameters : CreateConnectionAuthRequestParameters #

The authorization parameters to use to authorize with the endpoint.

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


[View source]
def auth_parameters=(auth_parameters : CreateConnectionAuthRequestParameters) #

The authorization parameters to use to authorize with the endpoint.

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


[View source]
def authorization_type : ConnectionAuthorizationType #

The type of authorization to use for the connection.

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


[View source]
def authorization_type=(authorization_type : ConnectionAuthorizationType) #

The type of authorization to use for the connection.

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


[View source]
def description : String | Nil #

A description for the connection to create.


[View source]
def description=(description : String | Nil) #

A description for the connection to create.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def invocation_connectivity_parameters : ConnectivityResourceParameters | Nil #

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


[View source]
def invocation_connectivity_parameters=(invocation_connectivity_parameters : ConnectivityResourceParameters | Nil) #

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


[View source]
def kms_key_identifier : String | Nil #

The identifier of the KMS 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 Amazon Web Services owned key to encrypt the connection.

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


[View source]
def kms_key_identifier=(kms_key_identifier : String | Nil) #

The identifier of the KMS 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 Amazon Web Services owned key to encrypt the connection.

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


[View source]
def name : String #

The name for the connection to create.


[View source]
def name=(name : String) #

The name for the connection to create.


[View source]
def validate! : Nil #

[View source]