Interface BootstrapRole

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
BootstrapRole.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-25T14:21:25.208Z") @Stability(Stable) public interface BootstrapRole extends software.amazon.jsii.JsiiSerializable
Information needed to access an IAM role created as part of the bootstrap process.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cloud_assembly_schema.*;
 Object assumeRoleAdditionalOptions;
 BootstrapRole bootstrapRole = BootstrapRole.builder()
         .arn("arn")
         // the properties below are optional
         .assumeRoleAdditionalOptions(Map.of(
                 "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
         .assumeRoleExternalId("assumeRoleExternalId")
         .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
         .requiresBootstrapStackVersion(123)
         .build();
 
  • Method Details

    • getArn

      @Stability(Stable) @NotNull String getArn()
      The ARN of the IAM role created as part of bootrapping e.g. lookupRoleArn.
    • getAssumeRoleAdditionalOptions

      @Stability(Stable) @Nullable default Map<String,Object> getAssumeRoleAdditionalOptions()
      Additional options to pass to STS when assuming the role.

      • RoleArn should not be used. Use the dedicated arn property instead.
      • ExternalId should not be used. Use the dedicated assumeRoleExternalId instead.

      Default: - No additional options.

      See Also:
    • getAssumeRoleExternalId

      @Stability(Stable) @Nullable default String getAssumeRoleExternalId()
      External ID to use when assuming the bootstrap role.

      Default: - No external ID

    • getBootstrapStackVersionSsmParameter

      @Stability(Stable) @Nullable default String getBootstrapStackVersionSsmParameter()
      Name of SSM parameter with bootstrap stack version.

      Default: - Discover SSM parameter by reading stack

    • getRequiresBootstrapStackVersion

      @Stability(Stable) @Nullable default Number getRequiresBootstrapStackVersion()
      Version of bootstrap stack required to use this role.

      Default: - No bootstrap stack required

    • builder

      @Stability(Stable) static BootstrapRole.Builder builder()
      Returns:
      a BootstrapRole.Builder of BootstrapRole