@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateRoleRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
CreateRoleRequest() |
| Modifier and Type | Method and Description |
|---|---|
CreateRoleRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getAssumeRolePolicyDocument()
The trust relationship policy document that grants an entity permission to assume the role.
|
String |
getDescription()
A description of the role.
|
Integer |
getMaxSessionDuration()
The maximum session duration (in seconds) that you want to set for the specified role.
|
String |
getPath()
The path to the role.
|
String |
getPermissionsBoundary()
The ARN of the managed policy that is used to set the permissions boundary for the role.
|
String |
getRoleName()
The name of the role to create.
|
List<Tag> |
getTags()
A list of tags that you want to attach to the new role.
|
int |
hashCode() |
void |
setAssumeRolePolicyDocument(String assumeRolePolicyDocument)
The trust relationship policy document that grants an entity permission to assume the role.
|
void |
setDescription(String description)
A description of the role.
|
void |
setMaxSessionDuration(Integer maxSessionDuration)
The maximum session duration (in seconds) that you want to set for the specified role.
|
void |
setPath(String path)
The path to the role.
|
void |
setPermissionsBoundary(String permissionsBoundary)
The ARN of the managed policy that is used to set the permissions boundary for the role.
|
void |
setRoleName(String roleName)
The name of the role to create.
|
void |
setTags(Collection<Tag> tags)
A list of tags that you want to attach to the new role.
|
String |
toString()
Returns a string representation of this object.
|
CreateRoleRequest |
withAssumeRolePolicyDocument(String assumeRolePolicyDocument)
The trust relationship policy document that grants an entity permission to assume the role.
|
CreateRoleRequest |
withDescription(String description)
A description of the role.
|
CreateRoleRequest |
withMaxSessionDuration(Integer maxSessionDuration)
The maximum session duration (in seconds) that you want to set for the specified role.
|
CreateRoleRequest |
withPath(String path)
The path to the role.
|
CreateRoleRequest |
withPermissionsBoundary(String permissionsBoundary)
The ARN of the managed policy that is used to set the permissions boundary for the role.
|
CreateRoleRequest |
withRoleName(String roleName)
The name of the role to create.
|
CreateRoleRequest |
withTags(Collection<Tag> tags)
A list of tags that you want to attach to the new role.
|
CreateRoleRequest |
withTags(Tag... tags)
A list of tags that you want to attach to the new role.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setPath(String path)
The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of
characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
slashes. In addition, it can contain any ASCII character from the ! (!) through the DEL
character (), including most punctuation characters, digits, and upper and lowercased letters.
path - The path to the role. For more information about paths, see IAM Identifiers in the
IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string
of characters consisting of either a forward slash (/) by itself or a string that must begin and end with
forward slashes. In addition, it can contain any ASCII character from the ! (!) through
the DEL character (), including most punctuation characters, digits, and upper and
lowercased letters.
public String getPath()
The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of
characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
slashes. In addition, it can contain any ASCII character from the ! (!) through the DEL
character (), including most punctuation characters, digits, and upper and lowercased letters.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string
of characters consisting of either a forward slash (/) by itself or a string that must begin and end with
forward slashes. In addition, it can contain any ASCII character from the ! (!) through
the DEL character (), including most punctuation characters, digits, and upper and
lowercased letters.
public CreateRoleRequest withPath(String path)
The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of
characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
slashes. In addition, it can contain any ASCII character from the ! (!) through the DEL
character (), including most punctuation characters, digits, and upper and lowercased letters.
path - The path to the role. For more information about paths, see IAM Identifiers in the
IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string
of characters consisting of either a forward slash (/) by itself or a string that must begin and end with
forward slashes. In addition, it can contain any ASCII character from the ! (!) through
the DEL character (), including most punctuation characters, digits, and upper and
lowercased letters.
public void setRoleName(String roleName)
The name of the role to create.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
roleName - The name of the role to create.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
public String getRoleName()
The name of the role to create.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
public CreateRoleRequest withRoleName(String roleName)
The name of the role to create.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
roleName - The name of the role to create.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
public void setAssumeRolePolicyDocument(String assumeRolePolicyDocument)
The trust relationship policy document that grants an entity permission to assume the role.
In IAM, you must provide a JSON policy that has been converted to a string. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
The special characters tab ( ), line feed (
), and carriage return (
)
Upon success, the response includes the same trust policy in JSON format.
assumeRolePolicyDocument - The trust relationship policy document that grants an entity permission to assume the role.
In IAM, you must provide a JSON policy that has been converted to a string. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character ( ) through the end of
the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ)
The special characters tab ( ), line feed (
), and carriage return (
)
Upon success, the response includes the same trust policy in JSON format.
public String getAssumeRolePolicyDocument()
The trust relationship policy document that grants an entity permission to assume the role.
In IAM, you must provide a JSON policy that has been converted to a string. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
The special characters tab ( ), line feed (
), and carriage return (
)
Upon success, the response includes the same trust policy in JSON format.
In IAM, you must provide a JSON policy that has been converted to a string. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character ( ) through the end of
the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ)
The special characters tab ( ), line feed (
), and carriage return (
)
Upon success, the response includes the same trust policy in JSON format.
public CreateRoleRequest withAssumeRolePolicyDocument(String assumeRolePolicyDocument)
The trust relationship policy document that grants an entity permission to assume the role.
In IAM, you must provide a JSON policy that has been converted to a string. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
The special characters tab ( ), line feed (
), and carriage return (
)
Upon success, the response includes the same trust policy in JSON format.
assumeRolePolicyDocument - The trust relationship policy document that grants an entity permission to assume the role.
In IAM, you must provide a JSON policy that has been converted to a string. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character ( ) through the end of
the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ)
The special characters tab ( ), line feed (
), and carriage return (
)
Upon success, the response includes the same trust policy in JSON format.
public void setDescription(String description)
A description of the role.
description - A description of the role.public String getDescription()
A description of the role.
public CreateRoleRequest withDescription(String description)
A description of the role.
description - A description of the role.public void setMaxSessionDuration(Integer maxSessionDuration)
The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.
Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the
duration-seconds CLI parameter to request a longer session. The MaxSessionDuration
setting determines the maximum duration that can be requested using the DurationSeconds parameter.
If users don't specify a value for the DurationSeconds parameter, their security credentials are
valid for one hour by default. This applies when you use the AssumeRole* API operations or the
assume-role* CLI operations but does not apply when you use those operations to create a console
URL. For more information, see Using
IAM roles in the IAM User Guide.
maxSessionDuration - The maximum session duration (in seconds) that you want to set for the specified role. If you do not
specify a value for this setting, the default value of one hour is applied. This setting can have a value
from 1 hour to 12 hours.
Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or
the duration-seconds CLI parameter to request a longer session. The
MaxSessionDuration setting determines the maximum duration that can be requested using the
DurationSeconds parameter. If users don't specify a value for the
DurationSeconds parameter, their security credentials are valid for one hour by default. This
applies when you use the AssumeRole* API operations or the assume-role* CLI
operations but does not apply when you use those operations to create a console URL. For more information,
see Using IAM roles in
the IAM User Guide.
public Integer getMaxSessionDuration()
The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.
Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the
duration-seconds CLI parameter to request a longer session. The MaxSessionDuration
setting determines the maximum duration that can be requested using the DurationSeconds parameter.
If users don't specify a value for the DurationSeconds parameter, their security credentials are
valid for one hour by default. This applies when you use the AssumeRole* API operations or the
assume-role* CLI operations but does not apply when you use those operations to create a console
URL. For more information, see Using
IAM roles in the IAM User Guide.
Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or
the duration-seconds CLI parameter to request a longer session. The
MaxSessionDuration setting determines the maximum duration that can be requested using the
DurationSeconds parameter. If users don't specify a value for the
DurationSeconds parameter, their security credentials are valid for one hour by default.
This applies when you use the AssumeRole* API operations or the assume-role*
CLI operations but does not apply when you use those operations to create a console URL. For more
information, see Using IAM
roles in the IAM User Guide.
public CreateRoleRequest withMaxSessionDuration(Integer maxSessionDuration)
The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.
Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the
duration-seconds CLI parameter to request a longer session. The MaxSessionDuration
setting determines the maximum duration that can be requested using the DurationSeconds parameter.
If users don't specify a value for the DurationSeconds parameter, their security credentials are
valid for one hour by default. This applies when you use the AssumeRole* API operations or the
assume-role* CLI operations but does not apply when you use those operations to create a console
URL. For more information, see Using
IAM roles in the IAM User Guide.
maxSessionDuration - The maximum session duration (in seconds) that you want to set for the specified role. If you do not
specify a value for this setting, the default value of one hour is applied. This setting can have a value
from 1 hour to 12 hours.
Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or
the duration-seconds CLI parameter to request a longer session. The
MaxSessionDuration setting determines the maximum duration that can be requested using the
DurationSeconds parameter. If users don't specify a value for the
DurationSeconds parameter, their security credentials are valid for one hour by default. This
applies when you use the AssumeRole* API operations or the assume-role* CLI
operations but does not apply when you use those operations to create a console URL. For more information,
see Using IAM roles in
the IAM User Guide.
public void setPermissionsBoundary(String permissionsBoundary)
The ARN of the managed policy that is used to set the permissions boundary for the role.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
permissionsBoundary - The ARN of the managed policy that is used to set the permissions boundary for the role.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
public String getPermissionsBoundary()
The ARN of the managed policy that is used to set the permissions boundary for the role.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
public CreateRoleRequest withPermissionsBoundary(String permissionsBoundary)
The ARN of the managed policy that is used to set the permissions boundary for the role.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
permissionsBoundary - The ARN of the managed policy that is used to set the permissions boundary for the role.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
public List<Tag> getTags()
A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
public void setTags(Collection<Tag> tags)
A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
tags - A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated
value. For more information about tagging, see Tagging IAM resources in the
IAM User Guide. If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
public CreateRoleRequest withTags(Tag... tags)
A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the
existing values.
tags - A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated
value. For more information about tagging, see Tagging IAM resources in the
IAM User Guide. If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
public CreateRoleRequest withTags(Collection<Tag> tags)
A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
tags - A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated
value. For more information about tagging, see Tagging IAM resources in the
IAM User Guide. If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
public String toString()
toString in class ObjectObject.toString()public CreateRoleRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()