Class: Aws::EventBridge::Types::CreateConnectionRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-eventbridge/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auth_parameters ⇒ Types::CreateConnectionAuthRequestParameters

The authorization parameters to use to authorize with the endpoint.

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

Returns:



1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1035

class CreateConnectionRequest < Struct.new(
  :name,
  :description,
  :authorization_type,
  :auth_parameters,
  :invocation_connectivity_parameters,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#authorization_type ⇒ String

The type of authorization to use for the connection.

<note markdown=“1”> OAUTH tokens are refreshed when a 401 or 407 response is returned.

</note>

Returns:

  • (String) 


1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1035

class CreateConnectionRequest < Struct.new(
  :name,
  :description,
  :authorization_type,
  :auth_parameters,
  :invocation_connectivity_parameters,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the connection to create.

Returns:

  • (String) 


1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1035

class CreateConnectionRequest < Struct.new(
  :name,
  :description,
  :authorization_type,
  :auth_parameters,
  :invocation_connectivity_parameters,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#invocation_connectivity_parameters ⇒ Types::ConnectivityResourceParameters

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 .

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html

Returns:



1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1035

class CreateConnectionRequest < Struct.new(
  :name,
  :description,
  :authorization_type,
  :auth_parameters,
  :invocation_connectivity_parameters,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_identifier ⇒ String

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

[1]: docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html

Returns:

  • (String) 


1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1035

class CreateConnectionRequest < Struct.new(
  :name,
  :description,
  :authorization_type,
  :auth_parameters,
  :invocation_connectivity_parameters,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name for the connection to create.

Returns:

  • (String) 


1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1035

class CreateConnectionRequest < Struct.new(
  :name,
  :description,
  :authorization_type,
  :auth_parameters,
  :invocation_connectivity_parameters,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end