AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::EventBridge::Types::CreateConnectionAuthRequestParameters

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 CreateConnectionAuthRequestParameters data as a hash:

{
  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,
      },
    ],
  },
}

Contains the authorization parameters for the connection.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_key_auth_parametersTypes::CreateConnectionApiKeyAuthRequestParameters

A CreateConnectionApiKeyAuthRequestParameters object that contains the API key authorization parameters to use for the connection.



1008
1009
1010
1011
1012
1013
1014
1015
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1008

class CreateConnectionAuthRequestParameters < Struct.new(
  :basic_auth_parameters,
  :o_auth_parameters,
  :api_key_auth_parameters,
  :invocation_http_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#basic_auth_parametersTypes::CreateConnectionBasicAuthRequestParameters

A CreateConnectionBasicAuthRequestParameters object that contains the Basic authorization parameters to use for the connection.



1008
1009
1010
1011
1012
1013
1014
1015
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1008

class CreateConnectionAuthRequestParameters < Struct.new(
  :basic_auth_parameters,
  :o_auth_parameters,
  :api_key_auth_parameters,
  :invocation_http_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#invocation_http_parametersTypes::ConnectionHttpParameters

A ConnectionHttpParameters object that contains the API key authorization parameters to use for the connection. Note that if you include additional parameters for the target of a rule via HttpParameters, including query strings, the parameters added for the connection take precedence.



1008
1009
1010
1011
1012
1013
1014
1015
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1008

class CreateConnectionAuthRequestParameters < Struct.new(
  :basic_auth_parameters,
  :o_auth_parameters,
  :api_key_auth_parameters,
  :invocation_http_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#o_auth_parametersTypes::CreateConnectionOAuthRequestParameters

A CreateConnectionOAuthRequestParameters object that contains the OAuth authorization parameters to use for the connection.



1008
1009
1010
1011
1012
1013
1014
1015
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1008

class CreateConnectionAuthRequestParameters < Struct.new(
  :basic_auth_parameters,
  :o_auth_parameters,
  :api_key_auth_parameters,
  :invocation_http_parameters)
  SENSITIVE = []
  include Aws::Structure
end