Class: Aws::IAM::Types::ParameterDefinition

Inherits:

Struct

• Object
• Struct
• Aws::IAM::Types::ParameterDefinition

Defined in:

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

Overview

Defines a parameter that a role template accepts. You supply values for these parameters when you create a role with AcquireRole.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #default_value ⇒ String

  The value that the service uses for the parameter when you do not supply one.

• #description ⇒ String

  A description of the parameter.

• #immutable ⇒ Boolean

  Specifies whether you can change the parameter value after you create the role.

• #is_required ⇒ Boolean

  Specifies whether you must supply a value for the parameter when you create a role from the template.

• #name ⇒ String

  The name of the parameter.

• #sub_type ⇒ String

  An optional subtype that further constrains the values that are allowed for the parameter.

• #type ⇒ String

  The data type of the parameter.

Instance Attribute Details

#default_value ⇒ String

The value that the service uses for the parameter when you do not supply one.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9150

class ParameterDefinition < Struct.new(
  :name,
  :type,
  :sub_type,
  :description,
  :is_required,
  :default_value,
  :immutable)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the parameter.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9150

class ParameterDefinition < Struct.new(
  :name,
  :type,
  :sub_type,
  :description,
  :is_required,
  :default_value,
  :immutable)
  SENSITIVE = []
  include Aws::Structure
end

#immutable ⇒ Boolean

Specifies whether you can change the parameter value after you create the role.

Returns:

• (Boolean)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9150

class ParameterDefinition < Struct.new(
  :name,
  :type,
  :sub_type,
  :description,
  :is_required,
  :default_value,
  :immutable)
  SENSITIVE = []
  include Aws::Structure
end

#is_required ⇒ Boolean

Specifies whether you must supply a value for the parameter when you create a role from the template.

Returns:

• (Boolean)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9150

class ParameterDefinition < Struct.new(
  :name,
  :type,
  :sub_type,
  :description,
  :is_required,
  :default_value,
  :immutable)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the parameter.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9150

class ParameterDefinition < Struct.new(
  :name,
  :type,
  :sub_type,
  :description,
  :is_required,
  :default_value,
  :immutable)
  SENSITIVE = []
  include Aws::Structure
end

#sub_type ⇒ String

An optional subtype that further constrains the values that are allowed for the parameter.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9150

class ParameterDefinition < Struct.new(
  :name,
  :type,
  :sub_type,
  :description,
  :is_required,
  :default_value,
  :immutable)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The data type of the parameter. Valid values are String, StringList, Number, NumberList, Arn, and ArnList.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9150

class ParameterDefinition < Struct.new(
  :name,
  :type,
  :sub_type,
  :description,
  :is_required,
  :default_value,
  :immutable)
  SENSITIVE = []
  include Aws::Structure
end