Class: Aws::EventBridge::Types::CreateConnectionOAuthRequestParameters

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

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

Contains the OAuth authorization parameters to use for the connection.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authorization_endpoint ⇒ String

The URL to the authorization endpoint when OAuth is specified as the authorization type.

Returns:

  • (String) 


1131
1132
1133
1134
1135
1136
1137
1138
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1131

class CreateConnectionOAuthRequestParameters < Struct.new(
  :client_parameters,
  :authorization_endpoint,
  :http_method,
  :o_auth_http_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#client_parameters ⇒ Types::CreateConnectionOAuthClientRequestParameters

A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for OAuth authorization.

Returns:



1131
1132
1133
1134
1135
1136
1137
1138
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1131

class CreateConnectionOAuthRequestParameters < Struct.new(
  :client_parameters,
  :authorization_endpoint,
  :http_method,
  :o_auth_http_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#http_method ⇒ String

The method to use for the authorization request.

Returns:

  • (String) 


1131
1132
1133
1134
1135
1136
1137
1138
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1131

class CreateConnectionOAuthRequestParameters < Struct.new(
  :client_parameters,
  :authorization_endpoint,
  :http_method,
  :o_auth_http_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#o_auth_http_parameters ⇒ Types::ConnectionHttpParameters

A ConnectionHttpParameters object that contains details about the additional parameters to use for the connection.

Returns:



1131
1132
1133
1134
1135
1136
1137
1138
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1131

class CreateConnectionOAuthRequestParameters < Struct.new(
  :client_parameters,
  :authorization_endpoint,
  :http_method,
  :o_auth_http_parameters)
  SENSITIVE = []
  include Aws::Structure
end