Skip to content

RoleTemplateVersion

Source code in docs_src/capo_iam/types/role_template_version.py
class RoleTemplateVersion(TypedDict, closed=True):
    template_arn: NotRequired["capo_iam.types.arn_type.arnType"]
    """<p>The Amazon Resource Name (ARN) that identifies the role template.</p> <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>"""
    template_name: NotRequired[
        "capo_iam.types.role_template_name_type.roleTemplateNameType"
    ]
    """<p>The friendly name that identifies the role template.</p>"""
    template_version_id: NotRequired["capo_iam.types.id_type.idType"]
    """<p>The identifier of the role template version.</p>"""
    description: NotRequired[
        "capo_iam.types.role_template_description_type.roleTemplateDescriptionType"
    ]
    """<p>The description of the role template.</p>"""
    major_version: NotRequired["capo_iam.types.integer_type.integerType"]
    """<p>The major version number of the role template.</p>"""
    default_minor_version: NotRequired[
        "capo_iam.types.minor_version_type.minorVersionType"
    ]
    """<p>The minor version that the service uses by default when you create a role from this template without specifying a minor version.</p>"""
    managed_by_type: NotRequired[
        "capo_iam.types.managed_by_type_type.managedByTypeType"
    ]
    """<p>Indicates that the role template is managed by an Amazon Web Services service.</p>"""
    managed_by_value: NotRequired[
        "capo_iam.types.managed_by_value_type.managedByValueType"
    ]
    """<p>The identifier of the Amazon Web Services service that manages the role template.</p>"""
    enabled: "capo_iam.types.boolean_type.booleanType"
    """<p>Specifies whether the role template is enabled. When a template is disabled, you cannot create roles from it.</p>"""
    minor_version: NotRequired["capo_iam.types.minor_version_type.minorVersionType"]
    """<p>The minor version number of this role template version.</p>"""
    role_name_pattern: NotRequired[
        "capo_iam.types.role_name_pattern_type.roleNamePatternType"
    ]
    """<p>The pattern that is used to generate the name of a role that is created from this template. The pattern can include <code>@{parameter}</code> placeholders that are replaced with the values you supply in the <code>ReplacementValues</code> parameter of <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_AcquireRole.html">AcquireRole</a>.</p>"""
    role_path_pattern: NotRequired[
        "capo_iam.types.role_path_pattern_type.rolePathPatternType"
    ]
    """<p>The pattern that is used to generate the path of a role that is created from this template.</p>"""
    role_description_pattern: NotRequired[
        "capo_iam.types.role_description_pattern_type.roleDescriptionPatternType"
    ]
    """<p>The pattern that is used to generate the description of a role that is created from this template.</p>"""
    assume_role_policy_document_template: NotRequired[
        "capo_iam.types.policy_document_type.policyDocumentType"
    ]
    """<p>The trust policy template that grants an entity permission to assume roles that you create from this template.</p>"""
    inline_policy_templates: NotRequired[
        "capo_iam.types.inline_policy_template_list_type.inlinePolicyTemplateListType"
    ]
    """<p>A list of inline policy templates that the service embeds in roles that you create from this template.</p>"""
    managed_policy_arns: NotRequired[
        "capo_iam.types.managed_policy_arn_list_type.managedPolicyArnListType"
    ]
    """<p>A list of the ARNs of the managed policies that the service attaches to roles that you create from this template.</p>"""
    permission_boundary_arn: NotRequired["capo_iam.types.arn_type.arnType"]
    """<p>The ARN of the policy that sets the permissions boundary for roles that you create from this template.</p> <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>"""
    parameters_definition: NotRequired[
        "capo_iam.types.parameters_definition_list_type.parametersDefinitionListType"
    ]
    """<p>A list of the parameters that are defined for this role template version. You supply values for these parameters when you create a role with <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_AcquireRole.html">AcquireRole</a>.</p>"""
    role_tags_template: NotRequired[
        "capo_iam.types.tag_template_list_type.tagTemplateListType"
    ]
    """<p>A list of tag templates that are applied to roles that are created from this template.</p>"""
    max_session_duration: NotRequired[
        "capo_iam.types.role_max_session_duration_type.roleMaxSessionDurationType"
    ]
    """<p>The maximum session duration (in seconds) for roles that are created from this template.</p>"""
    version_enabled: "capo_iam.types.boolean_type.booleanType"
    """<p>Specifies whether this specific minor version of the role template is enabled.</p>"""
    create_timestamp: NotRequired["capo_iam.types.date_type.dateType"]
    """<p>The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the role template version was created.</p>"""
    update_timestamp: NotRequired["capo_iam.types.date_type.dateType"]
    """<p>The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the role template version was last updated.</p>"""

