Package software.amazon.awscdk

Class RoleOptions.Builder

java.lang.Object
software.amazon.awscdk.RoleOptions.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<RoleOptions>
Enclosing interface:
RoleOptions
@Stability(Stable) public static final class RoleOptions.Builder extends Object implements software.amazon.jsii.Builder<RoleOptions>
A builder for RoleOptions

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • assumeRoleArn

      @Stability(Stable) public RoleOptions.Builder assumeRoleArn(String assumeRoleArn)
      Sets the value of RoleOptions.getAssumeRoleArn()
      Parameters:
      assumeRoleArn - ARN of the role to assume. This parameter is required.
      Returns:
      this

    • assumeRoleAdditionalOptions

      @Stability(Stable) public RoleOptions.Builder assumeRoleAdditionalOptions(Map<String,? extends Object> assumeRoleAdditionalOptions)
      Sets the value of RoleOptions.getAssumeRoleAdditionalOptions()
      Parameters:
      assumeRoleAdditionalOptions - Additional options to pass to STS when assuming the role for cloudformation deployments.
      • RoleArn should not be used. Use the dedicated assumeRoleArn property instead.
      • ExternalId should not be used. Use the dedicated assumeRoleExternalId instead.
      • TransitiveTagKeys defaults to use all keys (if any) specified in Tags. E.g, all tags are transitive by default.
      Returns:
      this

    • assumeRoleExternalId

      @Stability(Stable) public RoleOptions.Builder assumeRoleExternalId(String assumeRoleExternalId)
      Sets the value of RoleOptions.getAssumeRoleExternalId()
      Parameters:
      assumeRoleExternalId - External ID to use when assuming the role.
      Returns:
      this

    • build

      @Stability(Stable) public RoleOptions build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<RoleOptions>
      Returns:
      a new instance of RoleOptions
      Throws:
      NullPointerException - if any required attribute was not provided