Skip to content

IAM  >  Structures  >  ParameterDefinition

ParameterDefinition

Structure Class

ParameterDefinition dataclass

Bases: _SerdeShape

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

Attributes

default_value class-attribute instance-attribute 
default_value: str | None = ...

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

description class-attribute instance-attribute 
description: str | None = ...

A description of the parameter.

immutable class-attribute instance-attribute 
immutable: bool = ...

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

is_required class-attribute instance-attribute 
is_required: bool = ...

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

name instance-attribute 
name: str

The name of the parameter.

sub_type class-attribute instance-attribute 
sub_type: str | None = ...

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

type instance-attribute 
type: str

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