assume_role_policy_document_template instance-attribute

assume_role_policy_document_template: NotRequired[policyDocumentType]

The trust policy template that grants an entity permission to assume roles that you create from this template.

create_timestamp instance-attribute

create_timestamp: NotRequired[dateType]

The date and time, in ISO 8601 date-time format, when the role template version was created.

default_minor_version instance-attribute

default_minor_version: NotRequired[minorVersionType]

The minor version that the service uses by default when you create a role from this template without specifying a minor version.

description instance-attribute

description: NotRequired[roleTemplateDescriptionType]

The description of the role template.

enabled instance-attribute

enabled: booleanType

Specifies whether the role template is enabled. When a template is disabled, you cannot create roles from it.

inline_policy_templates instance-attribute

inline_policy_templates: NotRequired[inlinePolicyTemplateListType]

A list of inline policy templates that the service embeds in roles that you create from this template.

major_version instance-attribute

major_version: NotRequired[integerType]

The major version number of the role template.

managed_by_type instance-attribute

managed_by_type: NotRequired[managedByTypeType]

Indicates that the role template is managed by an Amazon Web Services service.

managed_by_value instance-attribute

managed_by_value: NotRequired[managedByValueType]

The identifier of the Amazon Web Services service that manages the role template.

managed_policy_arns instance-attribute

managed_policy_arns: NotRequired[managedPolicyArnListType]

A list of the ARNs of the managed policies that the service attaches to roles that you create from this template.

max_session_duration instance-attribute

max_session_duration: NotRequired[roleMaxSessionDurationType]

The maximum session duration (in seconds) for roles that are created from this template.

minor_version instance-attribute

minor_version: NotRequired[minorVersionType]

The minor version number of this role template version.

parameters_definition instance-attribute

parameters_definition: NotRequired[parametersDefinitionListType]

A list of the parameters that are defined for this role template version. You supply values for these parameters when you create a role with AcquireRole.

permission_boundary_arn instance-attribute

permission_boundary_arn: NotRequired[arnType]

The ARN of the policy that sets the permissions boundary for roles that you create from this template.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

role_description_pattern instance-attribute

role_description_pattern: NotRequired[roleDescriptionPatternType]

The pattern that is used to generate the description of a role that is created from this template.

role_name_pattern instance-attribute

role_name_pattern: NotRequired[roleNamePatternType]

The pattern that is used to generate the name of a role that is created from this template. The pattern can include @{parameter} placeholders that are replaced with the values you supply in the ReplacementValues parameter of AcquireRole.

role_path_pattern instance-attribute

role_path_pattern: NotRequired[rolePathPatternType]

The pattern that is used to generate the path of a role that is created from this template.

role_tags_template instance-attribute

role_tags_template: NotRequired[tagTemplateListType]

A list of tag templates that are applied to roles that are created from this template.

template_arn instance-attribute

template_arn: NotRequired[arnType]

The Amazon Resource Name (ARN) that identifies the role template.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

template_name instance-attribute

template_name: NotRequired[roleTemplateNameType]

The friendly name that identifies the role template.

template_version_id instance-attribute

template_version_id: NotRequired[idType]

The identifier of the role template version.

update_timestamp instance-attribute

update_timestamp: NotRequired[dateType]

The date and time, in ISO 8601 date-time format, when the role template version was last updated.

version_enabled instance-attribute

version_enabled: booleanType

Specifies whether this specific minor version of the role template is enabled.