Change add_description to set_description in all examples (cloudtools…

…#1425)
davemasino · Oct 17, 2019 · 8835428 · 8835428
1 parent 9490c3d
commit 8835428
Show file tree

Hide file tree

Showing 47 changed files with 47 additions and 47 deletions.
diff --git a/examples/ApplicationELB.py b/examples/ApplicationELB.py
@@ -23,7 +23,7 @@ def main():
     template = Template()
     template.add_version("2010-09-09")
 
-    template.add_description(
+    template.set_description(
         "AWS CloudFormation Sample Template: ELB with 2 EC2 instances")
 
     AddAMI(template)

diff --git a/examples/Autoscaling.py b/examples/Autoscaling.py
@@ -12,7 +12,7 @@
 
 t = Template()
 
-t.add_description("""\
+t.set_description("""\
 Configures autoscaling group for api app""")
 
 SecurityGroup = t.add_parameter(Parameter(

diff --git a/examples/AutoscalingHTTPRequests.py b/examples/AutoscalingHTTPRequests.py
@@ -14,7 +14,7 @@
 
 t = Template()
 
-t.add_description("""\
+t.set_description("""\
 Configures autoscaling group for api app""")
 
 SecurityGroup = t.add_parameter(Parameter(

diff --git a/examples/CloudFormation_Init_ConfigSet.py b/examples/CloudFormation_Init_ConfigSet.py
@@ -5,7 +5,7 @@
 
 t = Template()
 
-t.add_description("Configures an EC2 instance using cfn-init configsets")
+t.set_description("Configures an EC2 instance using cfn-init configsets")
 
 key_name = t.add_parameter(Parameter(
     'KeyName',

diff --git a/examples/CloudFront_Distribution_S3.py b/examples/CloudFront_Distribution_S3.py
@@ -11,7 +11,7 @@
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template CloudFront_S3: Sample template "
     "showing how to create an Amazon CloudFront distribution using an "
     "S3 origin. "

diff --git a/examples/CloudFront_StreamingDistribution_S3.py b/examples/CloudFront_StreamingDistribution_S3.py
@@ -11,7 +11,7 @@
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template CloudFront_S3: Sample template "
     "showing how to create an Amazon CloudFront Streaming distribution "
     "using an S3 origin. "

diff --git a/examples/CustomResource.py b/examples/CustomResource.py
@@ -13,7 +13,7 @@ class CustomPlacementGroup(AWSCustomObject):
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "Example template showing how a Lambda Function CustomResource might look"
     "For information on AWS Lambda-backed Custom Resources see:"
     "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/"

diff --git a/examples/DynamoDB_Table.py b/examples/DynamoDB_Table.py
@@ -8,7 +8,7 @@
 
 t = Template()
 
-t.add_description("AWS CloudFormation Sample Template: This template "
+t.set_description("AWS CloudFormation Sample Template: This template "
                   "demonstrates the creation of a DynamoDB table.")
 
 hashkeyname = t.add_parameter(Parameter(

diff --git a/examples/DynamoDB_Table_With_GSI_And_NonKeyAttributes_Projection.py b/examples/DynamoDB_Table_With_GSI_And_NonKeyAttributes_Projection.py
@@ -12,7 +12,7 @@
 
 template = Template()
 
-template.add_description("Create a dynamodb table with a global secondary "
+template.set_description("Create a dynamodb table with a global secondary "
                          "index")
 # N.B. If you remove the provisioning section this works for
 # LocalSecondaryIndexes aswell.

diff --git a/examples/DynamoDB_Table_With_GlobalSecondaryIndex.py b/examples/DynamoDB_Table_With_GlobalSecondaryIndex.py
@@ -12,7 +12,7 @@
 
 template = Template()
 
-template.add_description("Create a dynamodb table with a global secondary "
+template.set_description("Create a dynamodb table with a global secondary "
                          "index")
 # N.B. If you remove the provisioning section this works for
 # LocalSecondaryIndexes aswell.

diff --git a/examples/DynamoDB_Tables_OnDemand.py b/examples/DynamoDB_Tables_OnDemand.py
@@ -20,7 +20,7 @@
 
 template = Template()
 
-template.add_description("Create two dynamodb tables with "
+template.set_description("Create two dynamodb tables with "
                          "conditional on-demand billing. One "
                          "with global secondary index and one without")
 

diff --git a/examples/ELBSample.py b/examples/ELBSample.py
@@ -23,7 +23,7 @@ def main():
     template = Template()
     template.add_version("2010-09-09")
 
-    template.add_description(
+    template.set_description(
         "AWS CloudFormation Sample Template: ELB with 2 EC2 instances")
 
     AddAMI(template)

diff --git a/examples/EMR_Cluster.py b/examples/EMR_Cluster.py
@@ -72,7 +72,7 @@ def generate_rules(rules_name):
 
 
 template = Template()
-template.add_description(
+template.set_description(
     "Sample CloudFormation template for creating an EMR cluster"
 )
 

diff --git a/examples/ElastiCacheRedis.py b/examples/ElastiCacheRedis.py
@@ -41,7 +41,7 @@ def main():
     template = Template()
 
     # Description
-    template.add_description(
+    template.set_description(
         'AWS CloudFormation Sample Template ElastiCache_Redis:'
         'Sample template showing how to create an Amazon'
         'ElastiCache Redis Cluster. **WARNING** This template'

diff --git a/examples/ElasticBeanstalk_Nodejs_Sample.py b/examples/ElasticBeanstalk_Nodejs_Sample.py
@@ -22,7 +22,7 @@
 
 t.add_version()
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template ElasticBeanstalk_Nodejs_Sample: "
     "Configure and launch the AWS Elastic Beanstalk sample application. "
     "**WARNING** This template creates one or more Amazon EC2 instances. You "

diff --git a/examples/ElasticsearchDomain.py b/examples/ElasticsearchDomain.py
@@ -9,7 +9,7 @@
 
 templ = Template()
 
-templ.add_description('Elasticsearch Domain example')
+templ.set_description('Elasticsearch Domain example')
 
 es_domain = templ.add_resource(Domain(
     'ElasticsearchDomain',

diff --git a/examples/Firehose_with_Redshift.py b/examples/Firehose_with_Redshift.py
@@ -12,7 +12,7 @@
 
 t = Template()
 t.add_version('2010-09-09')
-t.add_description('Sample Kinesis Firehose Delivery Stream')
+t.set_description('Sample Kinesis Firehose Delivery Stream')
 
 t.add_resource(DeliveryStream(
     'MyDeliveryStream',

diff --git a/examples/IAM_Policies_SNS_Publish_To_SQS.py b/examples/IAM_Policies_SNS_Publish_To_SQS.py
@@ -8,7 +8,7 @@
 
 t = Template()
 
-t.add_description("AWS CloudFormation Sample Template: This template "
+t.set_description("AWS CloudFormation Sample Template: This template "
                   "demonstrates the creation of a DynamoDB table.")
 
 sqsqueue = t.add_resource(Queue("SQSQueue"))

diff --git a/examples/IAM_Roles_and_InstanceProfiles.py b/examples/IAM_Roles_and_InstanceProfiles.py
@@ -7,7 +7,7 @@
 
 t = Template()
 
-t.add_description("AWS CloudFormation Sample Template: This template "
+t.set_description("AWS CloudFormation Sample Template: This template "
                   "demonstrates the creation of IAM Roles and "
                   "InstanceProfiles.")
 

diff --git a/examples/IAM_Users_Groups_and_Policies.py b/examples/IAM_Users_Groups_and_Policies.py
@@ -8,7 +8,7 @@
 
 t = Template()
 
-t.add_description("AWS CloudFormation Sample Template: This template "
+t.set_description("AWS CloudFormation Sample Template: This template "
                   "demonstrates the creation of IAM User/Group.")
 
 cfnuser = t.add_resource(User(

diff --git a/examples/Metadata.py b/examples/Metadata.py
@@ -3,7 +3,7 @@
 
 t = Template()
 
-t.add_description("Example to show adding a Metadata section to the template")
+t.set_description("Example to show adding a Metadata section to the template")
 t.add_metadata({
     "Comments": "Initial Draft",
     "LastUpdated": "Jan 1st 2015",

diff --git a/examples/NatGateway.py b/examples/NatGateway.py
@@ -6,7 +6,7 @@
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template NatGateway: Sample template showing "
     "how to create a public NAT gateway. "
     "**WARNING** This template creates an Amazon NAT gateway. "

diff --git a/examples/NetworkLB.py b/examples/NetworkLB.py
@@ -23,7 +23,7 @@ def main():
     template = Template()
     template.add_version("2010-09-09")
 
-    template.add_description(
+    template.set_description(
         "AWS CloudFormation Sample Template: NLB with 1 EC2 instance")
 
     AddAMI(template)

diff --git a/examples/RDS_Snapshot_On_Delete.py b/examples/RDS_Snapshot_On_Delete.py
@@ -10,7 +10,7 @@
 
 t.add_version("2010-09-09")
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template RDS_Snapshot_On_Delete: Sample "
     "template showing how to create an RDS DBInstance that is snapshotted on "
     "stack deletion. **WARNING** This template creates an Amazon RDS database "

diff --git a/examples/RDS_VPC.py b/examples/RDS_VPC.py
@@ -8,7 +8,7 @@
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template VPC_RDS_DB_Instance: Sample template "
     "showing how to create an RDS DBInstance in an existing Virtual Private "
     "Cloud (VPC). **WARNING** This template creates an Amazon Relational "

diff --git a/examples/RDS_with_DBParameterGroup.py b/examples/RDS_with_DBParameterGroup.py
@@ -7,7 +7,7 @@
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template RDS_with_DBParameterGroup: Sample "
     "template showing how to create an Amazon RDS Database Instance with "
     "a DBParameterGroup.**WARNING** This template creates an Amazon "

diff --git a/examples/Redshift.py b/examples/Redshift.py
@@ -11,7 +11,7 @@
 
 t.add_version("2010-09-09")
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template: Redshift cluster")
 
 dbname = t.add_parameter(Parameter(

diff --git a/examples/RedshiftClusterInVpc.py b/examples/RedshiftClusterInVpc.py
@@ -13,7 +13,7 @@
 
 t.add_version("2010-09-09")
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template: Redshift cluster in a VPC")
 
 dbname = t.add_parameter(Parameter(

diff --git a/examples/Route53_A.py b/examples/Route53_A.py
@@ -9,7 +9,7 @@
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template Route53_A: "
     "Sample template showing how to create an Amazon Route 53 A record that "
     "maps to the public IP address of an EC2 instance. It assumes that you "

diff --git a/examples/Route53_CNAME.py b/examples/Route53_CNAME.py
@@ -8,7 +8,7 @@
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template Route53_CNAME: Sample template "
     "showing how to create an Amazon Route 53 CNAME record.  It assumes that "
     "you already  have a Hosted Zone registered with Amazon Route 53. "

diff --git a/examples/Route53_RoundRobin.py b/examples/Route53_RoundRobin.py
@@ -8,7 +8,7 @@
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template Route53_RoundRobin: Sample template "
     "showing how to use weighted round robin (WRR) DNS entried via Amazon "
     "Route 53. This contrived sample uses weighted CNAME records to "

diff --git a/examples/S3_Bucket.py b/examples/S3_Bucket.py
@@ -7,7 +7,7 @@
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template S3_Bucket: Sample template showing "
     "how to create a publicly accessible S3 bucket. "
     "**WARNING** This template creates an Amazon S3 Bucket. "

diff --git a/examples/S3_Bucket_With_AccelerateConfiguration.py b/examples/S3_Bucket_With_AccelerateConfiguration.py
@@ -6,7 +6,7 @@
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template S3_Bucket: Sample template showing :"
     "How to create a publicly accessible S3 bucket. "
     "How to enable S3 Transfer Acceleration. "

diff --git a/examples/S3_Bucket_With_Versioning_And_Lifecycle_Rules.py b/examples/S3_Bucket_With_Versioning_And_Lifecycle_Rules.py
@@ -8,7 +8,7 @@
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template S3_Bucket: Sample template showing :"
     "How to create a publicly accessible S3 bucket. "
     "How to enable bucket object versions. "

diff --git a/examples/S3_Website_Bucket_With_Retain_On_Delete.py b/examples/S3_Website_Bucket_With_Retain_On_Delete.py
@@ -7,7 +7,7 @@
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template "
     "S3_Website_Bucket_With_Retain_On_Delete: Sample template showing how to "
     "create a publicly accessible S3 bucket configured for website access "

diff --git a/examples/SQSDLQ.py b/examples/SQSDLQ.py
@@ -7,7 +7,7 @@
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template SQS: Sample template showing how to "
     "create an SQS queue with a dead letter queue. **WARNING** This template "
     "creates Amazon SQS Queues. You will be billed for the AWS resources used "

diff --git a/examples/SQSEncrypt.py b/examples/SQSEncrypt.py
@@ -7,7 +7,7 @@
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template SQS: Sample template showing how to "
     "create an SQS queue with Server Side Encryption. **WARNING** This "
     "template creates Amazon SQS Queues. You will be billed for the AWS "

diff --git a/examples/SQS_With_CloudWatch_Alarms.py b/examples/SQS_With_CloudWatch_Alarms.py
@@ -9,7 +9,7 @@
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "AWS CloudFormation Sample Template SQS_With_CloudWatch_Alarms: Sample "
     "template showing how to create an SQS queue with AWS CloudWatch alarms "
     "on queue depth. **WARNING** This template creates an Amazon SQS Queue "

diff --git a/examples/SSMExample.py b/examples/SSMExample.py
@@ -3,7 +3,7 @@
 import troposphere.ssm as ssm
 
 t = Template()
-t.add_description("2012-09-09")
+t.set_description("2012-09-09")
 
 rhel_patch_group_name = t.add_parameter(Parameter(
     "RHELPatchGroupName",

diff --git a/examples/Serverless_Api_Backend.py b/examples/Serverless_Api_Backend.py
@@ -7,7 +7,7 @@
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "Simple CRUD webservice. State is stored in a SimpleTable (DynamoDB) "
     "resource.")
 

diff --git a/examples/Serverless_Deployment_Preference.py b/examples/Serverless_Deployment_Preference.py
@@ -6,7 +6,7 @@
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "A function that uses the configured traffic shifting type "
     "for a canary deployment.")
 

diff --git a/examples/Serverless_S3_Processor.py b/examples/Serverless_S3_Processor.py
@@ -7,7 +7,7 @@
 
 t = Template()
 
-t.add_description(
+t.set_description(
     "A function is triggered off an upload to a bucket. It logs the content "
     "type of the uploaded object.")
 

diff --git a/examples/VPC_With_VPN_Connection.py b/examples/VPC_With_VPN_Connection.py
@@ -23,7 +23,7 @@
 
 t.add_version("2010-09-09")
 
-t.add_description("""\
+t.set_description("""\
 AWS CloudFormation Sample Template VPC_With_VPN_Connection.template: \
 Sample template showing how to create a private subnet with a VPN connection \
 using static routing to an existing VPN endpoint. NOTE: The VPNConnection \

diff --git a/examples/VPC_single_instance_in_subnet.py b/examples/VPC_single_instance_in_subnet.py
@@ -19,7 +19,7 @@
 
 t.add_version('2010-09-09')
 
-t.add_description("""\
+t.set_description("""\
 AWS CloudFormation Sample Template VPC_Single_Instance_In_Subnet: Sample \
 template showing how to create a VPC and add an EC2 instance with an Elastic \
 IP address and a security group. \