-
Notifications
You must be signed in to change notification settings - Fork 17
/
StackProps.go
163 lines (160 loc) · 7.6 KB
/
StackProps.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
package awscdk
// Example:
// stack1 := awscdk.Newstack(app, jsii.String("Stack1"), &stackProps{
// Env: &Environment{
// Region: jsii.String("us-east-1"),
// },
// CrossRegionReferences: jsii.Boolean(true),
// })
// cert := acm.NewCertificate(stack1, jsii.String("Cert"), &CertificateProps{
// DomainName: jsii.String("*.example.com"),
// Validation: acm.CertificateValidation_FromDns(route53.PublicHostedZone_FromHostedZoneId(stack1, jsii.String("Zone"), jsii.String("Z0329774B51CGXTDQV3X"))),
// })
//
// stack2 := awscdk.Newstack(app, jsii.String("Stack2"), &stackProps{
// Env: &Environment{
// Region: jsii.String("us-east-2"),
// },
// CrossRegionReferences: jsii.Boolean(true),
// })
// cloudfront.NewDistribution(stack2, jsii.String("Distribution"), &DistributionProps{
// DefaultBehavior: &BehaviorOptions{
// Origin: origins.NewHttpOrigin(jsii.String("example.com")),
// },
// DomainNames: []*string{
// jsii.String("dev.example.com"),
// },
// Certificate: cert,
// })
//
type StackProps struct {
// Include runtime versioning information in this Stack.
// Default: `analyticsReporting` setting of containing `App`, or value of
// 'aws:cdk:version-reporting' context key.
//
AnalyticsReporting *bool `field:"optional" json:"analyticsReporting" yaml:"analyticsReporting"`
// 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.
// Default: false.
//
CrossRegionReferences *bool `field:"optional" json:"crossRegionReferences" yaml:"crossRegionReferences"`
// A description of the stack.
// Default: - No description.
//
Description *string `field:"optional" json:"description" yaml:"description"`
// 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.
//
// Example:
// // Use a concrete account and region to deploy this stack to:
// // `.account` and `.region` will simply return these values.
// // Use a concrete account and region to deploy this stack to:
// // `.account` and `.region` will simply return these values.
// awscdk.Newstack(app, jsii.String("Stack1"), &stackProps{
// Env: &Environment{
// Account: jsii.String("123456789012"),
// Region: jsii.String("us-east-1"),
// },
// })
//
// // Use the CLI's current credentials to determine the target environment:
// // `.account` and `.region` will reflect the account+region the CLI
// // is configured to use (based on the user CLI credentials)
// // Use the CLI's current credentials to determine the target environment:
// // `.account` and `.region` will reflect the account+region the CLI
// // is configured to use (based on the user CLI credentials)
// awscdk.Newstack(app, jsii.String("Stack2"), &stackProps{
// Env: &Environment{
// Account: process.env.cDK_DEFAULT_ACCOUNT,
// Region: process.env.cDK_DEFAULT_REGION,
// },
// })
//
// // Define multiple stacks stage associated with an environment
// myStage := awscdk.NewStage(app, jsii.String("MyStage"), &StageProps{
// Env: &Environment{
// Account: jsii.String("123456789012"),
// Region: jsii.String("us-east-1"),
// },
// })
//
// // both of these stacks will use the stage's account/region:
// // `.account` and `.region` will resolve to the concrete values as above
// // both of these stacks will use the stage's account/region:
// // `.account` and `.region` will resolve to the concrete values as above
// NewMyStack(myStage, jsii.String("Stack1"))
// NewYourStack(myStage, jsii.String("Stack2"))
//
// // Define an environment-agnostic stack:
// // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
// // which will only resolve to actual values by CloudFormation during deployment.
// // Define an environment-agnostic stack:
// // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
// // which will only resolve to actual values by CloudFormation during deployment.
// NewMyStack(app, jsii.String("Stack1"))
//
// Default: - The environment of the containing `Stage` if available,
// otherwise create the stack will be environment-agnostic.
//
Env *Environment `field:"optional" json:"env" yaml:"env"`
// Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.
// Default: - no permissions boundary is applied.
//
PermissionsBoundary PermissionsBoundary `field:"optional" json:"permissionsBoundary" yaml:"permissionsBoundary"`
// Name to deploy the stack with.
// Default: - Derived from construct path.
//
StackName *string `field:"optional" json:"stackName" yaml:"stackName"`
// 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.
// Default: - the value of `@aws-cdk/core:suppressTemplateIndentation`, or `false` if that is not set.
//
SuppressTemplateIndentation *bool `field:"optional" json:"suppressTemplateIndentation" yaml:"suppressTemplateIndentation"`
// 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.
// Default: - The synthesizer specified on `App`, or `DefaultStackSynthesizer` otherwise.
//
Synthesizer IStackSynthesizer `field:"optional" json:"synthesizer" yaml:"synthesizer"`
// Stack tags that will be applied to all the taggable resources and the stack itself.
// Default: {}.
//
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
// Whether to enable termination protection for this stack.
// Default: false.
//
TerminationProtection *bool `field:"optional" json:"terminationProtection" yaml:"terminationProtection"`
}