Class: Aws::QuickSight::Types::AuthenticationMetadata

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::AuthenticationMetadata

Defined in:

gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

Note:

AuthenticationMetadata is a union - when making an API calls you must set exactly one of the members.

Union type containing authentication metadata for different authentication methods.

See Also:

• AWS API Documentation

Direct Known Subclasses

ApiKeyConnectionMetadata, AuthorizationCodeGrantMetadata, BasicAuthConnectionMetadata, ClientCredentialsGrantMetadata, IamConnectionMetadata, NoneConnectionMetadata, Unknown

Defined Under Namespace

Classes: ApiKeyConnectionMetadata, AuthorizationCodeGrantMetadata, BasicAuthConnectionMetadata, ClientCredentialsGrantMetadata, IamConnectionMetadata, NoneConnectionMetadata, Unknown

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #api_key_connection_metadata ⇒ Types::APIKeyConnectionMetadata

  API key authentication metadata.

• #authorization_code_grant_metadata ⇒ Types::AuthorizationCodeGrantMetadata

  OAuth 2.0 authorization code grant authentication metadata.

• #basic_auth_connection_metadata ⇒ Types::BasicAuthConnectionMetadata

  Basic authentication metadata using username and password.

• #client_credentials_grant_metadata ⇒ Types::ClientCredentialsGrantMetadata

  OAuth 2.0 client credentials grant authentication metadata.

• #iam_connection_metadata ⇒ Types::IAMConnectionMetadata

  IAM role-based authentication metadata for Amazon Web Services services.

• #none_connection_metadata ⇒ Types::NoneConnectionMetadata

  No authentication metadata for services that don't require authentication.

• #unknown ⇒ Object

  Returns the value of attribute unknown.

Instance Attribute Details

#api_key_connection_metadata ⇒ Types::APIKeyConnectionMetadata

API key authentication metadata.

Returns:

• (Types::APIKeyConnectionMetadata)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2742

class AuthenticationMetadata < Struct.new(
  :authorization_code_grant_metadata,
  :client_credentials_grant_metadata,
  :basic_auth_connection_metadata,
  :api_key_connection_metadata,
  :none_connection_metadata,
  :iam_connection_metadata,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AuthorizationCodeGrantMetadata < AuthenticationMetadata; end
  class ClientCredentialsGrantMetadata < AuthenticationMetadata; end
  class BasicAuthConnectionMetadata < AuthenticationMetadata; end
  class ApiKeyConnectionMetadata < AuthenticationMetadata; end
  class NoneConnectionMetadata < AuthenticationMetadata; end
  class IamConnectionMetadata < AuthenticationMetadata; end
  class Unknown < AuthenticationMetadata; end
end

#authorization_code_grant_metadata ⇒ Types::AuthorizationCodeGrantMetadata

OAuth 2.0 authorization code grant authentication metadata.

Returns:

• (Types::AuthorizationCodeGrantMetadata)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2742

class AuthenticationMetadata < Struct.new(
  :authorization_code_grant_metadata,
  :client_credentials_grant_metadata,
  :basic_auth_connection_metadata,
  :api_key_connection_metadata,
  :none_connection_metadata,
  :iam_connection_metadata,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AuthorizationCodeGrantMetadata < AuthenticationMetadata; end
  class ClientCredentialsGrantMetadata < AuthenticationMetadata; end
  class BasicAuthConnectionMetadata < AuthenticationMetadata; end
  class ApiKeyConnectionMetadata < AuthenticationMetadata; end
  class NoneConnectionMetadata < AuthenticationMetadata; end
  class IamConnectionMetadata < AuthenticationMetadata; end
  class Unknown < AuthenticationMetadata; end
end

#basic_auth_connection_metadata ⇒ Types::BasicAuthConnectionMetadata

Basic authentication metadata using username and password.

Returns:

• (Types::BasicAuthConnectionMetadata)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2742

class AuthenticationMetadata < Struct.new(
  :authorization_code_grant_metadata,
  :client_credentials_grant_metadata,
  :basic_auth_connection_metadata,
  :api_key_connection_metadata,
  :none_connection_metadata,
  :iam_connection_metadata,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AuthorizationCodeGrantMetadata < AuthenticationMetadata; end
  class ClientCredentialsGrantMetadata < AuthenticationMetadata; end
  class BasicAuthConnectionMetadata < AuthenticationMetadata; end
  class ApiKeyConnectionMetadata < AuthenticationMetadata; end
  class NoneConnectionMetadata < AuthenticationMetadata; end
  class IamConnectionMetadata < AuthenticationMetadata; end
  class Unknown < AuthenticationMetadata; end
end

#client_credentials_grant_metadata ⇒ Types::ClientCredentialsGrantMetadata

OAuth 2.0 client credentials grant authentication metadata.

Returns:

• (Types::ClientCredentialsGrantMetadata)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2742

class AuthenticationMetadata < Struct.new(
  :authorization_code_grant_metadata,
  :client_credentials_grant_metadata,
  :basic_auth_connection_metadata,
  :api_key_connection_metadata,
  :none_connection_metadata,
  :iam_connection_metadata,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AuthorizationCodeGrantMetadata < AuthenticationMetadata; end
  class ClientCredentialsGrantMetadata < AuthenticationMetadata; end
  class BasicAuthConnectionMetadata < AuthenticationMetadata; end
  class ApiKeyConnectionMetadata < AuthenticationMetadata; end
  class NoneConnectionMetadata < AuthenticationMetadata; end
  class IamConnectionMetadata < AuthenticationMetadata; end
  class Unknown < AuthenticationMetadata; end
end

#iam_connection_metadata ⇒ Types::IAMConnectionMetadata

IAM role-based authentication metadata for Amazon Web Services services.

Returns:

• (Types::IAMConnectionMetadata)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2742

class AuthenticationMetadata < Struct.new(
  :authorization_code_grant_metadata,
  :client_credentials_grant_metadata,
  :basic_auth_connection_metadata,
  :api_key_connection_metadata,
  :none_connection_metadata,
  :iam_connection_metadata,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AuthorizationCodeGrantMetadata < AuthenticationMetadata; end
  class ClientCredentialsGrantMetadata < AuthenticationMetadata; end
  class BasicAuthConnectionMetadata < AuthenticationMetadata; end
  class ApiKeyConnectionMetadata < AuthenticationMetadata; end
  class NoneConnectionMetadata < AuthenticationMetadata; end
  class IamConnectionMetadata < AuthenticationMetadata; end
  class Unknown < AuthenticationMetadata; end
end

#none_connection_metadata ⇒ Types::NoneConnectionMetadata

No authentication metadata for services that don't require authentication.

Returns:

• (Types::NoneConnectionMetadata)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2742

class AuthenticationMetadata < Struct.new(
  :authorization_code_grant_metadata,
  :client_credentials_grant_metadata,
  :basic_auth_connection_metadata,
  :api_key_connection_metadata,
  :none_connection_metadata,
  :iam_connection_metadata,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AuthorizationCodeGrantMetadata < AuthenticationMetadata; end
  class ClientCredentialsGrantMetadata < AuthenticationMetadata; end
  class BasicAuthConnectionMetadata < AuthenticationMetadata; end
  class ApiKeyConnectionMetadata < AuthenticationMetadata; end
  class NoneConnectionMetadata < AuthenticationMetadata; end
  class IamConnectionMetadata < AuthenticationMetadata; end
  class Unknown < AuthenticationMetadata; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

• (Object) —

  the current value of unknown

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2742

def unknown
  @unknown
end