Periodic doc update

Author: evzzk

v2/best-practices.md

@@ -9,7 +9,7 @@ Stacks define the deployment model of these logical units\. For a more detailed
 
 The AWS CDK reflects careful consideration of the needs of our customers and internal teams and of the failure patterns that often arise during the deployment and ongoing maintenance of complex cloud applications\. We discovered that failures are often related to "out\-of\-band" changes to an application that aren't fully tested, such as configuration changes\. Therefore, we developed the AWS CDK around a model in which your entire application is defined in code, not only business logic but also infrastructure and configuration\. That way, proposed changes can be carefully reviewed, comprehensively tested in environments resembling production to varying degrees, and fully rolled back if something goes wrong\.
 
-![\[Image NOT FOUND\]](http://docs.aws.amazon.com/cdk/v2/guide/images/all-in-one.jpg)
+![\[\]](http://docs.aws.amazon.com/cdk/v2/guide/images/all-in-one.jpg)
 
 At deployment time, the AWS CDK synthesizes a cloud assembly that contains the following: 
 + AWS CloudFormation templates that describe your infrastructure in all target environments 
@@ -36,13 +36,13 @@ The CCoE also creates a "landing zone" that defines your organizational units wi
 
 Development teams should be able to use their own accounts for testing and deploy new resources in these accounts as needed\. Individual developers can treat these resources as extensions of their own development workstation\. Using [CDK Pipelines](cdk_pipeline.md), the AWS CDK applications can then be deployed via a CI/CD account to testing, integration, and production environments \(each isolated in its own AWS Region or account\)\. This is done by merging the developers' code into your organization's canonical repository\.
 
-![\[Image NOT FOUND\]](http://docs.aws.amazon.com/cdk/v2/guide/images/best-practice-deploy-to-multiple-accounts.png)
+![\[\]](http://docs.aws.amazon.com/cdk/v2/guide/images/best-practice-deploy-to-multiple-accounts.png)
 
 ## Coding best practices<a name="best-practices-code"></a>
 
 This section presents best practices for organizing your AWS CDK code\. The following diagram shows the relationship between a team and that team's code repositories, packages, applications, and construct libraries\. 
 
-![\[Image NOT FOUND\]](http://docs.aws.amazon.com/cdk/v2/guide/images/code-organization.jpg)
+![\[\]](http://docs.aws.amazon.com/cdk/v2/guide/images/code-organization.jpg)
 
 ### Start simple and add complexity only when you need it<a name="best-practices-code-kiss"></a>
 
@@ -137,7 +137,7 @@ What's worse, you can't make changes to the resource that require it to be repla
 A better approach is to specify as few names as possible\. If you omit resource names, the AWS CDK will generate them for you in a way that won't cause problems\. Suppose you have a table as a resource\. You can then pass the generated table name as an environment variable into your AWS Lambda function\. In your AWS CDK application, you can reference the table name as `table.tableName`\. Alternatively, you can generate a configuration file on your Amazon EC2 instance on startup, or write the actual table name to the AWS Systems Manager Parameter Store so your application can read it from there\.
 
 If the place you need it is another AWS CDK stack, that's even more straightforward\. Supposing that one stack defines the resource and another stack needs to use it, the following applies:
-+ If the two stacks are in the same AWS CDK app, pass a reference between the two stacks\. For example, save a reference to the resource's construct as an attribute of the defining stack \(`this.stack.uploadBucket = myBucket`\)\. Then, pass that attribute to the constructor of the stack that needs the resource\.
++ If the two stacks are in the same AWS CDK app, pass a reference between the two stacks\. For example, save a reference to the resource's construct as an attribute of the defining stack \(`this.stack.uploadBucket = amzn-s3-demo-bucket`\)\. Then, pass that attribute to the constructor of the stack that needs the resource\.
 + When the two stacks are in different AWS CDK apps, use a static `from` method to use an externally defined resource based on its ARN, name, or other attributes\. \(For example, use `Table.fromArn()` for a DynamoDB table\)\. Use the `CfnOutput` construct to print the ARN or other required value in the output of `cdk deploy`, or look in the AWS Management Console\. Alternatively, the second app can read the CloudFormation template generated by the first app and retrieve that value from the `Outputs` section\.
 
 ### Define removal policies and log retention<a name="best-practices-apps-removal-logs"></a>
@@ -176,7 +176,7 @@ If you need some value \(from AWS or elsewhere\) for which there is no native CD
 With the AWS CDK construct library's `grant()` convenience methods, you can create AWS Identity and Access Management roles that grant access to one resource by another using minimally scoped permissions\. For example, consider a line like the following:
 
 ```
-myBucket.grantRead(myLambda)
+amzn-s3-demo-bucket.grantRead(myLambda)
 ```
 
 This single line adds a policy to the Lambda function's role \(which is also created for you\)\. That role and its policies are more than a dozen lines of CloudFormation that you don't have to write\. The AWS CDK grants only the minimal permissions required for the function to read from the bucket\.

v2/cfn_layer.md

@@ -37,7 +37,7 @@ For example, to instantiate a low\-level Amazon S3 bucket L1 with analytics enab
 #### [ TypeScript ]
 
 ```
-new s3.CfnBucket(this, 'MyBucket', {
+new s3.CfnBucket(this, 'amzn-s3-demo-bucket', {
   analyticsConfigurations: [
     { 
       id: 'Config',
@@ -51,7 +51,7 @@ new s3.CfnBucket(this, 'MyBucket', {
 #### [ JavaScript ]
 
 ```
-new s3.CfnBucket(this, 'MyBucket', {
+new s3.CfnBucket(this, 'amzn-s3-demo-bucket', {
   analyticsConfigurations: [
     { 
       id: 'Config'
@@ -65,7 +65,7 @@ new s3.CfnBucket(this, 'MyBucket', {
 #### [ Python ]
 
 ```
-s3.CfnBucket(self, "MyBucket",
+s3.CfnBucket(self, "amzn-s3-demo-bucket",
     analytics_configurations: [
         dict(id="Config",
              # ...
@@ -78,7 +78,7 @@ s3.CfnBucket(self, "MyBucket",
 #### [ Java ]
 
 ```
-CfnBucket.Builder.create(this, "MyBucket")
+CfnBucket.Builder.create(this, "amzn-s3-demo-bucket")
     .analyticsConfigurations(Arrays.asList(java.util.Map.of(    // Java 9 or later
         "id", "Config", // ...
     ))).build();
@@ -88,7 +88,7 @@ CfnBucket.Builder.create(this, "MyBucket")
 #### [ C\# ]
 
 ```
-new CfnBucket(this, 'MyBucket', new CfnBucketProps {
+new CfnBucket(this, 'amzn-s3-demo-bucket', new CfnBucketProps {
     AnalyticsConfigurations = new Dictionary<string, string>
     {
         ["id"] = "Config",
@@ -105,7 +105,7 @@ There might be rare cases where you want to define a resource that doesn't have
 #### [ TypeScript ]
 
 ```
-new cdk.CfnResource(this, 'MyBucket', {
+new cdk.CfnResource(this, 'amzn-s3-demo-bucket', {
   type: 'AWS::S3::Bucket',
   properties: {
     // Note the PascalCase here! These are CloudFormation identifiers.
@@ -123,7 +123,7 @@ new cdk.CfnResource(this, 'MyBucket', {
 #### [ JavaScript ]
 
 ```
-new cdk.CfnResource(this, 'MyBucket', {
+new cdk.CfnResource(this, 'amzn-s3-demo-bucket', {
   type: 'AWS::S3::Bucket',
   properties: {
     // Note the PascalCase here! These are CloudFormation identifiers.
@@ -141,7 +141,7 @@ new cdk.CfnResource(this, 'MyBucket', {
 #### [ Python ]
 
 ```
-cdk.CfnResource(self, 'MyBucket',
+cdk.CfnResource(self, 'amzn-s3-demo-bucket',
   type="AWS::S3::Bucket",
   properties=dict(
     # Note the PascalCase here! These are CloudFormation identifiers.
@@ -159,7 +159,7 @@ cdk.CfnResource(self, 'MyBucket',
 #### [ Java ]
 
 ```
-CfnResource.Builder.create(this, "MyBucket")
+CfnResource.Builder.create(this, "amzn-s3-demo-bucket")
         .type("AWS::S3::Bucket")
         .properties(java.util.Map.of(    // Map.of requires Java 9 or later
             // Note the PascalCase here! These are CloudFormation identifiers
@@ -173,7 +173,7 @@ CfnResource.Builder.create(this, "MyBucket")
 #### [ C\# ]
 
 ```
-new CfnResource(this, "MyBucket", new CfnResourceProps
+new CfnResource(this, "amzn-s3-demo-bucket", new CfnResourceProps
 {
     Type = "AWS::S3::Bucket",
     Properties = new Dictionary<string, object>

v2/configure-access-sso-example-cli.md

@@ -113,7 +113,7 @@ $ cdk diff --profile my-dev-profile
 Stack CdkAppStack
 Hold on while we create a read-only change set to get a diff with accurate replacement information (use --no-change-set to use a less accurate but faster template-only diff)
 Resources
-[-] AWS::S3::Bucket myBucket myBucket5AF9C99B destroy
+[-] AWS::S3::Bucket amzn-s3-demo-bucket amzn-s3-demo-bucket5AF9C99B destroy
 
 Outputs
 [-] Output BucketRegion: {"Value":{"Ref":"AWS::Region"}}

v2/configure-env.md

@@ -345,7 +345,7 @@ export class CdkAppStack extends cdk.Stack {
     super(scope, id, props);
 
     // Create the S3 bucket
-    const bucket = new s3.Bucket(this, 'myBucket', {
+    const bucket = new s3.Bucket(this, 'amzn-s3-demo-bucket', {
       removalPolicy: cdk.RemovalPolicy.DESTROY,
     });
     
@@ -366,7 +366,7 @@ class CdkAppStack extends cdk.Stack {
     super(scope, id, props);
 
     // Create the S3 bucket
-    const bucket = new s3.Bucket(this, 'myBucket', {
+    const bucket = new s3.Bucket(this, 'amzn-s3-demo-bucket', {
       removalPolicy: cdk.RemovalPolicy.DESTROY,
     });
     
@@ -388,7 +388,7 @@ class CdkAppStack(cdk.Stack):
         super().__init__(scope, id, **kwargs)
 
         # Create the S3 bucket
-        bucket = s3.Bucket(self, 'myBucket',
+        bucket = s3.Bucket(self, 'amzn-s3-demo-bucket',
             removal_policy=cdk.RemovalPolicy.DESTROY
         )
         
@@ -408,7 +408,7 @@ public class CdkAppStack extends Stack {
         super(scope, id, props);
 
         // Create the S3 bucket
-        Bucket bucket = Bucket.Builder.create(this, "myBucket")
+        Bucket bucket = Bucket.Builder.create(this, "amzn-s3-demo-bucket")
             .removalPolicy(RemovalPolicy.DESTROY)
             .build();
         
@@ -431,7 +431,7 @@ namespace MyCdkApp
         public CdkAppStack(Construct scope, string id, IStackProps props = null) : base(scope, id, props)
         {
             // Create the S3 bucket
-            var bucket = new Bucket(this, "myBucket", new BucketProps
+            var bucket = new Bucket(this, "amzn-s3-demo-bucket", new BucketProps
             {
                 RemovalPolicy = RemovalPolicy.DESTROY
             });
@@ -454,7 +454,7 @@ func NewCdkAppStack(scope constructs.Construct, id string, props *CdkAppStackPro
 	stack := awscdk.NewStack(scope, &id, &props.StackProps)
 
 	// Create the S3 bucket
-	bucket := awss3.NewBucket(stack, jsii.String("myBucket"), &awss3.BucketProps{
+	bucket := awss3.NewBucket(stack, jsii.String("amzn-s3-demo-bucket"), &awss3.BucketProps{
 		RemovalPolicy: awscdk.RemovalPolicy_DESTROY,
 	})
 	

v2/configure-synth.md

@@ -597,7 +597,7 @@ new DefaultStackSynthesizer(new DefaultStackSynthesizerProps
 
 To modify the security credentials used to provide permissions during CDK deployments, you can customize synthesis by using `[CliCredentialsStackSynthesizer](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.CliCredentialsStackSynthesizer.html)`\. This synthesizer works with the default AWS resources that are created during bootstrapping to store assets, such as the Amazon S3 bucket and Amazon ECR repository\. Instead of using the default IAM roles created by the CDK during bootstrapping, it uses the security credentials of the actor initiating deployment\. Therefore, the security credentials of the actor must have valid permissions to perform all deployment actions\. The following diagram illustrates the deployment process when using this synthesizer:
 
-![\[Flowchart of the default AWS CDK deployment process.\]](http://docs.aws.amazon.com/cdk/v2/guide/images/CliCredentialsStackSynthesizer-deploy-process_cdk_flowchart.svg)
+![\[\]](http://docs.aws.amazon.com/cdk/v2/guide/images/CliCredentialsStackSynthesizer-deploy-process_cdk_flowchart.svg)
 
 When using `CliCredentialsStackSynthesizer`:
 + By default, CloudFormation performs API calls in your account using the permissions of the actor\. Therefore, the current identity must have permission to make necessary changes to the AWS resources in the CloudFormation stack, along with the permissions to perform necessary CloudFormation operations, such as `CreateStack` or `UpdateStack`\. Deployment capabilities will be limited to the permissions of the actor\.

v2/constructs.md

@@ -450,50 +450,50 @@ In this example, we create a `bucket` object using the `CfnBucket` L1 construct:
 #### [ TypeScript ]
 
 ```
-const bucket = new s3.CfnBucket(this, "MyBucket", {
-  bucketName: "MyBucket"
+const bucket = new s3.CfnBucket(this, "amzn-s3-demo-bucket", {
+  bucketName: "amzn-s3-demo-bucket"
 });
 ```
 
 ------
 #### [ JavaScript ]
 
 ```
-const bucket = new s3.CfnBucket(this, "MyBucket", {
-  bucketName: "MyBucket"
+const bucket = new s3.CfnBucket(this, "amzn-s3-demo-bucket", {
+  bucketName: "amzn-s3-demo-bucket"
 });
 ```
 
 ------
 #### [ Python ]
 
 ```
-bucket = s3.CfnBucket(self, "MyBucket", bucket_name="MyBucket")
+bucket = s3.CfnBucket(self, "amzn-s3-demo-bucket", bucket_name="amzn-s3-demo-bucket")
 ```
 
 ------
 #### [ Java ]
 
 ```
-CfnBucket bucket = new CfnBucket.Builder().bucketName("MyBucket").build();
+CfnBucket bucket = new CfnBucket.Builder().bucketName("amzn-s3-demo-bucket").build();
 ```
 
 ------
 #### [ C\# ]
 
 ```
-var bucket = new CfnBucket(this, "MyBucket", new CfnBucketProps
+var bucket = new CfnBucket(this, "amzn-s3-demo-bucket", new CfnBucketProps
 {
-    BucketName= "MyBucket"
+    BucketName= "amzn-s3-demo-bucket"
 });
 ```
 
 ------
 #### [ Go ]
 
 ```
-	awss3.NewCfnBucket(stack, jsii.String("MyBucket"), &awss3.CfnBucketProps{
-		BucketName: jsii.String("MyBucket"),
+	awss3.NewCfnBucket(stack, jsii.String("amzn-s3-demo-bucket"), &awss3.CfnBucketProps{
+		BucketName: jsii.String("amzn-s3-demo-bucket"),
 	})
 ```
 
@@ -505,8 +505,8 @@ Construct properties that aren't simple Booleans, strings, numbers, or container
 #### [ TypeScript ]
 
 ```
-const bucket = new s3.CfnBucket(this, "MyBucket", {
-  bucketName: "MyBucket",
+const bucket = new s3.CfnBucket(this, "amzn-s3-demo-bucket", {
+  bucketName: "amzn-s3-demo-bucket",
   corsConfiguration: {
     corsRules: [{
           allowedOrigins: ["*"],
@@ -520,8 +520,8 @@ const bucket = new s3.CfnBucket(this, "MyBucket", {
 #### [ JavaScript ]
 
 ```
-const bucket = new s3.CfnBucket(this, "MyBucket", {
-  bucketName: "MyBucket",
+const bucket = new s3.CfnBucket(this, "amzn-s3-demo-bucket", {
+  bucketName: "amzn-s3-demo-bucket",
   corsConfiguration: {
     corsRules: [{
           allowedOrigins: ["*"],
@@ -537,7 +537,7 @@ const bucket = new s3.CfnBucket(this, "MyBucket", {
 In Python, these properties are represented by types defined as inner classes of the L1 construct\. For example, the optional property `cors_configuration` of a `CfnBucket` requires a wrapper of type `CfnBucket.CorsConfigurationProperty`\. Here we are defining `cors_configuration` on a `CfnBucket` instance\.
 
 ```
-bucket = CfnBucket(self, "MyBucket", bucket_name="MyBucket",
+bucket = CfnBucket(self, "amzn-s3-demo-bucket", bucket_name="amzn-s3-demo-bucket",
     cors_configuration=CfnBucket.CorsConfigurationProperty(
         cors_rules=[CfnBucket.CorsRuleProperty(
             allowed_origins=["*"],
@@ -553,8 +553,8 @@ bucket = CfnBucket(self, "MyBucket", bucket_name="MyBucket",
 In Java, these properties are represented by types defined as inner classes of the L1 construct\. For example, the optional property `corsConfiguration` of a `CfnBucket` requires a wrapper of type `CfnBucket.CorsConfigurationProperty`\. Here we are defining `corsConfiguration` on a `CfnBucket` instance\.
 
 ```
-CfnBucket bucket = CfnBucket.Builder.create(this, "MyBucket")
-                        .bucketName("MyBucket")
+CfnBucket bucket = CfnBucket.Builder.create(this, "amzn-s3-demo-bucket")
+                        .bucketName("amzn-s3-demo-bucket")
                         .corsConfiguration(new CfnBucket.CorsConfigurationProperty.Builder()
                             .corsRules(Arrays.asList(new CfnBucket.CorsRuleProperty.Builder()
                                 .allowedOrigins(Arrays.asList("*"))
@@ -570,9 +570,9 @@ CfnBucket bucket = CfnBucket.Builder.create(this, "MyBucket")
 In C\#, these properties are represented by types defined as inner classes of the L1 construct\. For example, the optional property `CorsConfiguration` of a `CfnBucket` requires a wrapper of type `CfnBucket.CorsConfigurationProperty`\. Here we are defining `CorsConfiguration` on a `CfnBucket` instance\.
 
 ```
-var bucket = new CfnBucket(this, "MyBucket", new CfnBucketProps
+var bucket = new CfnBucket(this, "amzn-s3-demo-bucket", new CfnBucketProps
 {
-    BucketName = "MyBucket",
+    BucketName = "amzn-s3-demo-bucket",
     CorsConfiguration = new CfnBucket.CorsConfigurationProperty
     {
         CorsRules = new object[] {
@@ -592,8 +592,8 @@ var bucket = new CfnBucket(this, "MyBucket", new CfnBucketProps
 In Go, these types are named using the name of the L1 construct, an underscore, and the property name\. For example, the optional property `CorsConfiguration` of a `CfnBucket` requires a wrapper of type `CfnBucket_CorsConfigurationProperty`\. Here we are defining `CorsConfiguration` on a `CfnBucket` instance\.
 
 ```
-	awss3.NewCfnBucket(stack, jsii.String("MyBucket"), &awss3.CfnBucketProps{
-		BucketName: jsii.String("MyBucket"),
+	awss3.NewCfnBucket(stack, jsii.String("amzn-s3-demo-bucket"), &awss3.CfnBucketProps{
+		BucketName: jsii.String("amzn-s3-demo-bucket"),
 		CorsConfiguration: &awss3.CfnBucket_CorsConfigurationProperty{
 			CorsRules: []awss3.CorsRule{
 				awss3.CorsRule{

v2/deploy.md

@@ -150,7 +150,7 @@ To deploy your application, we recommend that you use the CDK CLI `cdk deploy` c
 
 When you run `cdk deploy`, the CDK CLI initiates `cdk synth` to prepare for deployment\. The following diagram illustrates the app lifecycle in the context of a deployment:
 
-![\[Flowchart of the AWS CDK app lifecycle.\]](http://docs.aws.amazon.com/cdk/v2/guide/images/app-lifecycle_cdk-flowchart.svg)
+![\[\]](http://docs.aws.amazon.com/cdk/v2/guide/images/app-lifecycle_cdk-flowchart.svg)
 
 During deployment, the CDK CLI takes the cloud assembly produced by synthesis and deploys it to an AWS environment\. Assets are uploaded to Amazon S3 and Amazon ECR and the CloudFormation template is submitted to AWS CloudFormation for deployment\.
 
@@ -162,7 +162,7 @@ By the time the AWS CloudFormation deployment phase starts, your CDK app has alr
 
 Before deployment can be performed, permissions must be established\. The following diagram illustrates the permissions that are used during a default deployment, when using the default bootstrapping process and stack synthesizer:
 
-![\[Flowchart of the default AWS CDK deployment process.\]](http://docs.aws.amazon.com/cdk/v2/guide/images/default-deploy-process_cdk_flowchart.svg)
+![\[\]](http://docs.aws.amazon.com/cdk/v2/guide/images/default-deploy-process_cdk_flowchart.svg)
 
 **Actor initiates deployment**  
 Deployments are initiated by an *actor*, using the CDK CLI\. An actor can either be a person, or a service such as AWS CodePipeline\.