Package software.amazon.awscdk.cloud_assembly_schema

Class BootstrapRole.Builder

java.lang.Object

software.amazon.awscdk.cloud_assembly_schema.BootstrapRole.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BootstrapRole>

Enclosing interface:

BootstrapRole

@Stability(Stable)
public static final class BootstrapRole.Builder
extends Object
implements software.amazon.jsii.Builder<BootstrapRole>

A builder for BootstrapRole

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BootstrapRole.Builder	arn(String arn)	Sets the value of BootstrapRole.getArn()
BootstrapRole.Builder	assumeRoleAdditionalOptions(Map<String,? extends Object> assumeRoleAdditionalOptions)	Sets the value of BootstrapRole.getAssumeRoleAdditionalOptions()
BootstrapRole.Builder	assumeRoleExternalId(String assumeRoleExternalId)	Sets the value of BootstrapRole.getAssumeRoleExternalId()
BootstrapRole.Builder	bootstrapStackVersionSsmParameter(String bootstrapStackVersionSsmParameter)	Sets the value of BootstrapRole.getBootstrapStackVersionSsmParameter()
BootstrapRole	build()	Builds the configured instance.
BootstrapRole.Builder	requiresBootstrapStackVersion(Number requiresBootstrapStackVersion)	Sets the value of BootstrapRole.getRequiresBootstrapStackVersion()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

arn

@Stability(Stable)
public BootstrapRole.Builder arn(String arn)

Sets the value of BootstrapRole.getArn()

Parameters:

arn - The ARN of the IAM role created as part of bootrapping e.g. lookupRoleArn. This parameter is required.

Returns:

this

assumeRoleAdditionalOptions

@Stability(Stable)
public BootstrapRole.Builder assumeRoleAdditionalOptions(Map<String,? extends Object> assumeRoleAdditionalOptions)

Sets the value of BootstrapRole.getAssumeRoleAdditionalOptions()

Parameters:

assumeRoleAdditionalOptions - 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.

Returns:

this

assumeRoleExternalId

@Stability(Stable)
public BootstrapRole.Builder assumeRoleExternalId(String assumeRoleExternalId)

Sets the value of BootstrapRole.getAssumeRoleExternalId()

Parameters:

assumeRoleExternalId - External ID to use when assuming the bootstrap role.

Returns:

this

bootstrapStackVersionSsmParameter

@Stability(Stable)
public BootstrapRole.Builder bootstrapStackVersionSsmParameter(String bootstrapStackVersionSsmParameter)

Sets the value of BootstrapRole.getBootstrapStackVersionSsmParameter()

Parameters:

bootstrapStackVersionSsmParameter - Name of SSM parameter with bootstrap stack version.

Returns:

this

requiresBootstrapStackVersion

@Stability(Stable)
public BootstrapRole.Builder requiresBootstrapStackVersion(Number requiresBootstrapStackVersion)

Sets the value of BootstrapRole.getRequiresBootstrapStackVersion()

Parameters:

requiresBootstrapStackVersion - Version of bootstrap stack required to use this role.

Returns:

this

build

@Stability(Stable)
public BootstrapRole build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<BootstrapRole>

Returns:

a new instance of BootstrapRole

Throws:

NullPointerException - if any required attribute was not provided