Role.Builder (AWS Java SDK :: Services

All Superinterfaces:

Buildable, CopyableBuilder<Role.Builder,Role>, SdkBuilder<Role.Builder,Role>, SdkPojo

Enclosing class:

Role
```
public static interface Role.Builder
extends SdkPojo, CopyableBuilder<Role.Builder,Role>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Role.Builder`	`arn(String arn)` The Amazon Resource Name (ARN) specifying the role.
`Role.Builder`	`assumeRolePolicyDocument(String assumeRolePolicyDocument)` The policy that grants an entity permission to assume the role.
`Role.Builder`	`createDate(Instant createDate)` The date and time, in ISO 8601 date-time format, when the role was created.
`Role.Builder`	`description(String description)` A description of the role that you provide.
`Role.Builder`	`maxSessionDuration(Integer maxSessionDuration)` The maximum session duration (in seconds) for the specified role.
`Role.Builder`	`path(String path)` The path to the role.
`Role.Builder`	`permissionsBoundary(AttachedPermissionsBoundary permissionsBoundary)` The ARN of the policy used to set the permissions boundary for the role.
`default Role.Builder`	`permissionsBoundary(Consumer<AttachedPermissionsBoundary.Builder> permissionsBoundary)` The ARN of the policy used to set the permissions boundary for the role.
`Role.Builder`	`roleId(String roleId)` The stable and unique string identifying the role.
`default Role.Builder`	`roleLastUsed(Consumer<RoleLastUsed.Builder> roleLastUsed)` Contains information about the last time that an IAM role was used.
`Role.Builder`	`roleLastUsed(RoleLastUsed roleLastUsed)` Contains information about the last time that an IAM role was used.
`Role.Builder`	`roleName(String roleName)` The friendly name that identifies the role.
`Role.Builder`	`tags(Collection<Tag> tags)` A list of tags that are attached to the role.
`Role.Builder`	`tags(Consumer<Tag.Builder>... tags)` A list of tags that are attached to the role.
`Role.Builder`	`tags(Tag... tags)` A list of tags that are attached to the role.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - path
```
Role.Builder path(String path)
```
    The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.
    
    Parameters:
    
    path - The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - roleName
```
Role.Builder roleName(String roleName)
```
    The friendly name that identifies the role.
    
    Parameters:
    
    roleName - The friendly name that identifies the role.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - roleId
```
Role.Builder roleId(String roleId)
```
    The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.
    
    Parameters:
    
    roleId - The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - arn
```
Role.Builder arn(String arn)
```
    The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide guide.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - createDate
```
Role.Builder createDate(Instant createDate)
```
    The date and time, in ISO 8601 date-time format, when the role was created.
    
    Parameters:
    
    createDate - The date and time, in ISO 8601 date-time format, when the role was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - assumeRolePolicyDocument
```
Role.Builder assumeRolePolicyDocument(String assumeRolePolicyDocument)
```
    The policy that grants an entity permission to assume the role.
    
    Parameters:
    
    assumeRolePolicyDocument - The policy that grants an entity permission to assume the role.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - description
```
Role.Builder description(String description)
```
    A description of the role that you provide.
    
    Parameters:
    
    description - A description of the role that you provide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - maxSessionDuration
```
Role.Builder maxSessionDuration(Integer maxSessionDuration)
```
    The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.
    
    Parameters:
    
    maxSessionDuration - The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - permissionsBoundary
```
Role.Builder permissionsBoundary(AttachedPermissionsBoundary permissionsBoundary)
```
    The ARN of the policy used to set the permissions boundary for the role.
    
    For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
    
    Parameters:
    
    permissionsBoundary - The ARN of the policy used to set the permissions boundary for the role.
    
    For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - permissionsBoundary
```
default Role.Builder permissionsBoundary(Consumer<AttachedPermissionsBoundary.Builder> permissionsBoundary)
```
    The ARN of the policy used to set the permissions boundary for the role.
    
    For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
    This is a convenience method that creates an instance of the AttachedPermissionsBoundary.Builder avoiding the need to create one manually via AttachedPermissionsBoundary.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to permissionsBoundary(AttachedPermissionsBoundary).
    
    Parameters:
    
    permissionsBoundary - a consumer that will call methods on AttachedPermissionsBoundary.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    permissionsBoundary(AttachedPermissionsBoundary)
  - tags
```
Role.Builder tags(Collection<Tag> tags)
```
    A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
    
    Parameters:
    
    tags - A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
Role.Builder tags(Tag... tags)
```
    A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
    
    Parameters:
    
    tags - A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
Role.Builder tags(Consumer<Tag.Builder>... tags)
```
    A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
    This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).
    
    Parameters:
    
    tags - a consumer that will call methods on Tag.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #tags(java.util.Collection)
  - roleLastUsed
```
Role.Builder roleLastUsed(RoleLastUsed roleLastUsed)
```
    Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM User Guide.
    
    Parameters:
    
    roleLastUsed - Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - roleLastUsed
```
default Role.Builder roleLastUsed(Consumer<RoleLastUsed.Builder> roleLastUsed)
```
    Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM User Guide.
    This is a convenience method that creates an instance of the RoleLastUsed.Builder avoiding the need to create one manually via RoleLastUsed.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to roleLastUsed(RoleLastUsed).
    
    Parameters:
    
    roleLastUsed - a consumer that will call methods on RoleLastUsed.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    roleLastUsed(RoleLastUsed)

Interface Role.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

path

roleName

roleId

arn

createDate

assumeRolePolicyDocument

description

maxSessionDuration

permissionsBoundary

permissionsBoundary

tags

tags

tags

roleLastUsed

roleLastUsed