Package software.amazon.awscdk.core

Class GetContextValueOptions.Builder

java.lang.Object

software.amazon.awscdk.core.GetContextValueOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GetContextValueOptions>

Enclosing interface:

GetContextValueOptions

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

A builder for GetContextValueOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetContextValueOptions	build()	Builds the configured instance.
GetContextValueOptions.Builder	dummyValue(Object dummyValue)	Sets the value of GetContextValueOptions.getDummyValue()
GetContextValueOptions.Builder	includeEnvironment(Boolean includeEnvironment)	Sets the value of GetContextKeyOptions.getIncludeEnvironment()
GetContextValueOptions.Builder	props(Map<String,? extends Object> props)	Sets the value of GetContextKeyOptions.getProps()
GetContextValueOptions.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

dummyValue

@Stability(Stable)
public GetContextValueOptions.Builder dummyValue(Object dummyValue)

Sets the value of GetContextValueOptions.getDummyValue()

Parameters:

dummyValue - The value to return if the context value was not found and a missing context is reported. This parameter is required. This should be a dummy value that should preferably fail during deployment since it represents an invalid state.

Returns:

this

provider

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

Sets the value of GetContextKeyOptions.getProvider()

Parameters:

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

Returns:

this

includeEnvironment

@Stability(Stable)
public GetContextValueOptions.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 GetContextValueOptions.Builder props(Map<String,? extends Object> props)

Sets the value of GetContextKeyOptions.getProps()

Parameters:

props - Provider-specific properties.

Returns:

this

build

@Stability(Stable)
public GetContextValueOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of GetContextValueOptions

Throws:

NullPointerException - if any required attribute was not provided