Package software.amazon.awscdk.services.servicecatalogappregistry.alpha

Class ExistingTargetApplicationOptions.Builder

java.lang.Object

software.amazon.awscdk.services.servicecatalogappregistry.alpha.ExistingTargetApplicationOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ExistingTargetApplicationOptions>

Enclosing interface:

ExistingTargetApplicationOptions

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

A builder for ExistingTargetApplicationOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ExistingTargetApplicationOptions.Builder	analyticsReporting(Boolean analyticsReporting)	Sets the value of StackProps.getAnalyticsReporting()
ExistingTargetApplicationOptions.Builder	applicationArnValue(String applicationArnValue)	Sets the value of ExistingTargetApplicationOptions.getApplicationArnValue()
ExistingTargetApplicationOptions.Builder	associateCrossAccountStacks(Boolean associateCrossAccountStacks)	Sets the value of TargetApplicationCommonOptions.getAssociateCrossAccountStacks()
ExistingTargetApplicationOptions	build()	Builds the configured instance.
ExistingTargetApplicationOptions.Builder	crossRegionReferences(Boolean crossRegionReferences)	Sets the value of StackProps.getCrossRegionReferences()
ExistingTargetApplicationOptions.Builder	description(String description)	Sets the value of StackProps.getDescription()
ExistingTargetApplicationOptions.Builder	env(Environment env)	Sets the value of StackProps.getEnv()
ExistingTargetApplicationOptions.Builder	notificationArns(List<String> notificationArns)	Sets the value of StackProps.getNotificationArns()
ExistingTargetApplicationOptions.Builder	permissionsBoundary(PermissionsBoundary permissionsBoundary)	Sets the value of StackProps.getPermissionsBoundary()
ExistingTargetApplicationOptions.Builder	stackId(String stackId)	Deprecated. - Use `stackName` instead to control the name and id of the stack
ExistingTargetApplicationOptions.Builder	stackName(String stackName)	Sets the value of StackProps.getStackName()
ExistingTargetApplicationOptions.Builder	suppressTemplateIndentation(Boolean suppressTemplateIndentation)	Sets the value of StackProps.getSuppressTemplateIndentation()
ExistingTargetApplicationOptions.Builder	synthesizer(IStackSynthesizer synthesizer)	Sets the value of StackProps.getSynthesizer()
ExistingTargetApplicationOptions.Builder	tags(Map<String,String> tags)	Sets the value of StackProps.getTags()
ExistingTargetApplicationOptions.Builder	terminationProtection(Boolean terminationProtection)	Sets the value of StackProps.getTerminationProtection()

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

applicationArnValue

@Stability(Experimental)
public ExistingTargetApplicationOptions.Builder applicationArnValue(String applicationArnValue)

Sets the value of ExistingTargetApplicationOptions.getApplicationArnValue()

Parameters:

applicationArnValue - Enforces a particular application arn. This parameter is required.

Returns:

this

associateCrossAccountStacks

@Stability(Experimental)
public ExistingTargetApplicationOptions.Builder associateCrossAccountStacks(Boolean associateCrossAccountStacks)

Sets the value of TargetApplicationCommonOptions.getAssociateCrossAccountStacks()

Parameters:

associateCrossAccountStacks - Determines whether any cross-account stacks defined in the CDK app definition should be associated with the target application. If set to true, the application will first be shared with the accounts that own the stacks.

Returns:

this

stackId

@Stability(Deprecated)
@Deprecated
public ExistingTargetApplicationOptions.Builder stackId(String stackId)

Deprecated.

- Use `stackName` instead to control the name and id of the stack

Sets the value of TargetApplicationCommonOptions.getStackId()

Parameters:

stackId - Stack ID in which application will be created or imported. The id of a stack is also the identifier that you use to refer to it in the AWS CDK Toolkit.

Returns:

this

analyticsReporting

@Stability(Stable)
public ExistingTargetApplicationOptions.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 ExistingTargetApplicationOptions.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 ExistingTargetApplicationOptions.Builder description(String description)

Sets the value of StackProps.getDescription()

Parameters:

description - A description of the stack.

Returns:

this

env

@Stability(Stable)
public ExistingTargetApplicationOptions.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 ExistingTargetApplicationOptions.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 ExistingTargetApplicationOptions.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 ExistingTargetApplicationOptions.Builder stackName(String stackName)

Sets the value of StackProps.getStackName()

Parameters:

stackName - Name to deploy the stack with.

Returns:

this

suppressTemplateIndentation

@Stability(Stable)
public ExistingTargetApplicationOptions.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 ExistingTargetApplicationOptions.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 ExistingTargetApplicationOptions.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 ExistingTargetApplicationOptions.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 ExistingTargetApplicationOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ExistingTargetApplicationOptions

Throws:

NullPointerException - if any required attribute was not provided