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" ) // Uses conventionally named roles and asset storage locations. // // This synthesizer: // // - Supports cross-account deployments (the CLI can have credentials to one // account, and you can still deploy to another account by assuming roles with // well-known names in the other account). // - Supports the **CDK Pipelines** library. // // Requires the environment to have been bootstrapped with Bootstrap Stack V2 // (also known as "modern bootstrap stack"). The synthesizer adds a version // check to the template, to make sure the bootstrap stack is recent enough // to support all features expected by this synthesizer. // // Example: // NewMyStack(app, jsii.String("MyStack"), &stackProps{ // Synthesizer: awscdk.NewDefaultStackSynthesizer(&DefaultStackSynthesizerProps{ // FileAssetsBucketName: jsii.String("my-orgs-asset-bucket"), // }), // }) // type DefaultStackSynthesizer interface { StackSynthesizer IBoundStackSynthesizer IReusableStackSynthesizer // The qualifier used to bootstrap this stack. BootstrapQualifier() *string // Retrieve the bound stack. // // Fails if the stack hasn't been bound yet. BoundStack() Stack // Returns the ARN of the CFN execution Role. CloudFormationExecutionRoleArn() *string // Returns the ARN of the deploy Role. DeployRoleArn() *string // The role used to lookup for this stack. LookupRole() *string // Return the currently bound stack. // Deprecated: Use `boundStack` instead. Stack() Stack // Add a CfnRule to the bound stack that checks whether an SSM parameter exceeds a given version. // // This will modify the template, so must be called before the stack is synthesized. AddBootstrapVersionRule(requiredVersion *float64, bootstrapStackVersionSsmParameter *string) // Register a Docker Image Asset. // // Returns the parameters that can be used to refer to the asset inside the template. // // The synthesizer must rely on some out-of-band mechanism to make sure the given files // are actually placed in the returned location before the deployment happens. This can // be by writing the instructions to the asset manifest (for use by the `cdk-assets` tool), // by relying on the CLI to upload files (legacy behavior), or some other operator controlled // mechanism. AddDockerImageAsset(asset *DockerImageAssetSource) *DockerImageAssetLocation // Register a File Asset. // // Returns the parameters that can be used to refer to the asset inside the template. // // The synthesizer must rely on some out-of-band mechanism to make sure the given files // are actually placed in the returned location before the deployment happens. This can // be by writing the instructions to the asset manifest (for use by the `cdk-assets` tool), // by relying on the CLI to upload files (legacy behavior), or some other operator controlled // mechanism. AddFileAsset(asset *FileAssetSource) *FileAssetLocation // Bind to the stack this environment is going to be used on. // // Must be called before any of the other methods are called. Bind(stack Stack) // Turn a docker asset location into a CloudFormation representation of that location. // // If any of the fields contain placeholders, the result will be wrapped in a `Fn.sub`. CloudFormationLocationFromDockerImageAsset(dest *cloudassemblyschema.DockerImageDestination) *DockerImageAssetLocation // Turn a file asset location into a CloudFormation representation of that location. // // If any of the fields contain placeholders, the result will be wrapped in a `Fn.sub`. CloudFormationLocationFromFileAsset(location *cloudassemblyschema.FileDestination) *FileAssetLocation // Write the CloudFormation stack artifact to the session. // // Use default settings to add a CloudFormationStackArtifact artifact to // the given synthesis session. The Stack artifact will control the settings for the // CloudFormation deployment. EmitArtifact(session ISynthesisSession, options *SynthesizeStackArtifactOptions) // Write the stack artifact to the session. // // Use default settings to add a CloudFormationStackArtifact artifact to // the given synthesis session. // Deprecated: Use `emitArtifact` instead. EmitStackArtifact(stack Stack, session ISynthesisSession, options *SynthesizeStackArtifactOptions) // Produce a bound Stack Synthesizer for the given stack. // // This method may be called more than once on the same object. ReusableBind(stack Stack) IBoundStackSynthesizer // Synthesize the associated stack to the session. Synthesize(session ISynthesisSession) // Synthesize the stack template to the given session, passing the configured lookup role ARN. SynthesizeStackTemplate(stack Stack, session ISynthesisSession) // Write the stack template to the given session. // // Return a descriptor that represents the stack template as a file asset // source, for adding to an asset manifest (if desired). This can be used to // have the asset manifest system (`cdk-assets`) upload the template to S3 // using the appropriate role, so that afterwards only a CloudFormation // deployment is necessary. // // If the template is uploaded as an asset, the `stackTemplateAssetObjectUrl` // property should be set when calling `emitArtifact.` // // If the template is *NOT* uploaded as an asset first and the template turns // out to be >50KB, it will need to be uploaded to S3 anyway. At that point // the credentials will be the same identity that is doing the `UpdateStack` // call, which may not have the right permissions to write to S3. SynthesizeTemplate(session ISynthesisSession, lookupRoleArn *string) *FileAssetSource } // The jsii proxy struct for DefaultStackSynthesizer type jsiiProxy_DefaultStackSynthesizer struct { jsiiProxy_StackSynthesizer jsiiProxy_IBoundStackSynthesizer jsiiProxy_IReusableStackSynthesizer } func (j *jsiiProxy_DefaultStackSynthesizer) BootstrapQualifier() *string { var returns *string _jsii_.Get( j, "bootstrapQualifier", &returns, ) return returns } func (j *jsiiProxy_DefaultStackSynthesizer) BoundStack() Stack { var returns Stack _jsii_.Get( j, "boundStack", &returns, ) return returns } func (j *jsiiProxy_DefaultStackSynthesizer) CloudFormationExecutionRoleArn() *string { var returns *string _jsii_.Get( j, "cloudFormationExecutionRoleArn", &returns, ) return returns } func (j *jsiiProxy_DefaultStackSynthesizer) DeployRoleArn() *string { var returns *string _jsii_.Get( j, "deployRoleArn", &returns, ) return returns } func (j *jsiiProxy_DefaultStackSynthesizer) LookupRole() *string { var returns *string _jsii_.Get( j, "lookupRole", &returns, ) return returns } func (j *jsiiProxy_DefaultStackSynthesizer) Stack() Stack { var returns Stack _jsii_.Get( j, "stack", &returns, ) return returns } func NewDefaultStackSynthesizer(props *DefaultStackSynthesizerProps) DefaultStackSynthesizer { _init_.Initialize() if err := validateNewDefaultStackSynthesizerParameters(props); err != nil { panic(err) } j := jsiiProxy_DefaultStackSynthesizer{} _jsii_.Create( "aws-cdk-lib.DefaultStackSynthesizer", []interface{}{props}, &j, ) return &j } func NewDefaultStackSynthesizer_Override(d DefaultStackSynthesizer, props *DefaultStackSynthesizerProps) { _init_.Initialize() _jsii_.Create( "aws-cdk-lib.DefaultStackSynthesizer", []interface{}{props}, d, ) } func DefaultStackSynthesizer_DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER() *string { _init_.Initialize() var returns *string _jsii_.StaticGet( "aws-cdk-lib.DefaultStackSynthesizer", "DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER", &returns, ) return returns } func DefaultStackSynthesizer_DEFAULT_CLOUDFORMATION_ROLE_ARN() *string { _init_.Initialize() var returns *string _jsii_.StaticGet( "aws-cdk-lib.DefaultStackSynthesizer", "DEFAULT_CLOUDFORMATION_ROLE_ARN", &returns, ) return returns } func DefaultStackSynthesizer_DEFAULT_DEPLOY_ROLE_ARN() *string { _init_.Initialize() var returns *string _jsii_.StaticGet( "aws-cdk-lib.DefaultStackSynthesizer", "DEFAULT_DEPLOY_ROLE_ARN", &returns, ) return returns } func DefaultStackSynthesizer_DEFAULT_DOCKER_ASSET_PREFIX() *string { _init_.Initialize() var returns *string _jsii_.StaticGet( "aws-cdk-lib.DefaultStackSynthesizer", "DEFAULT_DOCKER_ASSET_PREFIX", &returns, ) return returns } func DefaultStackSynthesizer_DEFAULT_FILE_ASSET_KEY_ARN_EXPORT_NAME() *string { _init_.Initialize() var returns *string _jsii_.StaticGet( "aws-cdk-lib.DefaultStackSynthesizer", "DEFAULT_FILE_ASSET_KEY_ARN_EXPORT_NAME", &returns, ) return returns } func DefaultStackSynthesizer_DEFAULT_FILE_ASSET_PREFIX() *string { _init_.Initialize() var returns *string _jsii_.StaticGet( "aws-cdk-lib.DefaultStackSynthesizer", "DEFAULT_FILE_ASSET_PREFIX", &returns, ) return returns } func DefaultStackSynthesizer_DEFAULT_FILE_ASSET_PUBLISHING_ROLE_ARN() *string { _init_.Initialize() var returns *string _jsii_.StaticGet( "aws-cdk-lib.DefaultStackSynthesizer", "DEFAULT_FILE_ASSET_PUBLISHING_ROLE_ARN", &returns, ) return returns } func DefaultStackSynthesizer_DEFAULT_FILE_ASSETS_BUCKET_NAME() *string { _init_.Initialize() var returns *string _jsii_.StaticGet( "aws-cdk-lib.DefaultStackSynthesizer", "DEFAULT_FILE_ASSETS_BUCKET_NAME", &returns, ) return returns } func DefaultStackSynthesizer_DEFAULT_IMAGE_ASSET_PUBLISHING_ROLE_ARN() *string { _init_.Initialize() var returns *string _jsii_.StaticGet( "aws-cdk-lib.DefaultStackSynthesizer", "DEFAULT_IMAGE_ASSET_PUBLISHING_ROLE_ARN", &returns, ) return returns } func DefaultStackSynthesizer_DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME() *string { _init_.Initialize() var returns *string _jsii_.StaticGet( "aws-cdk-lib.DefaultStackSynthesizer", "DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME", &returns, ) return returns } func DefaultStackSynthesizer_DEFAULT_LOOKUP_ROLE_ARN() *string { _init_.Initialize() var returns *string _jsii_.StaticGet( "aws-cdk-lib.DefaultStackSynthesizer", "DEFAULT_LOOKUP_ROLE_ARN", &returns, ) return returns } func DefaultStackSynthesizer_DEFAULT_QUALIFIER() *string { _init_.Initialize() var returns *string _jsii_.StaticGet( "aws-cdk-lib.DefaultStackSynthesizer", "DEFAULT_QUALIFIER", &returns, ) return returns } func (d *jsiiProxy_DefaultStackSynthesizer) AddBootstrapVersionRule(requiredVersion *float64, bootstrapStackVersionSsmParameter *string) { if err := d.validateAddBootstrapVersionRuleParameters(requiredVersion, bootstrapStackVersionSsmParameter); err != nil { panic(err) } _jsii_.InvokeVoid( d, "addBootstrapVersionRule", []interface{}{requiredVersion, bootstrapStackVersionSsmParameter}, ) } func (d *jsiiProxy_DefaultStackSynthesizer) AddDockerImageAsset(asset *DockerImageAssetSource) *DockerImageAssetLocation { if err := d.validateAddDockerImageAssetParameters(asset); err != nil { panic(err) } var returns *DockerImageAssetLocation _jsii_.Invoke( d, "addDockerImageAsset", []interface{}{asset}, &returns, ) return returns } func (d *jsiiProxy_DefaultStackSynthesizer) AddFileAsset(asset *FileAssetSource) *FileAssetLocation { if err := d.validateAddFileAssetParameters(asset); err != nil { panic(err) } var returns *FileAssetLocation _jsii_.Invoke( d, "addFileAsset", []interface{}{asset}, &returns, ) return returns } func (d *jsiiProxy_DefaultStackSynthesizer) Bind(stack Stack) { if err := d.validateBindParameters(stack); err != nil { panic(err) } _jsii_.InvokeVoid( d, "bind", []interface{}{stack}, ) } func (d *jsiiProxy_DefaultStackSynthesizer) CloudFormationLocationFromDockerImageAsset(dest *cloudassemblyschema.DockerImageDestination) *DockerImageAssetLocation { if err := d.validateCloudFormationLocationFromDockerImageAssetParameters(dest); err != nil { panic(err) } var returns *DockerImageAssetLocation _jsii_.Invoke( d, "cloudFormationLocationFromDockerImageAsset", []interface{}{dest}, &returns, ) return returns } func (d *jsiiProxy_DefaultStackSynthesizer) CloudFormationLocationFromFileAsset(location *cloudassemblyschema.FileDestination) *FileAssetLocation { if err := d.validateCloudFormationLocationFromFileAssetParameters(location); err != nil { panic(err) } var returns *FileAssetLocation _jsii_.Invoke( d, "cloudFormationLocationFromFileAsset", []interface{}{location}, &returns, ) return returns } func (d *jsiiProxy_DefaultStackSynthesizer) EmitArtifact(session ISynthesisSession, options *SynthesizeStackArtifactOptions) { if err := d.validateEmitArtifactParameters(session, options); err != nil { panic(err) } _jsii_.InvokeVoid( d, "emitArtifact", []interface{}{session, options}, ) } func (d *jsiiProxy_DefaultStackSynthesizer) EmitStackArtifact(stack Stack, session ISynthesisSession, options *SynthesizeStackArtifactOptions) { if err := d.validateEmitStackArtifactParameters(stack, session, options); err != nil { panic(err) } _jsii_.InvokeVoid( d, "emitStackArtifact", []interface{}{stack, session, options}, ) } func (d *jsiiProxy_DefaultStackSynthesizer) ReusableBind(stack Stack) IBoundStackSynthesizer { if err := d.validateReusableBindParameters(stack); err != nil { panic(err) } var returns IBoundStackSynthesizer _jsii_.Invoke( d, "reusableBind", []interface{}{stack}, &returns, ) return returns } func (d *jsiiProxy_DefaultStackSynthesizer) Synthesize(session ISynthesisSession) { if err := d.validateSynthesizeParameters(session); err != nil { panic(err) } _jsii_.InvokeVoid( d, "synthesize", []interface{}{session}, ) } func (d *jsiiProxy_DefaultStackSynthesizer) SynthesizeStackTemplate(stack Stack, session ISynthesisSession) { if err := d.validateSynthesizeStackTemplateParameters(stack, session); err != nil { panic(err) } _jsii_.InvokeVoid( d, "synthesizeStackTemplate", []interface{}{stack, session}, ) } func (d *jsiiProxy_DefaultStackSynthesizer) SynthesizeTemplate(session ISynthesisSession, lookupRoleArn *string) *FileAssetSource { if err := d.validateSynthesizeTemplateParameters(session); err != nil { panic(err) } var returns *FileAssetSource _jsii_.Invoke( d, "synthesizeTemplate", []interface{}{session, lookupRoleArn}, &returns, ) return returns }