Package software.amazon.awscdk.integtests.alpha

Class IntegTestCaseStackProps.Builder

java.lang.Object
software.amazon.awscdk.integtests.alpha.IntegTestCaseStackProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<IntegTestCaseStackProps>
Enclosing interface:
IntegTestCaseStackProps
@Stability(Experimental) public static final class IntegTestCaseStackProps.Builder extends Object implements software.amazon.jsii.Builder<IntegTestCaseStackProps>
A builder for IntegTestCaseStackProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowDestroy

      @Stability(Stable) public IntegTestCaseStackProps.Builder allowDestroy(List<String> allowDestroy)
      Sets the value of TestOptions.getAllowDestroy()
      Parameters:
      allowDestroy - List of CloudFormation resource types in this stack that can be destroyed as part of an update without failing the test. This list should only include resources that for this specific integration test we are sure will not cause errors or an outage if destroyed. For example, maybe we know that a new resource will be created first before the old resource is destroyed which prevents any outage.

      e.g. ['AWS::IAM::Role']

      Returns:
      this

    • cdkCommandOptions

      @Stability(Stable) public IntegTestCaseStackProps.Builder cdkCommandOptions(CdkCommands cdkCommandOptions)
      Sets the value of TestOptions.getCdkCommandOptions()
      Parameters:
      cdkCommandOptions - Additional options to use for each CDK command.
      Returns:
      this

    • diffAssets

      @Stability(Stable) public IntegTestCaseStackProps.Builder diffAssets(Boolean diffAssets)
      Sets the value of TestOptions.getDiffAssets()
      Parameters:
      diffAssets - Whether or not to include asset hashes in the diff Asset hashes can introduces a lot of unneccessary noise into tests, but there are some cases where asset hashes should be included. For example any tests involving custom resources or bundling
      Returns:
      this

    • hooks

      @Stability(Stable) public IntegTestCaseStackProps.Builder hooks(Hooks hooks)
      Sets the value of TestOptions.getHooks()
      Parameters:
      hooks - Additional commands to run at predefined points in the test workflow. e.g. { postDeploy: ['yarn', 'test'] }
      Returns:
      this

    • regions

      @Stability(Stable) public IntegTestCaseStackProps.Builder regions(List<String> regions)
      Sets the value of TestOptions.getRegions()
      Parameters:
      regions - Limit deployment to these regions.
      Returns:
      this

    • stackUpdateWorkflow

      @Stability(Stable) public IntegTestCaseStackProps.Builder stackUpdateWorkflow(Boolean stackUpdateWorkflow)
      Sets the value of TestOptions.getStackUpdateWorkflow()
      Parameters:
      stackUpdateWorkflow - Run update workflow on this test case This should only be set to false to test scenarios that are not possible to test as part of the update workflow.
      Returns:
      this

    • analyticsReporting

      @Stability(Stable) public IntegTestCaseStackProps.Builder analyticsReporting(Boolean analyticsReporting)
      Sets the value of StackProps.getAnalyticsReporting()
      Parameters:
      analyticsReporting - Include runtime versioning information in this Stack.
      Returns:
      this

    • crossRegionReferences

      @Stability(Stable) public IntegTestCaseStackProps.Builder crossRegionReferences(Boolean crossRegionReferences)
      Sets the value of StackProps.getCrossRegionReferences()
      Parameters:
      crossRegionReferences - Enable this flag to allow native cross region stack references. Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

      This feature is currently experimental

      Returns:
      this

    • description

      @Stability(Stable) public IntegTestCaseStackProps.Builder description(String description)
      Sets the value of StackProps.getDescription()
      Parameters:
      description - A description of the stack.
      Returns:
      this

    • env

      @Stability(Stable) public IntegTestCaseStackProps.Builder env(Environment env)
      Sets the value of StackProps.getEnv()
      Parameters:
      env - The AWS environment (account/region) where this stack will be deployed. Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment depend on the AWS credentials/configuration that the CDK CLI is executed under (recommended for development stacks).

      If the Stack is instantiated inside a Stage, any undefined region/account fields from env will default to the same field on the encompassing Stage, if configured there.

      If either region or account are not set nor inherited from Stage, the Stack will be considered "environment-agnostic"". Environment-agnostic stacks can be deployed to any environment but may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups such as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.

      Returns:
      this

    • notificationArns

      @Stability(Stable) public IntegTestCaseStackProps.Builder notificationArns(List<String> notificationArns)
      Sets the value of StackProps.getNotificationArns()
      Parameters:
      notificationArns - SNS Topic ARNs that will receive stack events.
      Returns:
      this

    • permissionsBoundary

      @Stability(Stable) public IntegTestCaseStackProps.Builder permissionsBoundary(PermissionsBoundary permissionsBoundary)
      Sets the value of StackProps.getPermissionsBoundary()
      Parameters:
      permissionsBoundary - Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.
      Returns:
      this

    • stackName

      @Stability(Stable) public IntegTestCaseStackProps.Builder stackName(String stackName)
      Sets the value of StackProps.getStackName()
      Parameters:
      stackName - Name to deploy the stack with.
      Returns:
      this

    • suppressTemplateIndentation

      @Stability(Stable) public IntegTestCaseStackProps.Builder suppressTemplateIndentation(Boolean suppressTemplateIndentation)
      Sets the value of StackProps.getSuppressTemplateIndentation()
      Parameters:
      suppressTemplateIndentation - Enable this flag to suppress indentation in generated CloudFormation templates. If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.
      Returns:
      this

    • synthesizer

      @Stability(Stable) public IntegTestCaseStackProps.Builder synthesizer(IStackSynthesizer synthesizer)
      Sets the value of StackProps.getSynthesizer()
      Parameters:
      synthesizer - Synthesis method to use while deploying this stack. The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

      If not specified, the defaultStackSynthesizer from App will be used. If that is not specified, DefaultStackSynthesizer is used if @aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

      Returns:
      this

    • tags

      @Stability(Stable) public IntegTestCaseStackProps.Builder tags(Map<String,String> tags)
      Sets the value of StackProps.getTags()
      Parameters:
      tags - Stack tags that will be applied to all the taggable resources and the stack itself.
      Returns:
      this

    • terminationProtection

      @Stability(Stable) public IntegTestCaseStackProps.Builder terminationProtection(Boolean terminationProtection)
      Sets the value of StackProps.getTerminationProtection()
      Parameters:
      terminationProtection - Whether to enable termination protection for this stack.
      Returns:
      this

    • build

      @Stability(Experimental) public IntegTestCaseStackProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<IntegTestCaseStackProps>
      Returns:
      a new instance of IntegTestCaseStackProps
      Throws:
      NullPointerException - if any required attribute was not provided