Package software.amazon.awscdk

Class GetContextKeyOptions.Builder

java.lang.Object

software.amazon.awscdk.GetContextKeyOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GetContextKeyOptions>

Enclosing interface:

GetContextKeyOptions

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

A builder for GetContextKeyOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetContextKeyOptions.Builder	additionalCacheKey(String additionalCacheKey)	Sets the value of GetContextKeyOptions.getAdditionalCacheKey()
GetContextKeyOptions	build()	Builds the configured instance.
GetContextKeyOptions.Builder	includeEnvironment(Boolean includeEnvironment)	Sets the value of GetContextKeyOptions.getIncludeEnvironment()
GetContextKeyOptions.Builder	props(Map<String,? extends Object> props)	Sets the value of GetContextKeyOptions.getProps()
GetContextKeyOptions.Builder	provider(String provider)	Sets the value of GetContextKeyOptions.getProvider()

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

provider

@Stability(Stable)
public GetContextKeyOptions.Builder provider(String provider)

Sets the value of GetContextKeyOptions.getProvider()

Parameters:

provider - The context provider to query. This parameter is required.

Returns:

this

additionalCacheKey

@Stability(Stable)
public GetContextKeyOptions.Builder additionalCacheKey(String additionalCacheKey)

Sets the value of GetContextKeyOptions.getAdditionalCacheKey()

Parameters:

additionalCacheKey - Adds an additional discriminator to the cdk.context.json cache key.

Returns:

this

includeEnvironment

@Stability(Stable)
public GetContextKeyOptions.Builder includeEnvironment(Boolean includeEnvironment)

Sets the value of GetContextKeyOptions.getIncludeEnvironment()

Parameters:

includeEnvironment - Whether to include the stack's account and region automatically.

Returns:

this

props

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

Sets the value of GetContextKeyOptions.getProps()

Parameters:

props - Provider-specific properties.

Returns:

this

build

@Stability(Stable)
public GetContextKeyOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of GetContextKeyOptions

Throws:

NullPointerException - if any required attribute was not provided