Class: Aws::QuickSight::Types::CreateOAuthClientApplicationRequest

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::CreateOAuthClientApplicationRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:client_id, :client_secret, :o_auth_token_endpoint_url, :o_auth_authorization_endpoint_url]

Instance Attribute Summary

• #aws_account_id ⇒ String

  The Amazon Web Services account ID.

• #client_id ⇒ String

  The client ID of the OAuth application that is registered with the identity provider.

• #client_secret ⇒ String

  The client secret of the OAuth application that is registered with the identity provider.

• #data_source_type ⇒ String

  The type of data source that the OAuthClientApplication is used with.

• #identity_provider_vpc_connection_properties ⇒ Types::VpcConnectionProperties

  VPC connection properties.

• #name ⇒ String

  The display name for the OAuthClientApplication.

• #o_auth_authorization_endpoint_url ⇒ String

  The authorization endpoint URL of the identity provider that is used to obtain authorization codes.

• #o_auth_client_application_id ⇒ String

  An ID for the OAuthClientApplication that you want to create.

• #o_auth_client_authentication_type ⇒ String

  The authentication type to use for the OAuthClientApplication.

• #o_auth_scopes ⇒ String

  The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.

• #o_auth_token_endpoint_url ⇒ String

  The token endpoint URL of the identity provider that is used to obtain access tokens.

• #tags ⇒ Array<Types::Tag>

  Contains a map of the key-value pairs for the resource tag or tags assigned to the OAuthClientApplication.

Instance Attribute Details

#aws_account_id ⇒ String

The Amazon Web Services account ID.

Returns:

• (String)

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

class CreateOAuthClientApplicationRequest < Struct.new(
  :aws_account_id,
  :o_auth_client_application_id,
  :name,
  :o_auth_client_authentication_type,
  :client_id,
  :client_secret,
  :o_auth_token_endpoint_url,
  :o_auth_authorization_endpoint_url,
  :o_auth_scopes,
  :data_source_type,
  :identity_provider_vpc_connection_properties,
  :tags)
  SENSITIVE = [:client_id, :client_secret, :o_auth_token_endpoint_url, :o_auth_authorization_endpoint_url]
  include Aws::Structure
end

#client_id ⇒ String

The client ID of the OAuth application that is registered with the identity provider.

Returns:

• (String)

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

class CreateOAuthClientApplicationRequest < Struct.new(
  :aws_account_id,
  :o_auth_client_application_id,
  :name,
  :o_auth_client_authentication_type,
  :client_id,
  :client_secret,
  :o_auth_token_endpoint_url,
  :o_auth_authorization_endpoint_url,
  :o_auth_scopes,
  :data_source_type,
  :identity_provider_vpc_connection_properties,
  :tags)
  SENSITIVE = [:client_id, :client_secret, :o_auth_token_endpoint_url, :o_auth_authorization_endpoint_url]
  include Aws::Structure
end

#client_secret ⇒ String

The client secret of the OAuth application that is registered with the identity provider.

Returns:

• (String)

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

class CreateOAuthClientApplicationRequest < Struct.new(
  :aws_account_id,
  :o_auth_client_application_id,
  :name,
  :o_auth_client_authentication_type,
  :client_id,
  :client_secret,
  :o_auth_token_endpoint_url,
  :o_auth_authorization_endpoint_url,
  :o_auth_scopes,
  :data_source_type,
  :identity_provider_vpc_connection_properties,
  :tags)
  SENSITIVE = [:client_id, :client_secret, :o_auth_token_endpoint_url, :o_auth_authorization_endpoint_url]
  include Aws::Structure
end

#data_source_type ⇒ String

The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.

Returns:

• (String)

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

class CreateOAuthClientApplicationRequest < Struct.new(
  :aws_account_id,
  :o_auth_client_application_id,
  :name,
  :o_auth_client_authentication_type,
  :client_id,
  :client_secret,
  :o_auth_token_endpoint_url,
  :o_auth_authorization_endpoint_url,
  :o_auth_scopes,
  :data_source_type,
  :identity_provider_vpc_connection_properties,
  :tags)
  SENSITIVE = [:client_id, :client_secret, :o_auth_token_endpoint_url, :o_auth_authorization_endpoint_url]
  include Aws::Structure
end

#identity_provider_vpc_connection_properties ⇒ Types::VpcConnectionProperties

VPC connection properties.

Returns:

• (Types::VpcConnectionProperties)

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

class CreateOAuthClientApplicationRequest < Struct.new(
  :aws_account_id,
  :o_auth_client_application_id,
  :name,
  :o_auth_client_authentication_type,
  :client_id,
  :client_secret,
  :o_auth_token_endpoint_url,
  :o_auth_authorization_endpoint_url,
  :o_auth_scopes,
  :data_source_type,
  :identity_provider_vpc_connection_properties,
  :tags)
  SENSITIVE = [:client_id, :client_secret, :o_auth_token_endpoint_url, :o_auth_authorization_endpoint_url]
  include Aws::Structure
end

#name ⇒ String

