DefaultCdkOptions.Builder (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.awscdk.cloudassembly.schema.DefaultCdkOptions.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<DefaultCdkOptions>

Enclosing interface:: DefaultCdkOptions

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

A builder for DefaultCdkOptions

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DefaultCdkOptions.Builder`	`all(Boolean all)` Sets the value of `DefaultCdkOptions.getAll()`
`DefaultCdkOptions.Builder`	`app(String app)` Sets the value of `DefaultCdkOptions.getApp()`
`DefaultCdkOptions.Builder`	`assetMetadata(Boolean assetMetadata)` Sets the value of `DefaultCdkOptions.getAssetMetadata()`
`DefaultCdkOptions`	`build()` Builds the configured instance.
`DefaultCdkOptions.Builder`	`caBundlePath(String caBundlePath)` Sets the value of `DefaultCdkOptions.getCaBundlePath()`
`DefaultCdkOptions.Builder`	`color(Boolean color)` Sets the value of `DefaultCdkOptions.getColor()`
`DefaultCdkOptions.Builder`	`context(Map<String,String> context)` Sets the value of `DefaultCdkOptions.getContext()`
`DefaultCdkOptions.Builder`	`debug(Boolean debug)` Sets the value of `DefaultCdkOptions.getDebug()`
`DefaultCdkOptions.Builder`	`ec2Creds(Boolean ec2Creds)` Sets the value of `DefaultCdkOptions.getEc2Creds()`
`DefaultCdkOptions.Builder`	`ignoreErrors(Boolean ignoreErrors)` Sets the value of `DefaultCdkOptions.getIgnoreErrors()`
`DefaultCdkOptions.Builder`	`json(Boolean json)` Sets the value of `DefaultCdkOptions.getJson()`
`DefaultCdkOptions.Builder`	`lookups(Boolean lookups)` Sets the value of `DefaultCdkOptions.getLookups()`
`DefaultCdkOptions.Builder`	`notices(Boolean notices)` Sets the value of `DefaultCdkOptions.getNotices()`
`DefaultCdkOptions.Builder`	`output(String output)` Sets the value of `DefaultCdkOptions.getOutput()`
`DefaultCdkOptions.Builder`	`pathMetadata(Boolean pathMetadata)` Sets the value of `DefaultCdkOptions.getPathMetadata()`
`DefaultCdkOptions.Builder`	`profile(String profile)` Sets the value of `DefaultCdkOptions.getProfile()`
`DefaultCdkOptions.Builder`	`proxy(String proxy)` Sets the value of `DefaultCdkOptions.getProxy()`
`DefaultCdkOptions.Builder`	`roleArn(String roleArn)` Sets the value of `DefaultCdkOptions.getRoleArn()`
`DefaultCdkOptions.Builder`	`stacks(List<String> stacks)` Sets the value of `DefaultCdkOptions.getStacks()`
`DefaultCdkOptions.Builder`	`staging(Boolean staging)` Sets the value of `DefaultCdkOptions.getStaging()`
`DefaultCdkOptions.Builder`	`strict(Boolean strict)` Sets the value of `DefaultCdkOptions.getStrict()`
`DefaultCdkOptions.Builder`	`trace(Boolean trace)` Sets the value of `DefaultCdkOptions.getTrace()`
`DefaultCdkOptions.Builder`	`verbose(Boolean verbose)` Sets the value of `DefaultCdkOptions.getVerbose()`
`DefaultCdkOptions.Builder`	`versionReporting(Boolean versionReporting)` Sets the value of `DefaultCdkOptions.getVersionReporting()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - all
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder all(Boolean all)
```
    Sets the value of DefaultCdkOptions.getAll()
    
    Parameters:
    
    all - Deploy all stacks. Requried if stacks is not set
    
    Returns:
    
    this
  - app
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder app(String app)
```
    Sets the value of DefaultCdkOptions.getApp()
    
    Parameters:
    
    app - command-line for executing your app or a cloud assembly directory e.g. "node bin/my-app.js" or "cdk.out".
    
    Returns:
    
    this
  - assetMetadata
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder assetMetadata(Boolean assetMetadata)
```
    Sets the value of DefaultCdkOptions.getAssetMetadata()
    
    Parameters:
    
    assetMetadata - Include "aws:asset:*" CloudFormation metadata for resources that use assets.
    
    Returns:
    
    this
  - caBundlePath
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder caBundlePath(String caBundlePath)
```
    Sets the value of DefaultCdkOptions.getCaBundlePath()
    
    Parameters:
    
    caBundlePath - Path to CA certificate to use when validating HTTPS requests.
    
    Returns:
    
    this
  - color
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder color(Boolean color)
```
    Sets the value of DefaultCdkOptions.getColor()
    
    Parameters:
    
    color - Show colors and other style from console output.
    
    Returns:
    
    this
  - context
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder context(Map<String,String> context)
```
    Sets the value of DefaultCdkOptions.getContext()
    
    Parameters:
    
    context - Additional context.
    
    Returns:
    
    this
  - debug
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder debug(Boolean debug)
```
    Sets the value of DefaultCdkOptions.getDebug()
    
    Parameters:
    
    debug - enable emission of additional debugging information, such as creation stack traces of tokens.
    
    Returns:
    
    this
  - ec2Creds
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder ec2Creds(Boolean ec2Creds)
```
    Sets the value of DefaultCdkOptions.getEc2Creds()
    
    Parameters:
    
    ec2Creds - Force trying to fetch EC2 instance credentials.
    
    Returns:
    
    this
  - ignoreErrors
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder ignoreErrors(Boolean ignoreErrors)
```
    Sets the value of DefaultCdkOptions.getIgnoreErrors()
    
    Parameters:
    
    ignoreErrors - Ignores synthesis errors, which will likely produce an invalid output.
    
    Returns:
    
    this
  - json
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder json(Boolean json)
```
    Sets the value of DefaultCdkOptions.getJson()
    
    Parameters:
    
    json - Use JSON output instead of YAML when templates are printed to STDOUT.
    
    Returns:
    
    this
  - lookups
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder lookups(Boolean lookups)
```
    Sets the value of DefaultCdkOptions.getLookups()
    
    Parameters:
    
    lookups - Perform context lookups. Synthesis fails if this is disabled and context lookups need to be performed
    
    Returns:
    
    this
  - notices
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder notices(Boolean notices)
```
    Sets the value of DefaultCdkOptions.getNotices()
    
    Parameters:
    
    notices - Show relevant notices.
    
    Returns:
    
    this
  - output
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder output(String output)
```
    Sets the value of DefaultCdkOptions.getOutput()
    
    Parameters:
    
    output - Emits the synthesized cloud assembly into a directory.
    
    Returns:
    
    this
  - pathMetadata
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder pathMetadata(Boolean pathMetadata)
```
    Sets the value of DefaultCdkOptions.getPathMetadata()
    
    Parameters:
    
    pathMetadata - Include "aws:cdk:path" CloudFormation metadata for each resource.
    
    Returns:
    
    this
  - profile
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder profile(String profile)
```
    Sets the value of DefaultCdkOptions.getProfile()
    
    Parameters:
    
    profile - Use the indicated AWS profile as the default environment.
    
    Returns:
    
    this
  - proxy
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder proxy(String proxy)
```
    Sets the value of DefaultCdkOptions.getProxy()
    
    Parameters:
    
    proxy - Use the indicated proxy. Will read from HTTPS_PROXY environment if specified
    
    Returns:
    
    this
  - roleArn
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder roleArn(String roleArn)
```
    Sets the value of DefaultCdkOptions.getRoleArn()
    
    Parameters:
    
    roleArn - Role to pass to CloudFormation for deployment.
    
    Returns:
    
    this
  - stacks
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder stacks(List<String> stacks)
```
    Sets the value of DefaultCdkOptions.getStacks()
    
    Parameters:
    
    stacks - List of stacks to deploy. Requried if all is not set
    
    Returns:
    
    this
  - staging
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder staging(Boolean staging)
```
    Sets the value of DefaultCdkOptions.getStaging()
    
    Parameters:
    
    staging - Copy assets to the output directory. Needed for local debugging the source files with SAM CLI
    
    Returns:
    
    this
  - strict
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder strict(Boolean strict)
```
    Sets the value of DefaultCdkOptions.getStrict()
    
    Parameters:
    
    strict - Do not construct stacks with warnings.
    
    Returns:
    
    this
  - trace
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder trace(Boolean trace)
```
    Sets the value of DefaultCdkOptions.getTrace()
    
    Parameters:
    
    trace - Print trace for stack warnings.
    
    Returns:
    
    this
  - verbose
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder verbose(Boolean verbose)
```
    Sets the value of DefaultCdkOptions.getVerbose()
    
    Parameters:
    
    verbose - show debug logs.
    
    Returns:
    
    this
  - versionReporting
```
@Stability(value=Stable)
public DefaultCdkOptions.Builder versionReporting(Boolean versionReporting)
```
    Sets the value of DefaultCdkOptions.getVersionReporting()
    
    Parameters:
    
    versionReporting - Include "AWS::CDK::Metadata" resource in synthesized templates.
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public DefaultCdkOptions build()
```
    Builds the configured instance.
    
    Specified by:
    
    build in interface software.amazon.jsii.Builder<DefaultCdkOptions>
    
    Returns:
    
    a new instance of DefaultCdkOptions
    
    Throws:
    
    NullPointerException - if any required attribute was not provided

Class DefaultCdkOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

all

app

assetMetadata

caBundlePath

color

context

debug

ec2Creds

ignoreErrors

json

lookups

notices

output

pathMetadata

profile

proxy

roleArn

stacks

staging

strict

trace

verbose

versionReporting

build