com.tencentcloudapi.sts.v20180813.models

Class AssumeRoleRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.sts.v20180813.models.AssumeRoleRequest

public class AssumeRoleRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
AssumeRoleRequest()
AssumeRoleRequest(AssumeRoleRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
Long	getDurationSeconds() Get Specifies the validity period of credentials in seconds.
String	getExternalId() Get External role ID, which can be obtained by clicking the role name in the [CAM console](https://console.cloud.tencent.com/cam/role).
String	getPolicy() Get Policy description Note: 1.
String	getRoleArn() Get Resource descriptions of a role, which can be obtained by clicking the role name in the [CAM console](https://console.cloud.tencent.com/cam/role).
String	getRoleSessionName() Get User-defined temporary session name.
String	getSourceIdentity() Get UIN of the initiator
Tag[]	getTags() Get List of session tags.
void	setDurationSeconds(Long DurationSeconds) Set Specifies the validity period of credentials in seconds.
void	setExternalId(String ExternalId) Set External role ID, which can be obtained by clicking the role name in the [CAM console](https://console.cloud.tencent.com/cam/role).
void	setPolicy(String Policy) Set Policy description Note: 1.
void	setRoleArn(String RoleArn) Set Resource descriptions of a role, which can be obtained by clicking the role name in the [CAM console](https://console.cloud.tencent.com/cam/role).
void	setRoleSessionName(String RoleSessionName) Set User-defined temporary session name.
void	setSourceIdentity(String SourceIdentity) Set UIN of the initiator
void	setTags(Tag[] Tags) Set List of session tags.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssumeRoleRequest

public AssumeRoleRequest()

AssumeRoleRequest

public AssumeRoleRequest(AssumeRoleRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getRoleArn

public String getRoleArn()

Get Resource descriptions of a role, which can be obtained by clicking the role name in the [CAM console](https://console.cloud.tencent.com/cam/role). General role: qcs::cam::uin/12345678:role/4611686018427397919, qcs::cam::uin/12345678:roleName/testRoleName Service role: qcs::cam::uin/12345678:role/tencentcloudServiceRole/4611686018427397920, qcs::cam::uin/12345678:role/tencentcloudServiceRoleName/testServiceRoleName

Returns:

RoleArn Resource descriptions of a role, which can be obtained by clicking the role name in the [CAM console](https://console.cloud.tencent.com/cam/role). General role: qcs::cam::uin/12345678:role/4611686018427397919, qcs::cam::uin/12345678:roleName/testRoleName Service role: qcs::cam::uin/12345678:role/tencentcloudServiceRole/4611686018427397920, qcs::cam::uin/12345678:role/tencentcloudServiceRoleName/testServiceRoleName

setRoleArn

public void setRoleArn(String RoleArn)

Set Resource descriptions of a role, which can be obtained by clicking the role name in the [CAM console](https://console.cloud.tencent.com/cam/role). General role: qcs::cam::uin/12345678:role/4611686018427397919, qcs::cam::uin/12345678:roleName/testRoleName Service role: qcs::cam::uin/12345678:role/tencentcloudServiceRole/4611686018427397920, qcs::cam::uin/12345678:role/tencentcloudServiceRoleName/testServiceRoleName

Parameters:

RoleArn - Resource descriptions of a role, which can be obtained by clicking the role name in the [CAM console](https://console.cloud.tencent.com/cam/role). General role: qcs::cam::uin/12345678:role/4611686018427397919, qcs::cam::uin/12345678:roleName/testRoleName Service role: qcs::cam::uin/12345678:role/tencentcloudServiceRole/4611686018427397920, qcs::cam::uin/12345678:role/tencentcloudServiceRoleName/testServiceRoleName

getRoleSessionName

public String getRoleSessionName()

Get User-defined temporary session name. It can contain 2-128 letters, digits, and symbols (=,.@_-). Regex: [\w+=,.@_-]*

Returns:

RoleSessionName User-defined temporary session name. It can contain 2-128 letters, digits, and symbols (=,.@_-). Regex: [\w+=,.@_-]*

setRoleSessionName

public void setRoleSessionName(String RoleSessionName)

Set User-defined temporary session name. It can contain 2-128 letters, digits, and symbols (=,.@_-). Regex: [\w+=,.@_-]*

Parameters:

RoleSessionName - User-defined temporary session name. It can contain 2-128 letters, digits, and symbols (=,.@_-). Regex: [\w+=,.@_-]*

getDurationSeconds

public Long getDurationSeconds()

Get Specifies the validity period of credentials in seconds. Default value: 7200. Maximum value: 43200

Returns:

DurationSeconds Specifies the validity period of credentials in seconds. Default value: 7200. Maximum value: 43200

setDurationSeconds

public void setDurationSeconds(Long DurationSeconds)

Set Specifies the validity period of credentials in seconds. Default value: 7200. Maximum value: 43200

Parameters:

DurationSeconds - Specifies the validity period of credentials in seconds. Default value: 7200. Maximum value: 43200

getPolicy

public String getPolicy()

Get Policy description Note: 1. The policy needs to be URL-encoded (if you request a TencentCloud API through the GET method, all parameters must be URL-encoded again in accordance with [Signature v3](https://intl.cloud.tencent.com/document/api/598/33159?from_cn_redirect=1#1.-.E6.8B.BC.E6.8E.A5.E8.A7.84.E8.8C.83.E8.AF.B7.E6.B1.82.E4.B8.B2) before the request is sent). 2. For the policy syntax, please see CAM's [Syntax Logic](https://intl.cloud.tencent.com/document/product/598/10603?from_cn_redirect=1). 3. The policy cannot contain the `principal` element.

Returns:

Policy Policy description Note: 1. The policy needs to be URL-encoded (if you request a TencentCloud API through the GET method, all parameters must be URL-encoded again in accordance with [Signature v3](https://intl.cloud.tencent.com/document/api/598/33159?from_cn_redirect=1#1.-.E6.8B.BC.E6.8E.A5.E8.A7.84.E8.8C.83.E8.AF.B7.E6.B1.82.E4.B8.B2) before the request is sent). 2. For the policy syntax, please see CAM's [Syntax Logic](https://intl.cloud.tencent.com/document/product/598/10603?from_cn_redirect=1). 3. The policy cannot contain the `principal` element.

setPolicy

public void setPolicy(String Policy)

Set Policy description Note: 1. The policy needs to be URL-encoded (if you request a TencentCloud API through the GET method, all parameters must be URL-encoded again in accordance with [Signature v3](https://intl.cloud.tencent.com/document/api/598/33159?from_cn_redirect=1#1.-.E6.8B.BC.E6.8E.A5.E8.A7.84.E8.8C.83.E8.AF.B7.E6.B1.82.E4.B8.B2) before the request is sent). 2. For the policy syntax, please see CAM's [Syntax Logic](https://intl.cloud.tencent.com/document/product/598/10603?from_cn_redirect=1). 3. The policy cannot contain the `principal` element.

Parameters:

Policy - Policy description Note: 1. The policy needs to be URL-encoded (if you request a TencentCloud API through the GET method, all parameters must be URL-encoded again in accordance with [Signature v3](https://intl.cloud.tencent.com/document/api/598/33159?from_cn_redirect=1#1.-.E6.8B.BC.E6.8E.A5.E8.A7.84.E8.8C.83.E8.AF.B7.E6.B1.82.E4.B8.B2) before the request is sent). 2. For the policy syntax, please see CAM's [Syntax Logic](https://intl.cloud.tencent.com/document/product/598/10603?from_cn_redirect=1). 3. The policy cannot contain the `principal` element.

getExternalId

public String getExternalId()

Get External role ID, which can be obtained by clicking the role name in the [CAM console](https://console.cloud.tencent.com/cam/role). It can contain 2-128 letters, digits, and symbols (=,.@:/-). Regex: [\w+=,.@:\/-]*

Returns:

ExternalId External role ID, which can be obtained by clicking the role name in the [CAM console](https://console.cloud.tencent.com/cam/role). It can contain 2-128 letters, digits, and symbols (=,.@:/-). Regex: [\w+=,.@:\/-]*

setExternalId

public void setExternalId(String ExternalId)

Set External role ID, which can be obtained by clicking the role name in the [CAM console](https://console.cloud.tencent.com/cam/role). It can contain 2-128 letters, digits, and symbols (=,.@:/-). Regex: [\w+=,.@:\/-]*

Parameters:

ExternalId - External role ID, which can be obtained by clicking the role name in the [CAM console](https://console.cloud.tencent.com/cam/role). It can contain 2-128 letters, digits, and symbols (=,.@:/-). Regex: [\w+=,.@:\/-]*

getTags

public Tag[] getTags()

Get List of session tags. Up to 50 tags are allowed. The tag keys can not duplicate.

Returns:

Tags List of session tags. Up to 50 tags are allowed. The tag keys can not duplicate.

setTags

public void setTags(Tag[] Tags)

Set List of session tags. Up to 50 tags are allowed. The tag keys can not duplicate.

Parameters:

Tags - List of session tags. Up to 50 tags are allowed. The tag keys can not duplicate.

getSourceIdentity

public String getSourceIdentity()

Get UIN of the initiator

Returns:

SourceIdentity UIN of the initiator

setSourceIdentity

public void setSourceIdentity(String SourceIdentity)

Set UIN of the initiator

Parameters:

SourceIdentity - UIN of the initiator

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.