The display name for the OAuthClientApplication.

Returns:

• (String)

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

class CreateOAuthClientApplicationRequest < Struct.new(
  :aws_account_id,
  :o_auth_client_application_id,
  :name,
  :o_auth_client_authentication_type,
  :client_id,
  :client_secret,
  :o_auth_token_endpoint_url,
  :o_auth_authorization_endpoint_url,
  :o_auth_scopes,
  :data_source_type,
  :identity_provider_vpc_connection_properties,
  :tags)
  SENSITIVE = [:client_id, :client_secret, :o_auth_token_endpoint_url, :o_auth_authorization_endpoint_url]
  include Aws::Structure
end

#o_auth_authorization_endpoint_url ⇒ String

The authorization endpoint URL of the identity provider that is used to obtain authorization codes.

Returns:

• (String)

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

class CreateOAuthClientApplicationRequest < Struct.new(
  :aws_account_id,
  :o_auth_client_application_id,
  :name,
  :o_auth_client_authentication_type,
  :client_id,
  :client_secret,
  :o_auth_token_endpoint_url,
  :o_auth_authorization_endpoint_url,
  :o_auth_scopes,
  :data_source_type,
  :identity_provider_vpc_connection_properties,
  :tags)
  SENSITIVE = [:client_id, :client_secret, :o_auth_token_endpoint_url, :o_auth_authorization_endpoint_url]
  include Aws::Structure
end

#o_auth_client_application_id ⇒ String

An ID for the OAuthClientApplication that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

• (String)

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

class CreateOAuthClientApplicationRequest < Struct.new(
  :aws_account_id,
  :o_auth_client_application_id,
  :name,
  :o_auth_client_authentication_type,
  :client_id,
  :client_secret,
  :o_auth_token_endpoint_url,
  :o_auth_authorization_endpoint_url,
  :o_auth_scopes,
  :data_source_type,
  :identity_provider_vpc_connection_properties,
  :tags)
  SENSITIVE = [:client_id, :client_secret, :o_auth_token_endpoint_url, :o_auth_authorization_endpoint_url]
  include Aws::Structure
end

#o_auth_client_authentication_type ⇒ String

The authentication type to use for the OAuthClientApplication. This determines the OAuth 2.0 grant flow that is used when the data source connects to the identity provider. Valid values are TOKEN.

Returns:

• (String)

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

class CreateOAuthClientApplicationRequest < Struct.new(
  :aws_account_id,
  :o_auth_client_application_id,
  :name,
  :o_auth_client_authentication_type,
  :client_id,
  :client_secret,
  :o_auth_token_endpoint_url,
  :o_auth_authorization_endpoint_url,
  :o_auth_scopes,
  :data_source_type,
  :identity_provider_vpc_connection_properties,
  :tags)
  SENSITIVE = [:client_id, :client_secret, :o_auth_token_endpoint_url, :o_auth_authorization_endpoint_url]
  include Aws::Structure
end

#o_auth_scopes ⇒ String

The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.

Returns:

• (String)

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

class CreateOAuthClientApplicationRequest < Struct.new(
  :aws_account_id,
  :o_auth_client_application_id,
  :name,
  :o_auth_client_authentication_type,
  :client_id,
  :client_secret,
  :o_auth_token_endpoint_url,
  :o_auth_authorization_endpoint_url,
  :o_auth_scopes,
  :data_source_type,
  :identity_provider_vpc_connection_properties,
  :tags)
  SENSITIVE = [:client_id, :client_secret, :o_auth_token_endpoint_url, :o_auth_authorization_endpoint_url]
  include Aws::Structure
end

#o_auth_token_endpoint_url ⇒ String

The token endpoint URL of the identity provider that is used to obtain access tokens.

Returns:

• (String)

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

class CreateOAuthClientApplicationRequest < Struct.new(
  :aws_account_id,
  :o_auth_client_application_id,
  :name,
  :o_auth_client_authentication_type,
  :client_id,
  :client_secret,
  :o_auth_token_endpoint_url,
  :o_auth_authorization_endpoint_url,
  :o_auth_scopes,
  :data_source_type,
  :identity_provider_vpc_connection_properties,
  :tags)
  SENSITIVE = [:client_id, :client_secret, :o_auth_token_endpoint_url, :o_auth_authorization_endpoint_url]
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Contains a map of the key-value pairs for the resource tag or tags assigned to the OAuthClientApplication.

Returns:

• (Array<Types::Tag>)

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

class CreateOAuthClientApplicationRequest < Struct.new(
  :aws_account_id,
  :o_auth_client_application_id,
  :name,
  :o_auth_client_authentication_type,
  :client_id,
  :client_secret,
  :o_auth_token_endpoint_url,
  :o_auth_authorization_endpoint_url,
  :o_auth_scopes,
  :data_source_type,
  :identity_provider_vpc_connection_properties,
  :tags)
  SENSITIVE = [:client_id, :client_secret, :o_auth_token_endpoint_url, :o_auth_authorization_endpoint_url]
  include Aws::Structure
end