package awscdk import ( _init_ "github.com/aws/aws-cdk-go/awscdk/v2/jsii" _jsii_ "github.com/aws/jsii-runtime-go/runtime" "github.com/aws/aws-cdk-go/awscdk/v2/cloudassemblyschema" "github.com/aws/aws-cdk-go/awscdk/v2/internal" "github.com/aws/constructs-go/constructs/v10" ) // A root construct which represents a single CloudFormation stack. // // Example: // import path "github.com/aws-samples/dummy/path" // import cloudwatch "github.com/aws/aws-cdk-go/awscdk" // import "github.com/aws/aws-cdk-go/awscdk" // import "github.com/aws/aws-cdk-go/awscdkkinesisanalyticsflinkalpha" // // app := core.NewApp() // stack := core.NewStack(app, jsii.String("FlinkAppTest")) // // flinkApp := flink.NewApplication(stack, jsii.String("App"), &ApplicationProps{ // Code: flink.ApplicationCode_FromAsset(path.join(__dirname, jsii.String("code-asset"))), // Runtime: flink.Runtime_FLINK_1_11(), // }) // // cloudwatch.NewAlarm(stack, jsii.String("Alarm"), &AlarmProps{ // Metric: flinkApp.metricFullRestarts(), // EvaluationPeriods: jsii.Number(1), // Threshold: jsii.Number(3), // }) // // app.Synth() // type Stack interface { constructs.Construct ITaggable // The AWS account into which this stack will be deployed. // // This value is resolved according to the following rules: // // 1. The value provided to `env.account` when the stack is defined. This can // either be a concrete account (e.g. `585695031111`) or the // `Aws.ACCOUNT_ID` token. // 3. `Aws.ACCOUNT_ID`, which represents the CloudFormation intrinsic reference // `{ "Ref": "AWS::AccountId" }` encoded as a string token. // // Preferably, you should use the return value as an opaque string and not // attempt to parse it to implement your logic. If you do, you must first // check that it is a concrete value an not an unresolved token. If this // value is an unresolved token (`Token.isUnresolved(stack.account)` returns // `true`), this implies that the user wishes that this stack will synthesize // into a **account-agnostic template**. In this case, your code should either // fail (throw an error, emit a synth error using `Annotations.of(construct).addError()`) or // implement some other region-agnostic behavior. Account() *string // The ID of the cloud assembly artifact for this stack. ArtifactId() *string // Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack. // // If the stack is environment-agnostic (either account and/or region are // tokens), this property will return an array with 2 tokens that will resolve // at deploy-time to the first two availability zones returned from CloudFormation's // `Fn::GetAZs` intrinsic function. // // If they are not available in the context, returns a set of dummy values and // reports them as missing, and let the CLI resolve them by calling EC2 // `DescribeAvailabilityZones` on the target environment. // // To specify a different strategy for selecting availability zones override this method. AvailabilityZones() *[]*string // Indicates whether the stack requires bundling or not. BundlingRequired() *bool // Return the stacks this stack depends on. Dependencies() *[]Stack // The environment coordinates in which this stack is deployed. // // In the form // `aws://account/region`. Use `stack.account` and `stack.region` to obtain // the specific values, no need to parse. // // You can use this value to determine if two stacks are targeting the same // environment. // // If either `stack.account` or `stack.region` are not concrete values (e.g. // `Aws.ACCOUNT_ID` or `Aws.REGION`) the special strings `unknown-account` and/or // `unknown-region` will be used respectively to indicate this stack is // region/account-agnostic. Environment() *string // Indicates if this is a nested stack, in which case `parentStack` will include a reference to it's parent. Nested() *bool // If this is a nested stack, returns it's parent stack. NestedStackParent() Stack // If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource. // // `undefined` for top-level (non-nested) stacks. NestedStackResource() CfnResource // The tree node. Node() constructs.Node // Returns the list of notification Amazon Resource Names (ARNs) for the current stack. NotificationArns() *[]*string // The partition in which this stack is defined. Partition() *string // The AWS region into which this stack will be deployed (e.g. `us-west-2`). // // This value is resolved according to the following rules: // // 1. The value provided to `env.region` when the stack is defined. This can // either be a concrete region (e.g. `us-west-2`) or the `Aws.REGION` // token. // 3. `Aws.REGION`, which is represents the CloudFormation intrinsic reference // `{ "Ref": "AWS::Region" }` encoded as a string token. // // Preferably, you should use the return value as an opaque string and not // attempt to parse it to implement your logic. If you do, you must first // check that it is a concrete value an not an unresolved token. If this // value is an unresolved token (`Token.isUnresolved(stack.region)` returns // `true`), this implies that the user wishes that this stack will synthesize // into a **region-agnostic template**. In this case, your code should either // fail (throw an error, emit a synth error using `Annotations.of(construct).addError()`) or // implement some other region-agnostic behavior. Region() *string // The ID of the stack. // // Example: // // After resolving, looks like // "arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123" // StackId() *string // The concrete CloudFormation physical stack name. // // This is either the name defined explicitly in the `stackName` prop or // allocated based on the stack's location in the construct tree. Stacks that // are directly defined under the app use their construct `id` as their stack // name. Stacks that are defined deeper within the tree will use a hashed naming // scheme based on the construct path to ensure uniqueness. // // If you wish to obtain the deploy-time AWS::StackName intrinsic, // you can use `Aws.STACK_NAME` directly. StackName() *string // Synthesis method for this stack. Synthesizer() IStackSynthesizer // Tags to be applied to the stack. Tags() TagManager // The name of the CloudFormation template file emitted to the output directory during synthesis. // // Example value: `MyStack.template.json` TemplateFile() *string // Options for CloudFormation template (like version, transform, description). TemplateOptions() ITemplateOptions // Whether termination protection is enabled for this stack. TerminationProtection() *bool // The Amazon domain suffix for the region in which this stack is defined. UrlSuffix() *string // Add a dependency between this stack and another stack. // // This can be used to define dependencies between any two stacks within an // app, and also supports nested stacks. AddDependency(target Stack, reason *string) // Adds an arbitary key-value pair, with information you want to record about the stack. // // These get translated to the Metadata section of the generated template. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // AddMetadata(key *string, value interface{}) // Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template. // // Duplicate values are removed when stack is synthesized. // // Example: // var stack stack // // // stack.AddTransform(jsii.String("AWS::Serverless-2016-10-31")) // // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html // AddTransform(transform *string) // Returns the naming scheme used to allocate logical IDs. // // By default, uses // the `HashedAddressingScheme` but this method can be overridden to customize // this behavior. // // In order to make sure logical IDs are unique and stable, we hash the resource // construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as // a suffix to the path components joined without a separator (CloudFormation // IDs only allow alphanumeric characters). // // The result will be: // // // "human" "hash" // // If the "human" part of the ID exceeds 240 characters, we simply trim it so // the total ID doesn't exceed CloudFormation's 255 character limit. // // We only take 8 characters from the md5 hash (0.000005 chance of collision). // // Special cases: // // - If the path only contains a single component (i.e. it's a top-level // resource), we won't add the hash to it. The hash is not needed for // disambiguation and also, it allows for a more straightforward migration an // existing CloudFormation template to a CDK stack without logical ID changes // (or renames). // - For aesthetic reasons, if the last components of the path are the same // (i.e. `L1/L2/Pipeline/Pipeline`), they will be de-duplicated to make the // resulting human portion of the ID more pleasing: `L1L2Pipeline` // instead of `L1L2PipelinePipeline` // - If a component is named "Default" it will be omitted from the path. This // allows refactoring higher level abstractions around constructs without affecting // the IDs of already deployed resources. // - If a component is named "Resource" it will be omitted from the user-visible // path, but included in the hash. This reduces visual noise in the human readable // part of the identifier. AllocateLogicalId(cfnElement CfnElement) *string // Create a CloudFormation Export for a string list value. // // Returns a string list representing the corresponding `Fn.importValue()` // expression for this Export. The export expression is automatically wrapped with an // `Fn::Join` and the import value with an `Fn::Split`, since CloudFormation can only // export strings. You can control the name for the export by passing the `name` option. // // If you don't supply a value for `name`, the value you're exporting must be // a Resource attribute (for example: `bucket.bucketName`) and it will be // given the same name as the automatic cross-stack reference that would be created // if you used the attribute in another Stack. // // One of the uses for this method is to *remove* the relationship between // two Stacks established by automatic cross-stack references. It will // temporarily ensure that the CloudFormation Export still exists while you // remove the reference from the consuming stack. After that, you can remove // the resource and the manual export. // // See `exportValue` for an example of this process. ExportStringListValue(exportedValue interface{}, options *ExportValueOptions) *[]*string // Create a CloudFormation Export for a string value. // // Returns a string representing the corresponding `Fn.importValue()` // expression for this Export. You can control the name for the export by // passing the `name` option. // // If you don't supply a value for `name`, the value you're exporting must be // a Resource attribute (for example: `bucket.bucketName`) and it will be // given the same name as the automatic cross-stack reference that would be created // if you used the attribute in another Stack. // // One of the uses for this method is to *remove* the relationship between // two Stacks established by automatic cross-stack references. It will // temporarily ensure that the CloudFormation Export still exists while you // remove the reference from the consuming stack. After that, you can remove // the resource and the manual export. // // ## Example // // Here is how the process works. Let's say there are two stacks, // `producerStack` and `consumerStack`, and `producerStack` has a bucket // called `bucket`, which is referenced by `consumerStack` (perhaps because // an AWS Lambda Function writes into it, or something like that). // // It is not safe to remove `producerStack.bucket` because as the bucket is being // deleted, `consumerStack` might still be using it. // // Instead, the process takes two deployments: // // ### Deployment 1: break the relationship // // - Make sure `consumerStack` no longer references `bucket.bucketName` (maybe the consumer // stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just // remove the Lambda Function altogether). // - In the `ProducerStack` class, call `this.exportValue(this.bucket.bucketName)`. This // will make sure the CloudFormation Export continues to exist while the relationship // between the two stacks is being broken. // - Deploy (this will effectively only change the `consumerStack`, but it's safe to deploy both). // // ### Deployment 2: remove the bucket resource // // - You are now free to remove the `bucket` resource from `producerStack`. // - Don't forget to remove the `exportValue()` call as well. // - Deploy again (this time only the `producerStack` will be changed -- the bucket will be deleted). ExportValue(exportedValue interface{}, options *ExportValueOptions) *string // Creates an ARN from components. // // If `partition`, `region` or `account` are not specified, the stack's // partition, region and account will be used. // // If any component is the empty string, an empty string will be inserted // into the generated ARN at the location that component corresponds to. // // The ARN will be formatted as follows: // // arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name} // // The required ARN pieces that are omitted will be taken from the stack that // the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope // can be 'undefined'. FormatArn(components *ArnComponents) *string // Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource. // // This method is called when a `CfnElement` is created and used to render the // initial logical identity of resources. Logical ID renames are applied at // this stage. // // This method uses the protected method `allocateLogicalId` to render the // logical ID for an element. To modify the naming scheme, extend the `Stack` // class and override this method. GetLogicalId(element CfnElement) *string // Look up a fact value for the given fact for the region of this stack. // // Will return a definite value only if the region of the current stack is resolved. // If not, a lookup map will be added to the stack and the lookup will be done at // CDK deployment time. // // What regions will be included in the lookup map is controlled by the // `@aws-cdk/core:target-partitions` context value: it must be set to a list // of partitions, and only regions from the given partitions will be included. // If no such context key is set, all regions will be included. // // This function is intended to be used by construct library authors. Application // builders can rely on the abstractions offered by construct libraries and do // not have to worry about regional facts. // // If `defaultValue` is not given, it is an error if the fact is unknown for // the given region. RegionalFact(factName *string, defaultValue *string) *string // Rename a generated logical identities. // // To modify the naming scheme strategy, extend the `Stack` class and // override the `allocateLogicalId` method. RenameLogicalId(oldId *string, newId *string) // Indicate that a context key was expected. // // Contains instructions which will be emitted into the cloud assembly on how // the key should be supplied. ReportMissingContextKey(report *cloudassemblyschema.MissingContext) // Resolve a tokenized value in the context of the current stack. Resolve(obj interface{}) interface{} // Splits the provided ARN into its components. // // Works both if 'arn' is a string like 'arn:aws:s3:::bucket', // and a Token representing a dynamic CloudFormation expression // (in which case the returned components will also be dynamic CloudFormation expressions, // encoded as Tokens). SplitArn(arn *string, arnFormat ArnFormat) *ArnComponents // Convert an object, potentially containing tokens, to a JSON string. ToJsonString(obj interface{}, space *float64) *string // Returns a string representation of this construct. ToString() *string // Convert an object, potentially containing tokens, to a YAML string. ToYamlString(obj interface{}) *string } // The jsii proxy struct for Stack type jsiiProxy_Stack struct { internal.Type__constructsConstruct jsiiProxy_ITaggable } func (j *jsiiProxy_Stack) Account() *string { var returns *string _jsii_.Get( j, "account", &returns, ) return returns } func (j *jsiiProxy_Stack) ArtifactId() *string { var returns *string _jsii_.Get( j, "artifactId", &returns, ) return returns } func (j *jsiiProxy_Stack) AvailabilityZones() *[]*string { var returns *[]*string _jsii_.Get( j, "availabilityZones", &returns, ) return returns } func (j *jsiiProxy_Stack) BundlingRequired() *bool { var returns *bool _jsii_.Get( j, "bundlingRequired", &returns, ) return returns } func (j *jsiiProxy_Stack) Dependencies() *[]Stack { var returns *[]Stack _jsii_.Get( j, "dependencies", &returns, ) return returns } func (j *jsiiProxy_Stack) Environment() *string { var returns *string _jsii_.Get( j, "environment", &returns, ) return returns } func (j *jsiiProxy_Stack) Nested() *bool { var returns *bool _jsii_.Get( j, "nested", &returns, ) return returns } func (j *jsiiProxy_Stack) NestedStackParent() Stack { var returns Stack _jsii_.Get( j, "nestedStackParent", &returns, ) return returns } func (j *jsiiProxy_Stack) NestedStackResource() CfnResource { var returns CfnResource _jsii_.Get( j, "nestedStackResource", &returns, ) return returns } func (j *jsiiProxy_Stack) Node() constructs.Node { var returns constructs.Node _jsii_.Get( j, "node", &returns, ) return returns } func (j *jsiiProxy_Stack) NotificationArns() *[]*string { var returns *[]*string _jsii_.Get( j, "notificationArns", &returns, ) return returns } func (j *jsiiProxy_Stack) Partition() *string { var returns *string _jsii_.Get( j, "partition", &returns, ) return returns } func (j *jsiiProxy_Stack) Region() *string { var returns *string _jsii_.Get( j, "region", &returns, ) return returns } func (j *jsiiProxy_Stack) StackId() *string { var returns *string _jsii_.Get( j, "stackId", &returns, ) return returns } func (j *jsiiProxy_Stack) StackName() *string { var returns *string _jsii_.Get( j, "stackName", &returns, ) return returns } func (j *jsiiProxy_Stack) Synthesizer() IStackSynthesizer { var returns IStackSynthesizer _jsii_.Get( j, "synthesizer", &returns, ) return returns } func (j *jsiiProxy_Stack) Tags() TagManager { var returns TagManager _jsii_.Get( j, "tags", &returns, ) return returns } func (j *jsiiProxy_Stack) TemplateFile() *string { var returns *string _jsii_.Get( j, "templateFile", &returns, ) return returns } func (j *jsiiProxy_Stack) TemplateOptions() ITemplateOptions { var returns ITemplateOptions _jsii_.Get( j, "templateOptions", &returns, ) return returns } func (j *jsiiProxy_Stack) TerminationProtection() *bool { var returns *bool _jsii_.Get( j, "terminationProtection", &returns, ) return returns } func (j *jsiiProxy_Stack) UrlSuffix() *string { var returns *string _jsii_.Get( j, "urlSuffix", &returns, ) return returns } // Creates a new stack. func NewStack(scope constructs.Construct, id *string, props *StackProps) Stack { _init_.Initialize() if err := validateNewStackParameters(props); err != nil { panic(err) } j := jsiiProxy_Stack{} _jsii_.Create( "aws-cdk-lib.Stack", []interface{}{scope, id, props}, &j, ) return &j } // Creates a new stack. func NewStack_Override(s Stack, scope constructs.Construct, id *string, props *StackProps) { _init_.Initialize() _jsii_.Create( "aws-cdk-lib.Stack", []interface{}{scope, id, props}, s, ) } // Checks if `x` is a construct. // // Use this method instead of `instanceof` to properly detect `Construct` // instances, even when the construct library is symlinked. // // Explanation: in JavaScript, multiple copies of the `constructs` library on // disk are seen as independent, completely different libraries. As a // consequence, the class `Construct` in each copy of the `constructs` library // is seen as a different class, and an instance of one class will not test as // `instanceof` the other class. `npm install` will not create installations // like this, but users may manually symlink construct libraries together or // use a monorepo tool: in those cases, multiple copies of the `constructs` // library can be accidentally installed, and `instanceof` will behave // unpredictably. It is safest to avoid using `instanceof`, and using // this type-testing method instead. // // Returns: true if `x` is an object created from a class which extends `Construct`. func Stack_IsConstruct(x interface{}) *bool { _init_.Initialize() if err := validateStack_IsConstructParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.Stack", "isConstruct", []interface{}{x}, &returns, ) return returns } // Return whether the given object is a Stack. // // We do attribute detection since we can't reliably use 'instanceof'. func Stack_IsStack(x interface{}) *bool { _init_.Initialize() if err := validateStack_IsStackParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.Stack", "isStack", []interface{}{x}, &returns, ) return returns } // Looks up the first stack scope in which `construct` is defined. // // Fails if there is no stack up the tree. func Stack_Of(construct constructs.IConstruct) Stack { _init_.Initialize() if err := validateStack_OfParameters(construct); err != nil { panic(err) } var returns Stack _jsii_.StaticInvoke( "aws-cdk-lib.Stack", "of", []interface{}{construct}, &returns, ) return returns } func (s *jsiiProxy_Stack) AddDependency(target Stack, reason *string) { if err := s.validateAddDependencyParameters(target); err != nil { panic(err) } _jsii_.InvokeVoid( s, "addDependency", []interface{}{target, reason}, ) } func (s *jsiiProxy_Stack) AddMetadata(key *string, value interface{}) { if err := s.validateAddMetadataParameters(key, value); err != nil { panic(err) } _jsii_.InvokeVoid( s, "addMetadata", []interface{}{key, value}, ) } func (s *jsiiProxy_Stack) AddTransform(transform *string) { if err := s.validateAddTransformParameters(transform); err != nil { panic(err) } _jsii_.InvokeVoid( s, "addTransform", []interface{}{transform}, ) } func (s *jsiiProxy_Stack) AllocateLogicalId(cfnElement CfnElement) *string { if err := s.validateAllocateLogicalIdParameters(cfnElement); err != nil { panic(err) } var returns *string _jsii_.Invoke( s, "allocateLogicalId", []interface{}{cfnElement}, &returns, ) return returns } func (s *jsiiProxy_Stack) ExportStringListValue(exportedValue interface{}, options *ExportValueOptions) *[]*string { if err := s.validateExportStringListValueParameters(exportedValue, options); err != nil { panic(err) } var returns *[]*string _jsii_.Invoke( s, "exportStringListValue", []interface{}{exportedValue, options}, &returns, ) return returns } func (s *jsiiProxy_Stack) ExportValue(exportedValue interface{}, options *ExportValueOptions) *string { if err := s.validateExportValueParameters(exportedValue, options); err != nil { panic(err) } var returns *string _jsii_.Invoke( s, "exportValue", []interface{}{exportedValue, options}, &returns, ) return returns } func (s *jsiiProxy_Stack) FormatArn(components *ArnComponents) *string { if err := s.validateFormatArnParameters(components); err != nil { panic(err) } var returns *string _jsii_.Invoke( s, "formatArn", []interface{}{components}, &returns, ) return returns } func (s *jsiiProxy_Stack) GetLogicalId(element CfnElement) *string { if err := s.validateGetLogicalIdParameters(element); err != nil { panic(err) } var returns *string _jsii_.Invoke( s, "getLogicalId", []interface{}{element}, &returns, ) return returns } func (s *jsiiProxy_Stack) RegionalFact(factName *string, defaultValue *string) *string { if err := s.validateRegionalFactParameters(factName); err != nil { panic(err) } var returns *string _jsii_.Invoke( s, "regionalFact", []interface{}{factName, defaultValue}, &returns, ) return returns } func (s *jsiiProxy_Stack) RenameLogicalId(oldId *string, newId *string) { if err := s.validateRenameLogicalIdParameters(oldId, newId); err != nil { panic(err) } _jsii_.InvokeVoid( s, "renameLogicalId", []interface{}{oldId, newId}, ) } func (s *jsiiProxy_Stack) ReportMissingContextKey(report *cloudassemblyschema.MissingContext) { if err := s.validateReportMissingContextKeyParameters(report); err != nil { panic(err) } _jsii_.InvokeVoid( s, "reportMissingContextKey", []interface{}{report}, ) } func (s *jsiiProxy_Stack) Resolve(obj interface{}) interface{} { if err := s.validateResolveParameters(obj); err != nil { panic(err) } var returns interface{} _jsii_.Invoke( s, "resolve", []interface{}{obj}, &returns, ) return returns } func (s *jsiiProxy_Stack) SplitArn(arn *string, arnFormat ArnFormat) *ArnComponents { if err := s.validateSplitArnParameters(arn, arnFormat); err != nil { panic(err) } var returns *ArnComponents _jsii_.Invoke( s, "splitArn", []interface{}{arn, arnFormat}, &returns, ) return returns } func (s *jsiiProxy_Stack) ToJsonString(obj interface{}, space *float64) *string { if err := s.validateToJsonStringParameters(obj); err != nil { panic(err) } var returns *string _jsii_.Invoke( s, "toJsonString", []interface{}{obj, space}, &returns, ) return returns } func (s *jsiiProxy_Stack) ToString() *string { var returns *string _jsii_.Invoke( s, "toString", nil, // no parameters &returns, ) return returns } func (s *jsiiProxy_Stack) ToYamlString(obj interface{}) *string { if err := s.validateToYamlStringParameters(obj); err != nil { panic(err) } var returns *string _jsii_.Invoke( s, "toYamlString", []interface{}{obj}, &returns, ) return returns }