This is the multi-page printable view of this section. Click here to print.
Create role
1 - 1.3
scpcli iam role create
--version <value>
--statement <value>
--policy_ids <value>
--name <value>
[--account_id <value>]
[--description <value>]
[--max_session_duration <value>]
[--principals <value>]
[--role_type <value>]
[--tags <value>]
Description
Create role
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_ids required | array | Policy ID List to Attach to Role | 37f2e31ff86b415698d7e8eeafab445d |
| name required | string | Role Name | - |
| account_id optional | string | Account ID | - |
| description optional | string | Role Description | - |
| max_session_duration optional | integer | Role Maximum Session Duration (seconds) | 3600 |
| principals optional | array | Trust Policy Principal List | '{"type": "", "value": ""}' |
| role_type optional | string | Role Type | - |
| tags optional | array | Role Tag | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role Type |
2 - 1.2
scpcli iam role create
--version <value>
--statement <value>
--policy_ids <value>
--name <value>
[--account_id <value>]
[--description <value>]
[--max_session_duration <value>]
[--principals <value>]
[--tags <value>]
Description
Create role
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260930 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_ids required | array | Policy ID List to Attach to Role | 37f2e31ff86b415698d7e8eeafab445d |
| name required | string | Role Name | - |
| account_id optional | string | Account ID | - |
| description optional | string | Role Description | - |
| max_session_duration optional | integer | Role Maximum Session Duration (seconds) | 3600 |
| principals optional | array | Trust Policy Principal List | '{"type": "", "value": ""}' |
| tags optional | array | Role Tag | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role Type |
3 - 1.1
scpcli iam role create
--version <value>
--statement <value>
--policy_ids <value>
--name <value>
[--account_id <value>]
[--description <value>]
[--max_session_duration <value>]
[--principals <value>]
[--tags <value>]
Description
Create role
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_ids required | array | Policy ID List to Attach to Role | 37f2e31ff86b415698d7e8eeafab445d |
| name required | string | Role Name | - |
| account_id optional | string | Account ID | - |
| description optional | string | Role Description | - |
| max_session_duration optional | integer | Role Maximum Session Duration (seconds) | 3600 |
| principals optional | array | Trust Policy Principal List | '{"type": "", "value": ""}' |
| tags optional | array | Role Tag | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role Type |
4 - 1.0
scpcli iam role create
--version <value>
--statement <value>
--policy_ids <value>
--name <value>
[--account_id <value>]
[--description <value>]
[--max_session_duration <value>]
[--principals <value>]
[--tags <value>]
Description
Create role
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260223 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| version required | string | Policy Version | 2024-07-01 |
| statement required | array | Statement | '{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}' |
| policy_ids required | array | Policy ID List to Attach to Role | 37f2e31ff86b415698d7e8eeafab445d |
| name required | string | Role Name | - |
| account_id optional | string | Account ID | - |
| description optional | string | Role Description | - |
| max_session_duration optional | integer | Role Maximum Session Duration (seconds) | 3600 |
| principals optional | array | Trust Policy Principal List | '{"type": "", "value": ""}' |
| tags optional | array | Role Tag | {'key': 'company', 'value': 'SDS'} |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | f39c460fade34fecb05ede8f904b24b7 |
| account_id | Account ID | |
| assume_role_policy_document | Role Trust Policy | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Creator | ef50cdc207f05f6fb8f20219f229ed1f |
| creator_email | Creator Email | |
| creator_name | Creator Last Name, First Name | |
| description | Role Description | |
| max_session_duration | Role Maximum Session Duration (seconds) | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modifier | ef50cdc207f05f6fb8f20219f229ed1f |
| modifier_email | Modifier Email | |
| modifier_name | Modifier Last Name, First Name | |
| name | Role Name | |
| policies | Policy List Attached to Role | |
| type | Role Type |