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:



1018
1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1018

class CreateConnectionRequest < Struct.new(
  :name,
  :description,
  :authorization_type,
  :auth_parameters,
  :invocation_connectivity_parameters)
  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) 


1018
1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1018

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

#description ⇒ String

A description for the connection to create.

Returns:

  • (String) 


1018
1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1018

class CreateConnectionRequest < Struct.new(
  :name,
  :description,
  :authorization_type,
  :auth_parameters,
  :invocation_connectivity_parameters)
  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:



1018
1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1018

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

#name ⇒ String

The name for the connection to create.

Returns:

  • (String) 


1018
1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'lib/aws-sdk-eventbridge/types.rb', line 1018

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