Package software.amazon.awscdk.cli.lib.alpha

Class BootstrapOptions.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.cli.lib.alpha.BootstrapOptions.Jsii$Proxy
All Implemented Interfaces:
BootstrapOptions, SharedOptions, software.amazon.jsii.JsiiSerializable
Enclosing interface:
BootstrapOptions
@Stability(Experimental) @Internal public static final class BootstrapOptions.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements BootstrapOptions
An implementation for BootstrapOptions

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.cli.lib.alpha.BootstrapOptions

    BootstrapOptions.Builder, BootstrapOptions.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(BootstrapOptions.Builder builder)
    Constructor that initializes the object based on literal property values passed by the BootstrapOptions.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final Boolean
    getAssetMetadata()
    (experimental) Include "aws:asset:*" CloudFormation metadata for resources that use assets.
    final String
    getBootstrapBucketName()
    (experimental) The name of the CDK toolkit bucket;
    final String
    getBootstrapCustomerKey()
    (experimental) Create a Customer Master Key (CMK) for the bootstrap bucket (you will be charged but can customize permissions, modern bootstrapping only).
    final String
    getBootstrapKmsKeyId()
    (experimental) AWS KMS master key ID used for the SSE-KMS encryption.
    final String
    getCaBundlePath()
    (experimental) Path to CA certificate to use when validating HTTPS requests.
    final String
    getCfnExecutionPolicy()
    (experimental) The Managed Policy ARNs that should be attached to the role performing deployments into this environment (may be repeated, modern bootstrapping only).
    final Boolean
    getColor()
    (experimental) Show colors and other style from console output.
    final Map<String,String>
    getContext()
    (experimental) Additional context.
    final String
    getCustomPermissionsBoundary()
    (experimental) Use the permissions boundary specified by name.
    final Boolean
    getDebug()
    (experimental) enable emission of additional debugging information, such as creation stack traces of tokens.
    final Boolean
    getEc2Creds()
    (experimental) Force trying to fetch EC2 instance credentials.
    final Boolean
    getExamplePermissionsBoundary()
    (experimental) Use the example permissions boundary.
    final Boolean
    getExecute()
    (experimental) Whether to execute ChangeSet (--no-execute will NOT execute the ChangeSet).
    final Boolean
    getForce()
    (experimental) Always bootstrap even if it would downgrade template version.
    final Boolean
    getIgnoreErrors()
    (experimental) Ignores synthesis errors, which will likely produce an invalid output.
    final Boolean
    getJson()
    (experimental) Use JSON output instead of YAML when templates are printed to STDOUT.
    final Boolean
    getLookups()
    (experimental) Perform context lookups.
    final Boolean
    getNotices()
    (experimental) Show relevant notices.
    final Boolean
    getPathMetadata()
    (experimental) Include "aws:cdk:path" CloudFormation metadata for each resource.
    final String
    getProfile()
    (experimental) Use the indicated AWS profile as the default environment.
    final String
    getProxy()
    (experimental) Use the indicated proxy.
    final String
    getPublicAccessBlockConfiguration()
    (experimental) Block public access configuration on CDK toolkit bucket (enabled by default).
    final String
    getQualifier()
    (experimental) String which must be unique for each bootstrap stack.
    final String
    getRoleArn()
    (experimental) Role to pass to CloudFormation for deployment.
    final Boolean
    getShowTemplate()
    (experimental) Instead of actual bootstrapping, print the current CLI's bootstrapping template to stdout for customization.
    final List<String>
    getStacks()
    (experimental) List of stacks to deploy.
    final Boolean
    getStaging()
    (experimental) Copy assets to the output directory.
    final Boolean
    getStrict()
    (experimental) Do not construct stacks with warnings.
    final String
    getTemplate()
    (experimental) Use the template from the given file instead of the built-in one (use --show-template to obtain an example).
    final Boolean
    getTerminationProtection()
    (experimental) Toggle CloudFormation termination protection on the bootstrap stacks.
    final String
    getToolkitStackName()
    (experimental) The name of the CDK toolkit stack to create.
    final Boolean
    getTrace()
    (experimental) Print trace for stack warnings.
    final String
    getTrust()
    (experimental) The AWS account IDs that should be trusted to perform deployments into this environment (may be repeated, modern bootstrapping only).
    final String
    getTrustForLookup()
    (experimental) The AWS account IDs that should be trusted to look up values in this environment (may be repeated, modern bootstrapping only).
    final Boolean
    getUsePreviousParameters()
    (experimental) Use previous values for existing parameters (you must specify all parameters on every deployment if this is disabled).
    final Boolean
    getVerbose()
    (experimental) show debug logs.
    final Boolean
    getVersionReporting()
    (experimental) Include "AWS::CDK::Metadata" resource in synthesized templates.
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(BootstrapOptions.Builder builder)
      Constructor that initializes the object based on literal property values passed by the BootstrapOptions.Builder.

  • Method Details

    • getBootstrapBucketName

      public final String getBootstrapBucketName()
      Description copied from interface: BootstrapOptions
      (experimental) The name of the CDK toolkit bucket;

      bucket will be created and must not exist

      Default: - auto-generated CloudFormation name

      Specified by:
      getBootstrapBucketName in interface BootstrapOptions

    • getBootstrapCustomerKey

      public final String getBootstrapCustomerKey()
      Description copied from interface: BootstrapOptions
      (experimental) Create a Customer Master Key (CMK) for the bootstrap bucket (you will be charged but can customize permissions, modern bootstrapping only).

      Default: undefined

      Specified by:
      getBootstrapCustomerKey in interface BootstrapOptions

    • getBootstrapKmsKeyId

      public final String getBootstrapKmsKeyId()
      Description copied from interface: BootstrapOptions
      (experimental) AWS KMS master key ID used for the SSE-KMS encryption.

      Default: undefined

      Specified by:
      getBootstrapKmsKeyId in interface BootstrapOptions

    • getCfnExecutionPolicy

      public final String getCfnExecutionPolicy()
      Description copied from interface: BootstrapOptions
      (experimental) The Managed Policy ARNs that should be attached to the role performing deployments into this environment (may be repeated, modern bootstrapping only).

      Default: - none

      Specified by:
      getCfnExecutionPolicy in interface BootstrapOptions

    • getCustomPermissionsBoundary

      public final String getCustomPermissionsBoundary()
      Description copied from interface: BootstrapOptions
      (experimental) Use the permissions boundary specified by name.

      Default: undefined

      Specified by:
      getCustomPermissionsBoundary in interface BootstrapOptions

    • getExamplePermissionsBoundary

      public final Boolean getExamplePermissionsBoundary()
      Description copied from interface: BootstrapOptions
      (experimental) Use the example permissions boundary.

      Default: undefined

      Specified by:
      getExamplePermissionsBoundary in interface BootstrapOptions

    • getExecute

      public final Boolean getExecute()
      Description copied from interface: BootstrapOptions
      (experimental) Whether to execute ChangeSet (--no-execute will NOT execute the ChangeSet).

      Default: true

      Specified by:
      getExecute in interface BootstrapOptions

    • getForce

      public final Boolean getForce()
      Description copied from interface: BootstrapOptions
      (experimental) Always bootstrap even if it would downgrade template version.

      Default: false

      Specified by:
      getForce in interface BootstrapOptions

    • getPublicAccessBlockConfiguration

      public final String getPublicAccessBlockConfiguration()
      Description copied from interface: BootstrapOptions
      (experimental) Block public access configuration on CDK toolkit bucket (enabled by default).

      Default: undefined

      Specified by:
      getPublicAccessBlockConfiguration in interface BootstrapOptions

    • getQualifier

      public final String getQualifier()
      Description copied from interface: BootstrapOptions
      (experimental) String which must be unique for each bootstrap stack.

      You must configure it on your CDK app if you change this from the default.

      Default: undefined

      Specified by:
      getQualifier in interface BootstrapOptions

    • getShowTemplate

      public final Boolean getShowTemplate()
      Description copied from interface: BootstrapOptions
      (experimental) Instead of actual bootstrapping, print the current CLI's bootstrapping template to stdout for customization.

      Default: false

      Specified by:
      getShowTemplate in interface BootstrapOptions

    • getTemplate

      public final String getTemplate()
      Description copied from interface: BootstrapOptions
      (experimental) Use the template from the given file instead of the built-in one (use --show-template to obtain an example).
      Specified by:
      getTemplate in interface BootstrapOptions

    • getTerminationProtection

      public final Boolean getTerminationProtection()
      Description copied from interface: BootstrapOptions
      (experimental) Toggle CloudFormation termination protection on the bootstrap stacks.

      Default: false

      Specified by:
      getTerminationProtection in interface BootstrapOptions

    • getToolkitStackName

      public final String getToolkitStackName()
      Description copied from interface: BootstrapOptions
      (experimental) The name of the CDK toolkit stack to create.
      Specified by:
      getToolkitStackName in interface BootstrapOptions

    • getTrust

      public final String getTrust()
      Description copied from interface: BootstrapOptions
      (experimental) The AWS account IDs that should be trusted to perform deployments into this environment (may be repeated, modern bootstrapping only).

      Default: undefined

      Specified by:
      getTrust in interface BootstrapOptions

    • getTrustForLookup

      public final String getTrustForLookup()
      Description copied from interface: BootstrapOptions
      (experimental) The AWS account IDs that should be trusted to look up values in this environment (may be repeated, modern bootstrapping only).

      Default: undefined

      Specified by:
      getTrustForLookup in interface BootstrapOptions

    • getUsePreviousParameters

      public final Boolean getUsePreviousParameters()
      Description copied from interface: BootstrapOptions
      (experimental) Use previous values for existing parameters (you must specify all parameters on every deployment if this is disabled).

      Default: true

      Specified by:
      getUsePreviousParameters in interface BootstrapOptions

    • getAssetMetadata

      public final Boolean getAssetMetadata()
      Description copied from interface: SharedOptions
      (experimental) Include "aws:asset:*" CloudFormation metadata for resources that use assets.

      Default: true

      Specified by:
      getAssetMetadata in interface SharedOptions

    • getCaBundlePath

      public final String getCaBundlePath()
      Description copied from interface: SharedOptions
      (experimental) Path to CA certificate to use when validating HTTPS requests.

      Default: - read from AWS_CA_BUNDLE environment variable

      Specified by:
      getCaBundlePath in interface SharedOptions

    • getColor

      public final Boolean getColor()
      Description copied from interface: SharedOptions
      (experimental) Show colors and other style from console output.

      Default: - `true` unless the environment variable `NO_COLOR` is set

      Specified by:
      getColor in interface SharedOptions

    • getContext

      public final Map<String,String> getContext()
      Description copied from interface: SharedOptions
      (experimental) Additional context.

      Default: - no additional context

      Specified by:
      getContext in interface SharedOptions

    • getDebug

      public final Boolean getDebug()
      Description copied from interface: SharedOptions
      (experimental) enable emission of additional debugging information, such as creation stack traces of tokens.

      Default: false

      Specified by:
      getDebug in interface SharedOptions

    • getEc2Creds

      public final Boolean getEc2Creds()
      Description copied from interface: SharedOptions
      (experimental) Force trying to fetch EC2 instance credentials.

      Default: - guess EC2 instance status

      Specified by:
      getEc2Creds in interface SharedOptions

    • getIgnoreErrors

      public final Boolean getIgnoreErrors()
      Description copied from interface: SharedOptions
      (experimental) Ignores synthesis errors, which will likely produce an invalid output.

      Default: false

      Specified by:
      getIgnoreErrors in interface SharedOptions

    • getJson

      public final Boolean getJson()
      Description copied from interface: SharedOptions
      (experimental) Use JSON output instead of YAML when templates are printed to STDOUT.

      Default: false

      Specified by:
      getJson in interface SharedOptions

    • getLookups

      public final Boolean getLookups()
      Description copied from interface: SharedOptions
      (experimental) Perform context lookups.

      Synthesis fails if this is disabled and context lookups need to be performed

      Default: true

      Specified by:
      getLookups in interface SharedOptions

    • getNotices

      public final Boolean getNotices()
      Description copied from interface: SharedOptions
      (experimental) Show relevant notices.

      Default: true

      Specified by:
      getNotices in interface SharedOptions

    • getPathMetadata

      public final Boolean getPathMetadata()
      Description copied from interface: SharedOptions
      (experimental) Include "aws:cdk:path" CloudFormation metadata for each resource.

      Default: true

      Specified by:
      getPathMetadata in interface SharedOptions

    • getProfile

      public final String getProfile()
      Description copied from interface: SharedOptions
      (experimental) Use the indicated AWS profile as the default environment.

      Default: - no profile is used

      Specified by:
      getProfile in interface SharedOptions

    • getProxy

      public final String getProxy()
      Description copied from interface: SharedOptions
      (experimental) Use the indicated proxy.

      Will read from HTTPS_PROXY environment if specified

      Default: - no proxy

      Specified by:
      getProxy in interface SharedOptions

    • getRoleArn

      public final String getRoleArn()
      Description copied from interface: SharedOptions
      (experimental) Role to pass to CloudFormation for deployment.

      Default: - use the bootstrap cfn-exec role

      Specified by:
      getRoleArn in interface SharedOptions

    • getStacks

      public final List<String> getStacks()
      Description copied from interface: SharedOptions
      (experimental) List of stacks to deploy.

      Default: - all stacks

      Specified by:
      getStacks in interface SharedOptions

    • getStaging

      public final Boolean getStaging()
      Description copied from interface: SharedOptions
      (experimental) Copy assets to the output directory.

      Needed for local debugging the source files with SAM CLI

      Default: false

      Specified by:
      getStaging in interface SharedOptions

    • getStrict

      public final Boolean getStrict()
      Description copied from interface: SharedOptions
      (experimental) Do not construct stacks with warnings.

      Default: false

      Specified by:
      getStrict in interface SharedOptions

    • getTrace

      public final Boolean getTrace()
      Description copied from interface: SharedOptions
      (experimental) Print trace for stack warnings.

      Default: false

      Specified by:
      getTrace in interface SharedOptions

    • getVerbose

      public final Boolean getVerbose()
      Description copied from interface: SharedOptions
      (experimental) show debug logs.

      Default: false

      Specified by:
      getVerbose in interface SharedOptions

    • getVersionReporting

      public final Boolean getVersionReporting()
      Description copied from interface: SharedOptions
      (experimental) Include "AWS::CDK::Metadata" resource in synthesized templates.

      Default: true

      Specified by:
      getVersionReporting in interface SharedOptions

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object