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

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

Overview

Note:

When making an API call, you may pass CreateConnectionRequest data as a hash:

{
  name: "ConnectionName", # required
  description: "ConnectionDescription",
  authorization_type: "BASIC", # required, accepts BASIC, OAUTH_CLIENT_CREDENTIALS, API_KEY
  auth_parameters: { # required
    basic_auth_parameters: {
      username: "AuthHeaderParameters", # required
      password: "AuthHeaderParameters", # required
    },
    o_auth_parameters: {
      client_parameters: { # required
        client_id: "AuthHeaderParameters", # required
        client_secret: "AuthHeaderParameters", # required
      },
      authorization_endpoint: "HttpsEndpoint", # required
      http_method: "GET", # required, accepts GET, POST, PUT
      o_auth_http_parameters: {
        header_parameters: [
          {
            key: "HeaderKey",
            value: "HeaderValue",
            is_value_secret: false,
          },
        ],
        query_string_parameters: [
          {
            key: "QueryStringKey",
            value: "QueryStringValue",
            is_value_secret: false,
          },
        ],
        body_parameters: [
          {
            key: "String",
            value: "String",
            is_value_secret: false,
          },
        ],
      },
    },
    api_key_auth_parameters: {
      api_key_name: "AuthHeaderParameters", # required
      api_key_value: "AuthHeaderParameters", # required
    },
    invocation_http_parameters: {
      header_parameters: [
        {
          key: "HeaderKey",
          value: "HeaderValue",
          is_value_secret: false,
        },
      ],
      query_string_parameters: [
        {
          key: "QueryStringKey",
          value: "QueryStringValue",
          is_value_secret: false,
        },
      ],
      body_parameters: [
        {
          key: "String",
          value: "String",
          is_value_secret: false,
        },
      ],
    },
  },
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auth_parameters ⇒ Types::CreateConnectionAuthRequestParameters

A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.

Returns:



1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1232

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

#authorization_type ⇒ String

The type of authorization to use for the connection.

Returns:

  • (String) 


1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1232

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

#description ⇒ String

A description for the connection to create.

Returns:

  • (String) 


1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1232

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

#name ⇒ String

The name for the connection to create.

Returns:

  • (String) 


1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1232

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