package awscdk import ( _init_ "github.com/aws/aws-cdk-go/awscdk/v2/jsii" _jsii_ "github.com/aws/jsii-runtime-go/runtime" "github.com/aws/constructs-go/constructs/v10" ) // The `AWS::CloudFormation::Stack` resource nests a stack as a resource in a top-level template. // // You can add output values from a nested stack within the containing template. You use the [GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) function with the nested stack's logical name and the name of the output value in the nested stack in the format `Outputs. *NestedStackOutputName*` . // // > We strongly recommend that updates to nested stacks are run from the parent stack. // // When you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but doesn't update the resources of unmodified nested stacks. For more information, see [CloudFormation stack updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html) . // // > You must acknowledge IAM capabilities for nested stacks that contain IAM resources. Also, verify that you have cancel update stack permissions, which is required if an update rolls back. For more information about IAM and CloudFormation , see [Controlling access with AWS Identity and Access Management](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html) . // // Example: // // The code below shows an example of how to instantiate this type. // // The values are placeholders you should change. // import cdk "github.com/aws/aws-cdk-go/awscdk" // // cfnStack := cdk.NewCfnStack(this, jsii.String("MyCfnStack"), &CfnStackProps{ // TemplateUrl: jsii.String("templateUrl"), // // // the properties below are optional // NotificationArns: []*string{ // jsii.String("notificationArns"), // }, // Parameters: map[string]*string{ // "parametersKey": jsii.String("parameters"), // }, // Tags: []cfnTag{ // &cfnTag{ // Key: jsii.String("key"), // Value: jsii.String("value"), // }, // }, // TimeoutInMinutes: jsii.Number(123), // }) // // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html // type CfnStack interface { CfnResource IInspectable ITaggable AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. NotificationArns() *[]*string SetNotificationArns(val *[]*string) // The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created. Parameters() interface{} SetParameters(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() Stack // Tag Manager which manages the tags for this resource. Tags() TagManager // Key-value pairs to associate with this stack. TagsRaw() *[]*CfnTag SetTagsRaw(val *[]*CfnTag) // Location of file containing the template body. TemplateUrl() *string SetTemplateUrl(val *string) // The length of time, in minutes, that CloudFormation waits for the nested stack to reach the `CREATE_COMPLETE` state. TimeoutInMinutes() *float64 SetTimeoutInMinutes(val *float64) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // ```typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // ``` // would add the overrides // ```json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // ``` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint ResolutionTypeHint) Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target CfnResource, newTarget CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) } // The jsii proxy struct for CfnStack type jsiiProxy_CfnStack struct { jsiiProxy_CfnResource jsiiProxy_IInspectable jsiiProxy_ITaggable } func (j *jsiiProxy_CfnStack) AttrId() *string { var returns *string _jsii_.Get( j, "attrId", &returns, ) return returns } func (j *jsiiProxy_CfnStack) CfnOptions() ICfnResourceOptions { var returns ICfnResourceOptions _jsii_.Get( j, "cfnOptions", &returns, ) return returns } func (j *jsiiProxy_CfnStack) CfnProperties() *map[string]interface{} { var returns *map[string]interface{} _jsii_.Get( j, "cfnProperties", &returns, ) return returns } func (j *jsiiProxy_CfnStack) CfnResourceType() *string { var returns *string _jsii_.Get( j, "cfnResourceType", &returns, ) return returns } func (j *jsiiProxy_CfnStack) CreationStack() *[]*string { var returns *[]*string _jsii_.Get( j, "creationStack", &returns, ) return returns } func (j *jsiiProxy_CfnStack) LogicalId() *string { var returns *string _jsii_.Get( j, "logicalId", &returns, ) return returns } func (j *jsiiProxy_CfnStack) Node() constructs.Node { var returns constructs.Node _jsii_.Get( j, "node", &returns, ) return returns } func (j *jsiiProxy_CfnStack) NotificationArns() *[]*string { var returns *[]*string _jsii_.Get( j, "notificationArns", &returns, ) return returns } func (j *jsiiProxy_CfnStack) Parameters() interface{} { var returns interface{} _jsii_.Get( j, "parameters", &returns, ) return returns } func (j *jsiiProxy_CfnStack) Ref() *string { var returns *string _jsii_.Get( j, "ref", &returns, ) return returns } func (j *jsiiProxy_CfnStack) Stack() Stack { var returns Stack _jsii_.Get( j, "stack", &returns, ) return returns } func (j *jsiiProxy_CfnStack) Tags() TagManager { var returns TagManager _jsii_.Get( j, "tags", &returns, ) return returns } func (j *jsiiProxy_CfnStack) TagsRaw() *[]*CfnTag { var returns *[]*CfnTag _jsii_.Get( j, "tagsRaw", &returns, ) return returns } func (j *jsiiProxy_CfnStack) TemplateUrl() *string { var returns *string _jsii_.Get( j, "templateUrl", &returns, ) return returns } func (j *jsiiProxy_CfnStack) TimeoutInMinutes() *float64 { var returns *float64 _jsii_.Get( j, "timeoutInMinutes", &returns, ) return returns } func (j *jsiiProxy_CfnStack) UpdatedProperites() *map[string]interface{} { var returns *map[string]interface{} _jsii_.Get( j, "updatedProperites", &returns, ) return returns } func (j *jsiiProxy_CfnStack) UpdatedProperties() *map[string]interface{} { var returns *map[string]interface{} _jsii_.Get( j, "updatedProperties", &returns, ) return returns } func NewCfnStack(scope constructs.Construct, id *string, props *CfnStackProps) CfnStack { _init_.Initialize() if err := validateNewCfnStackParameters(scope, id, props); err != nil { panic(err) } j := jsiiProxy_CfnStack{} _jsii_.Create( "aws-cdk-lib.CfnStack", []interface{}{scope, id, props}, &j, ) return &j } func NewCfnStack_Override(c CfnStack, scope constructs.Construct, id *string, props *CfnStackProps) { _init_.Initialize() _jsii_.Create( "aws-cdk-lib.CfnStack", []interface{}{scope, id, props}, c, ) } func (j *jsiiProxy_CfnStack)SetNotificationArns(val *[]*string) { _jsii_.Set( j, "notificationArns", val, ) } func (j *jsiiProxy_CfnStack)SetParameters(val interface{}) { if err := j.validateSetParametersParameters(val); err != nil { panic(err) } _jsii_.Set( j, "parameters", val, ) } func (j *jsiiProxy_CfnStack)SetTagsRaw(val *[]*CfnTag) { if err := j.validateSetTagsRawParameters(val); err != nil { panic(err) } _jsii_.Set( j, "tagsRaw", val, ) } func (j *jsiiProxy_CfnStack)SetTemplateUrl(val *string) { if err := j.validateSetTemplateUrlParameters(val); err != nil { panic(err) } _jsii_.Set( j, "templateUrl", val, ) } func (j *jsiiProxy_CfnStack)SetTimeoutInMinutes(val *float64) { _jsii_.Set( j, "timeoutInMinutes", val, ) } // Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). // // Uses duck-typing instead of `instanceof` to allow stack elements from different // versions of this library to be included in the same stack. // // Returns: The construct as a stack element or undefined if it is not a stack element. func CfnStack_IsCfnElement(x interface{}) *bool { _init_.Initialize() if err := validateCfnStack_IsCfnElementParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.CfnStack", "isCfnElement", []interface{}{x}, &returns, ) return returns } // Check whether the given construct is a CfnResource. func CfnStack_IsCfnResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateCfnStack_IsCfnResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.CfnStack", "isCfnResource", []interface{}{construct}, &returns, ) return returns } // 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 CfnStack_IsConstruct(x interface{}) *bool { _init_.Initialize() if err := validateCfnStack_IsConstructParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.CfnStack", "isConstruct", []interface{}{x}, &returns, ) return returns } func CfnStack_CFN_RESOURCE_TYPE_NAME() *string { _init_.Initialize() var returns *string _jsii_.StaticGet( "aws-cdk-lib.CfnStack", "CFN_RESOURCE_TYPE_NAME", &returns, ) return returns } func (c *jsiiProxy_CfnStack) AddDeletionOverride(path *string) { if err := c.validateAddDeletionOverrideParameters(path); err != nil { panic(err) } _jsii_.InvokeVoid( c, "addDeletionOverride", []interface{}{path}, ) } func (c *jsiiProxy_CfnStack) AddDependency(target CfnResource) { if err := c.validateAddDependencyParameters(target); err != nil { panic(err) } _jsii_.InvokeVoid( c, "addDependency", []interface{}{target}, ) } func (c *jsiiProxy_CfnStack) AddDependsOn(target CfnResource) { if err := c.validateAddDependsOnParameters(target); err != nil { panic(err) } _jsii_.InvokeVoid( c, "addDependsOn", []interface{}{target}, ) } func (c *jsiiProxy_CfnStack) AddMetadata(key *string, value interface{}) { if err := c.validateAddMetadataParameters(key, value); err != nil { panic(err) } _jsii_.InvokeVoid( c, "addMetadata", []interface{}{key, value}, ) } func (c *jsiiProxy_CfnStack) AddOverride(path *string, value interface{}) { if err := c.validateAddOverrideParameters(path, value); err != nil { panic(err) } _jsii_.InvokeVoid( c, "addOverride", []interface{}{path, value}, ) } func (c *jsiiProxy_CfnStack) AddPropertyDeletionOverride(propertyPath *string) { if err := c.validateAddPropertyDeletionOverrideParameters(propertyPath); err != nil { panic(err) } _jsii_.InvokeVoid( c, "addPropertyDeletionOverride", []interface{}{propertyPath}, ) } func (c *jsiiProxy_CfnStack) AddPropertyOverride(propertyPath *string, value interface{}) { if err := c.validateAddPropertyOverrideParameters(propertyPath, value); err != nil { panic(err) } _jsii_.InvokeVoid( c, "addPropertyOverride", []interface{}{propertyPath, value}, ) } func (c *jsiiProxy_CfnStack) ApplyRemovalPolicy(policy RemovalPolicy, options *RemovalPolicyOptions) { if err := c.validateApplyRemovalPolicyParameters(options); err != nil { panic(err) } _jsii_.InvokeVoid( c, "applyRemovalPolicy", []interface{}{policy, options}, ) } func (c *jsiiProxy_CfnStack) GetAtt(attributeName *string, typeHint ResolutionTypeHint) Reference { if err := c.validateGetAttParameters(attributeName); err != nil { panic(err) } var returns Reference _jsii_.Invoke( c, "getAtt", []interface{}{attributeName, typeHint}, &returns, ) return returns } func (c *jsiiProxy_CfnStack) GetMetadata(key *string) interface{} { if err := c.validateGetMetadataParameters(key); err != nil { panic(err) } var returns interface{} _jsii_.Invoke( c, "getMetadata", []interface{}{key}, &returns, ) return returns } func (c *jsiiProxy_CfnStack) Inspect(inspector TreeInspector) { if err := c.validateInspectParameters(inspector); err != nil { panic(err) } _jsii_.InvokeVoid( c, "inspect", []interface{}{inspector}, ) } func (c *jsiiProxy_CfnStack) ObtainDependencies() *[]interface{} { var returns *[]interface{} _jsii_.Invoke( c, "obtainDependencies", nil, // no parameters &returns, ) return returns } func (c *jsiiProxy_CfnStack) ObtainResourceDependencies() *[]CfnResource { var returns *[]CfnResource _jsii_.Invoke( c, "obtainResourceDependencies", nil, // no parameters &returns, ) return returns } func (c *jsiiProxy_CfnStack) OverrideLogicalId(newLogicalId *string) { if err := c.validateOverrideLogicalIdParameters(newLogicalId); err != nil { panic(err) } _jsii_.InvokeVoid( c, "overrideLogicalId", []interface{}{newLogicalId}, ) } func (c *jsiiProxy_CfnStack) RemoveDependency(target CfnResource) { if err := c.validateRemoveDependencyParameters(target); err != nil { panic(err) } _jsii_.InvokeVoid( c, "removeDependency", []interface{}{target}, ) } func (c *jsiiProxy_CfnStack) RenderProperties(props *map[string]interface{}) *map[string]interface{} { if err := c.validateRenderPropertiesParameters(props); err != nil { panic(err) } var returns *map[string]interface{} _jsii_.Invoke( c, "renderProperties", []interface{}{props}, &returns, ) return returns } func (c *jsiiProxy_CfnStack) ReplaceDependency(target CfnResource, newTarget CfnResource) { if err := c.validateReplaceDependencyParameters(target, newTarget); err != nil { panic(err) } _jsii_.InvokeVoid( c, "replaceDependency", []interface{}{target, newTarget}, ) } func (c *jsiiProxy_CfnStack) ShouldSynthesize() *bool { var returns *bool _jsii_.Invoke( c, "shouldSynthesize", nil, // no parameters &returns, ) return returns } func (c *jsiiProxy_CfnStack) ToString() *string { var returns *string _jsii_.Invoke( c, "toString", nil, // no parameters &returns, ) return returns } func (c *jsiiProxy_CfnStack) ValidateProperties(_properties interface{}) { if err := c.validateValidatePropertiesParameters(_properties); err != nil { panic(err) } _jsii_.InvokeVoid( c, "validateProperties", []interface{}{_properties}, ) }