Class: Aws::Appflow::Types::OAuth2CustomParameter

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

Overview

Custom parameter required for OAuth 2.0 authentication.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#connector_supplied_valuesArray<String>

Contains default values for this authentication parameter that are supplied by the connector.

Returns:

  • (Array<String>)


4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4686

class OAuth2CustomParameter < Struct.new(
  :key,
  :is_required,
  :label,
  :description,
  :is_sensitive_field,
  :connector_supplied_values,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description about the custom parameter used for OAuth 2.0 authentication.

Returns:

  • (String)


4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4686

class OAuth2CustomParameter < Struct.new(
  :key,
  :is_required,
  :label,
  :description,
  :is_sensitive_field,
  :connector_supplied_values,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#is_requiredBoolean

Indicates whether the custom parameter for OAuth 2.0 authentication is required.

Returns:

  • (Boolean)


4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4686

class OAuth2CustomParameter < Struct.new(
  :key,
  :is_required,
  :label,
  :description,
  :is_sensitive_field,
  :connector_supplied_values,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#is_sensitive_fieldBoolean

Indicates whether this authentication custom parameter is a sensitive field.

Returns:

  • (Boolean)


4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4686

class OAuth2CustomParameter < Struct.new(
  :key,
  :is_required,
  :label,
  :description,
  :is_sensitive_field,
  :connector_supplied_values,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#keyString

The key of the custom parameter required for OAuth 2.0 authentication.

Returns:

  • (String)


4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4686

class OAuth2CustomParameter < Struct.new(
  :key,
  :is_required,
  :label,
  :description,
  :is_sensitive_field,
  :connector_supplied_values,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#labelString

The label of the custom parameter used for OAuth 2.0 authentication.

Returns:

  • (String)


4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4686

class OAuth2CustomParameter < Struct.new(
  :key,
  :is_required,
  :label,
  :description,
  :is_sensitive_field,
  :connector_supplied_values,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

Indicates whether custom parameter is used with TokenUrl or AuthUrl.

Returns:

  • (String)


4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4686

class OAuth2CustomParameter < Struct.new(
  :key,
  :is_required,
  :label,
  :description,
  :is_sensitive_field,
  :connector_supplied_values,
  :type)
  SENSITIVE = []
  include Aws::Structure
end