Class: Aws::Appflow::Types::CustomConnectorProfileCredentials

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

Overview

Note:

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

{
  authentication_type: "OAUTH2", # required, accepts OAUTH2, APIKEY, BASIC, CUSTOM
  basic: {
    username: "Username", # required
    password: "Password", # required
  },
  oauth2: {
    client_id: "ClientId",
    client_secret: "ClientSecret",
    access_token: "AccessToken",
    refresh_token: "RefreshToken",
    o_auth_request: {
      auth_code: "AuthCode",
      redirect_uri: "RedirectUri",
    },
  },
  api_key: {
    api_key: "ApiKey", # required
    api_secret_key: "ApiSecretKey",
  },
  custom: {
    custom_authentication_type: "CustomAuthenticationType", # required
    credentials_map: {
      "CredentialsMapKey" => "CredentialsMapValue",
    },
  },
}

The connector-specific profile credentials that are required when using the custom connector.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_keyTypes::ApiKeyCredentials

The API keys required for the authentication of the user.



2512
2513
2514
2515
2516
2517
2518
2519
2520
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2512

class CustomConnectorProfileCredentials < Struct.new(
  :authentication_type,
  :basic,
  :oauth2,
  :api_key,
  :custom)
  SENSITIVE = []
  include Aws::Structure
end

#authentication_typeString

The authentication type that the custom connector uses for authenticating while creating a connector profile.

Returns:

  • (String)


2512
2513
2514
2515
2516
2517
2518
2519
2520
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2512

class CustomConnectorProfileCredentials < Struct.new(
  :authentication_type,
  :basic,
  :oauth2,
  :api_key,
  :custom)
  SENSITIVE = []
  include Aws::Structure
end

#basicTypes::BasicAuthCredentials

The basic credentials that are required for the authentication of the user.



2512
2513
2514
2515
2516
2517
2518
2519
2520
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2512

class CustomConnectorProfileCredentials < Struct.new(
  :authentication_type,
  :basic,
  :oauth2,
  :api_key,
  :custom)
  SENSITIVE = []
  include Aws::Structure
end

#customTypes::CustomAuthCredentials

If the connector uses the custom authentication mechanism, this holds the required credentials.



2512
2513
2514
2515
2516
2517
2518
2519
2520
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2512

class CustomConnectorProfileCredentials < Struct.new(
  :authentication_type,
  :basic,
  :oauth2,
  :api_key,
  :custom)
  SENSITIVE = []
  include Aws::Structure
end

#oauth2Types::OAuth2Credentials

The OAuth 2.0 credentials required for the authentication of the user.



2512
2513
2514
2515
2516
2517
2518
2519
2520
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2512

class CustomConnectorProfileCredentials < Struct.new(
  :authentication_type,
  :basic,
  :oauth2,
  :api_key,
  :custom)
  SENSITIVE = []
  include Aws::Structure
end