You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::APIGateway::Types::SdkConfigurationProperty

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

Overview

A configuration property of an SDK type.

Instance Attribute Summary collapse

Instance Attribute Details

#default_valueString

The default value of an SdkType configuration property.

Returns:

  • (String)


5401
5402
5403
5404
5405
5406
5407
5408
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5401

class SdkConfigurationProperty < Struct.new(
  :name,
  :friendly_name,
  :description,
  :required,
  :default_value)
  include Aws::Structure
end

#descriptionString

The description of an SdkType configuration property.

Returns:

  • (String)


5401
5402
5403
5404
5405
5406
5407
5408
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5401

class SdkConfigurationProperty < Struct.new(
  :name,
  :friendly_name,
  :description,
  :required,
  :default_value)
  include Aws::Structure
end

#friendly_nameString

The user-friendly name of an SdkType configuration property.

Returns:

  • (String)


5401
5402
5403
5404
5405
5406
5407
5408
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5401

class SdkConfigurationProperty < Struct.new(
  :name,
  :friendly_name,
  :description,
  :required,
  :default_value)
  include Aws::Structure
end

#nameString

The name of a an SdkType configuration property.

Returns:

  • (String)


5401
5402
5403
5404
5405
5406
5407
5408
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5401

class SdkConfigurationProperty < Struct.new(
  :name,
  :friendly_name,
  :description,
  :required,
  :default_value)
  include Aws::Structure
end

#requiredBoolean

A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false).

Returns:

  • (Boolean)


5401
5402
5403
5404
5405
5406
5407
5408
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5401

class SdkConfigurationProperty < Struct.new(
  :name,
  :friendly_name,
  :description,
  :required,
  :default_value)
  include Aws::Structure
end