Package software.amazon.awssdk.services.iam.model

Interface Role.Builder

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 Details

    • 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:

    • 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<Tag>).

      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:

    • 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: