Cloud.Service.AWS.IAM.Role | vRealize Automation 8.0 Resource Type Schema

Cloud.Service.AWS.IAM.Role

JSON Example

{
    "arn": "string",
    "assume_role_policy": "string",
    "create_date": "string",
    "description": "string",
    "force_detach_policies": false,
    "max_session_duration": 0,
    "name": "string",
    "name_prefix": "string",
    "path": "string",
    "permissions_boundary": "string",
    "provider": "string",
    "provider_region": "string",
    "unique_id": "string"
}

string

arn

Optional

The Amazon Resource Name (ARN) assigned by AWS to the role.

string

assume_role_policy

Required

(Required) Policy that grants an entity permission to assume the role.

string

create_date

Optional

Date when the role was created.

string

description

Optional

Explanation of the role's purpose.

boolean

force_detach_policies

Optional

Whether to force that detaching of any policies that the role has, before destroying the role. Default is false.

integer

max_session_duration

Optional

Maximum lifespan for the role, in seconds. Range is 1 to 12 hours. Default is 1 hour.

string

name

Optional

Name of the Identity and Access Management (IAM) role. If omitted, Cloud Assembly assigns a unique random name. Changing the name forces a new resource to be created.

string

name_prefix

Optional

String added to the beginning of Cloud Assembly assigned names to make them unique. Changing the prefix forces a new resource to be created.

string

path

Optional

Location of the role.

string

permissions_boundary

Optional

Amazon Resource Name (ARN) of the policy used to set the permissions boundary for the role.

string

provider

Required

(Required) The name of the AWS cloud account to use for this resource

string

provider_region

Required

(Required) Target cloud region, such as us-east-1. Must be within the provider cloud account.

string

unique_id

Optional

Unique identifier assigned to the role by AWS.