Class: Aws::Appflow::Types::AuthParameter

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

Overview

Information about required authentication parameters.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#connector_supplied_values ⇒ Array<String>

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

Returns:

  • (Array<String>) 

171
172
173
174
175
176
177
178
179
180
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 171

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

#description ⇒ String

A description about the authentication parameter.

Returns:

  • (String) 

171
172
173
174
175
176
177
178
179
180
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 171

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

#is_required ⇒ Boolean

Indicates whether this authentication parameter is required.

Returns:

  • (Boolean) 

171
172
173
174
175
176
177
178
179
180
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 171

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

#is_sensitive_field ⇒ Boolean

Indicates whether this authentication parameter is a sensitive field.

Returns:

  • (Boolean) 

171
172
173
174
175
176
177
178
179
180
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 171

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

#key ⇒ String

The authentication key required to authenticate with the connector.

Returns:

  • (String) 

171
172
173
174
175
176
177
178
179
180
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 171

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

#label ⇒ String

Label used for authentication parameter.

Returns:

  • (String) 

171
172
173
174
175
176
177
178
179
180
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 171

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