release 3.1

1012
troposphere Documentation Release 4.0.1 cloudtools Apr 15, 2022

Upload: others

Post on 16-May-2022

1 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Release 3.1

troposphere DocumentationRelease 4.0.1

cloudtools

Apr 15, 2022

Page 2: Release 3.1
Page 3: Release 3.1

TABLE OF CONTENTS

1 About 3

2 Installation 5

3 Examples 73.1 Examples of the error checking (full tracebacks removed for clarity): . . . . . . . . . . . . . . . . . 8

4 Currently supported resource types 9

5 Duplicating a single instance sample would look like this 11

6 Community 13

7 Licensing 157.1 Quick Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157.2 examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187.3 troposphere . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237.4 tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7567.5 Changelog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7747.6 Contributing to troposphere . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8427.7 How to Get Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8427.8 Contributing Example Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8427.9 Core troposphere code base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8427.10 Code of Conduct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8477.11 License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 848

8 Indices and tables 851

Python Module Index 853

Index 857

i

Page 4: Release 3.1

ii

Page 6: Release 3.1

troposphere Documentation, Release 4.0.1

2 TABLE OF CONTENTS

Page 7: Release 3.1

CHAPTER

ONE

ABOUT

troposphere - library to create AWS CloudFormation descriptions

The troposphere library allows for easier creation of the AWS CloudFormation JSON by writing Python code to describethe AWS resources. troposphere also includes some basic support for OpenStack resources via Heat.

To facilitate catching CloudFormation or JSON errors early the library has property and type checking built into theclasses.

3

Page 8: Release 3.1

troposphere Documentation, Release 4.0.1

4 Chapter 1. About

Page 9: Release 3.1

CHAPTER

TWO

INSTALLATION

troposphere can be installed using the pip distribution system for Python by issuing:

$ pip install troposphere

To install troposphere with awacs (recommended soft dependency):

$ pip install troposphere[policy]

Alternatively, you can use setup.py to install by cloning this repository and issuing:

$ python setup.py install # you may need sudo depending on your python installation

5

Page 10: Release 3.1

troposphere Documentation, Release 4.0.1

6 Chapter 2. Installation

Page 11: Release 3.1

CHAPTER

THREE

EXAMPLES

A simple example to create an instance would look like this:

>>> from troposphere import Ref, Template>>> import troposphere.ec2 as ec2>>> t = Template()>>> instance = ec2.Instance("myinstance")>>> instance.ImageId = "ami-951945d0">>> instance.InstanceType = "t1.micro">>> t.add_resource(instance)<troposphere.ec2.Instance object at 0x101bf3390>>>> print(t.to_json()){

"Resources": {"myinstance": {

"Properties": {"ImageId": "ami-951945d0","InstanceType": "t1.micro"

},"Type": "AWS::EC2::Instance"

}}

}>>> print(t.to_yaml())Resources:

myinstance:Properties:

ImageId: ami-951945d0InstanceType: t1.micro

Type: AWS::EC2::Instance

Alternatively, parameters can be used instead of properties:

>>> instance = ec2.Instance("myinstance", ImageId="ami-951945d0", InstanceType="t1.micro→˓")>>> t.add_resource(instance)<troposphere.ec2.Instance object at 0x101bf3550>

And add_resource() returns the object to make it easy to use with Ref():

>>> instance = t.add_resource(ec2.Instance("myinstance", ImageId="ami-951945d0",␣→˓InstanceType="t1.micro"))

(continues on next page)

7

Page 12: Release 3.1

troposphere Documentation, Release 4.0.1

(continued from previous page)

>>> Ref(instance)<troposphere.Ref object at 0x101bf3490>

3.1 Examples of the error checking (full tracebacks removed for clar-ity):

Incorrect property being set on AWS resource:

>>> import troposphere.ec2 as ec2>>> ec2.Instance("ec2instance", image="i-XXXX")Traceback (most recent call last):...AttributeError: AWS::EC2::Instance object does not support attribute image

Incorrect type for AWS resource property:

>>> ec2.Instance("ec2instance", ImageId=1)Traceback (most recent call last):...TypeError: ImageId is <type 'int'>, expected <type 'basestring'>

Missing required property for the AWS resource:

>>> from troposphere import Template>>> import troposphere.ec2 as ec2>>> t = Template()>>> t.add_resource(ec2.Subnet("ec2subnet", VpcId="vpcid"))<troposphere.ec2.Subnet object at 0x100830ed0>>>> print(t.to_json())Traceback (most recent call last):...ValueError: Resource CidrBlock required in type AWS::EC2::Subnet (title: ec2subnet)

8 Chapter 3. Examples

Page 13: Release 3.1

CHAPTER

FOUR

CURRENTLY SUPPORTED RESOURCE TYPES

• AWS Resource Types

• OpenStack Resource Types

9

Page 14: Release 3.1

troposphere Documentation, Release 4.0.1

10 Chapter 4. Currently supported resource types

Page 15: Release 3.1

CHAPTER

FIVE

DUPLICATING A SINGLE INSTANCE SAMPLE WOULD LOOK LIKETHIS

# Converted from EC2InstanceSample.template located at:# http://aws.amazon.com/cloudformation/aws-cloudformation-templates/

from troposphere import Base64, FindInMap, GetAttfrom troposphere import Parameter, Output, Ref, Templateimport troposphere.ec2 as ec2

template = Template()

keyname_param = template.add_parameter(Parameter("KeyName",Description="Name of an existing EC2 KeyPair to enable SSH "

"access to the instance",Type="String",

))

template.add_mapping('RegionMap', {"us-east-1": {"AMI": "ami-7f418316"},"us-west-1": {"AMI": "ami-951945d0"},"us-west-2": {"AMI": "ami-16fd7026"},"eu-west-1": {"AMI": "ami-24506250"},"sa-east-1": {"AMI": "ami-3e3be423"},"ap-southeast-1": {"AMI": "ami-74dda626"},"ap-northeast-1": {"AMI": "ami-dcfa4edd"}

})

ec2_instance = template.add_resource(ec2.Instance("Ec2Instance",ImageId=FindInMap("RegionMap", Ref("AWS::Region"), "AMI"),InstanceType="t1.micro",KeyName=Ref(keyname_param),SecurityGroups=["default"],UserData=Base64("80")

))

template.add_output([Output(

(continues on next page)

11

Page 16: Release 3.1

troposphere Documentation, Release 4.0.1

(continued from previous page)

"InstanceId",Description="InstanceId of the newly created EC2 instance",Value=Ref(ec2_instance),

),Output(

"AZ",Description="Availability Zone of the newly created EC2 instance",Value=GetAtt(ec2_instance, "AvailabilityZone"),

),Output(

"PublicIP",Description="Public IP address of the newly created EC2 instance",Value=GetAtt(ec2_instance, "PublicIp"),

),Output(

"PrivateIP",Description="Private IP address of the newly created EC2 instance",Value=GetAtt(ec2_instance, "PrivateIp"),

),Output(

"PublicDNS",Description="Public DNSName of the newly created EC2 instance",Value=GetAtt(ec2_instance, "PublicDnsName"),

),Output(

"PrivateDNS",Description="Private DNSName of the newly created EC2 instance",Value=GetAtt(ec2_instance, "PrivateDnsName"),

),])

print(template.to_json())

12 Chapter 5. Duplicating a single instance sample would look like this

Page 17: Release 3.1

CHAPTER

SIX

COMMUNITY

We have a Google Group, cloudtools-dev, where you can ask questions and engage with the troposphere community.Issues and pull requests are always welcome!

13

Page 18: Release 3.1

troposphere Documentation, Release 4.0.1

14 Chapter 6. Community

Page 19: Release 3.1

CHAPTER

SEVEN

LICENSING

troposphere is licensed under the BSD 2-Clause license. See LICENSE for the troposphere full license text.

7.1 Quick Start

Troposphere closely follows CloudFormation, so there isn’t much documentation specific to Troposphere. In this doc-umentation there are various examples but for the most part the CloudFormation docs should be used.

7.1.1 CloudFormation Basics

• Template Anatomy - structure of a CloudFormation template.

• Resources are the basic blocks and required in any template.

• Outputs are optional but can be used to create cross-stack references. Having everything in one stack will makeit very hard to manage the infrastructure. Instead, values from one stack (for example, network setup) can beexported in this section and imported by another stack (for example, EC2 setup). This way a stack used to set upa certain application can be managed or deleted without affecting other applications that might be present on thesame network.

• Intrinsic Functions should be used to manipulate values that are only available at runtime. For example, assumea template that creates a subnet and attaches a routing table and network ACL to that subnet. The subnet doesn’texist when the template is created, so it’s ID can’t be known. Instead, the route and network ACL resources aregoing to get the ID at runtime, by using the Ref function against the subnet.

7.1.2 Basic Usage

The following two pieces of code are intended to demonstrate basic usage of Troposphere and CloudFormation tem-plates. First template will create two subnets and export their IDs. The second one will create an EC2 instance in one ofthe subnets. The comments explain how it works and where to find documentation regarding the use of CloudFormationand Troposphere.

#!/usr/bin/env python3## learncf_subnet.py## Generate a CloudFormation template that will create two subnets. This# template exports the subnet IDs to be used by a second template which# will create an EC2 instance in one of those subnets.

(continues on next page)

15

Page 20: Release 3.1

troposphere Documentation, Release 4.0.1

(continued from previous page)

#from __future__ import print_function

from troposphere import ec2from troposphere import Tags, GetAtt, Ref, Sub, Exportfrom troposphere import Template, Output

# Create the object that will generate our templatet = Template()

# Define resources that CloudFormation will generate for us# https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-→˓structure.html

# Define the first subnet. We know that 'Subnet()' is in the ec2 module# because in CloudFormation the Subnet resource is defined under EC2:# https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.→˓htmlnet_learncf_1a = ec2.Subnet("netLearnCf1a")

# Information about the possible properties of Subnet() can be found# in CloudFormation docs:# https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.→˓html#aws-resource-ec2-subnet-propertiesnet_learncf_1a.AvailabilityZone = "eu-west-1a"net_learncf_1a.CidrBlock = "172.30.126.80/28" # ADJUST THIS VALUEnet_learncf_1a.VpcId = "vpc-abcdefgh" # ADJUST THIS VALUE# Tags can be declared in two ways. One way is# (1) in AWS/boto format, as a list of dictionaries where each item in the# list has (at least) two elements. The "Key" key will be the tag key and# the "Value" key will be the tag's Value. Confusing, but it allows for# additional settings to be specified for each tag. For example, if a tag# attached to an autoscaling group should be inherited by the EC2 instances# the group launches or not.net_learncf_1a.Tags = [

{"Key": "Name", "Value": "learncf-1a"},{"Key": "Comment", "Value": "CloudFormation+Troposphere test"}]

# The subnet resource defined above must be added to the templatet.add_resource(net_learncf_1a)

# The same thing can be achieved by setting parameters to Subnet() function# instead of properties of the object created by Subnet(). Shown below.## For the second subnet we use the other method of defining tags,# (2) by using the Tags helper function, which is defined in Troposphere# and doesn't have an equivalent in CloudFormation.## Also, we use GetAtt to read the value of an attribute from a previously# created resource, i.e. VPC ID from the first subnet. For demo purposes.## The attributes returned by each resource can be found in the CloudFormation

(continues on next page)

16 Chapter 7. Licensing

Page 21: Release 3.1

troposphere Documentation, Release 4.0.1

(continued from previous page)

# documentation, in the Returns section for that resource:# https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.→˓html#aws-resource-ec2-subnet-getatt## GetAtt documentation:# https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-→˓reference-getatt.htmlnet_learncf_1b = ec2.Subnet(

"netLearnCf1b",AvailabilityZone="eu-west-1b",CidrBlock="172.30.126.96/28", # ADJUST THIS VALUEVpcId=GetAtt(net_learncf_1a, "VpcId"),Tags=Tags(

Name="learncf-1b",Comment="CloudFormation+Troposphere test"))

t.add_resource(net_learncf_1b)

# Outputs section will export the subnet IDs to be used by other stacks# https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-→˓structure.htmlout_net_learncf_1a = Output("outNetLearnCf1a")

# Ref is another CloudFormation intrinsic function:# https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-→˓reference-ref.html# If pointed to a subnet, Ref will return the subnet ID:# https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.→˓html#aws-resource-ec2-subnet-refout_net_learncf_1a.Value = Ref(net_learncf_1a)# Append the subnet title (Logical ID) to the stack name and set that as the# exported property. Importing it in another stack will return the Value# we set above to that stack.## Sub stands for 'substitute', another CloudFormation intrinsic function.out_net_learncf_1a.Export = Export(Sub(

"${AWS::StackName}-" + net_learncf_1a.title))

# Similar output for the second subnetout_net_learncf_1b = Output("outNetLearnCf1b")out_net_learncf_1b.Value = Ref(net_learncf_1b)out_net_learncf_1b.Export = Export(Sub(

"${AWS::StackName}-" + net_learncf_1b.title))

# Add outputs to templatet.add_output(out_net_learncf_1a)t.add_output(out_net_learncf_1b)

# Finally, write the template to a filewith open('learncf-subnet.yaml', 'w') as f:

f.write(t.to_yaml())

And the EC2 instance template:

7.1. Quick Start 17

Page 22: Release 3.1

troposphere Documentation, Release 4.0.1

#!/usr/bin/env python3## learncf_ec2.py## Generate a CloudFormation template that creates an EC2 instance in a# subnet which was created previously by another template (learncf-subnet)#from __future__ import print_function

from troposphere import ec2from troposphere import Tags, ImportValuefrom troposphere import Template

# create the object that will generate our templatet = Template()

ec2_learncf_1a = ec2.Instance("ec2LearnCf1a")ec2_learncf_1a.ImageId = "ami-e487179d" # ADJUST IF NEEDEDec2_learncf_1a.InstanceType = "t2.micro"# We set the subnet to start this instance in by importing the subnet ID# from the other CloudFormation stack, which previously created it.# An example of cross-stack reference used to split stacks into# manageable pieces. Each export must have a unique name in its account# and region, so the template name was prepended to the resource name.ec2_learncf_1a.SubnetId = ImportValue("learncf-subnet-netLearnCf1a")ec2_learncf_1a.Tags = Tags(

Name="learncf",Comment="Learning CloudFormation and Troposphere")

t.add_resource(ec2_learncf_1a)

# Finally, write the template to a filewith open('learncf-ec2.yaml', 'w') as f:

f.write(t.to_yaml())

After the .yaml files are generated using the code above stacks can be created from the command line like this:

aws cloudformation create-stack --stack-name learncf-subnet --template-body file://→˓learncf-subnet.yamlaws cloudformation create-stack --stack-name learncf-ec2 --template-body file://→˓learncf-ec2.yaml

7.2 examples

7.2.1 examples package

Submodules

examples.ApiGateway module

18 Chapter 7. Licensing

Page 23: Release 3.1

troposphere Documentation, Release 4.0.1

examples.ApplicationAutoScalingSample module

examples.ApplicationELB module

examples.ApplicationELB.AddAMI(template)

examples.ApplicationELB.main()

examples.ApplicationLB_FixedActions module

examples.ApplicationLB_FixedActions.main()

examples.AuroraServerlessRDS_SecretsManager module

examples.Autoscaling module

examples.AutoscalingHTTPRequests module

examples.Backup module

examples.Batch module

Batch.

Create the AWS Batch Compute environment and roles.

examples.CertificateManagerSample module

examples.ClassExtensions module

class examples.ClassExtensions.FrontendInstance(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: examples.ClassExtensions.TrustyInstance

InstanceType = 't1.micro'

SecurityGroups = ['frontend']

class examples.ClassExtensions.ProcessingInstance(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: examples.ClassExtensions.TrustyInstance

InstanceType = 'm3.large'

SecurityGroups = ['processing']

class examples.ClassExtensions.TrustyInstance(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.ec2.Instance

ImageId = 'ami-xxxx'

Monitoring = True

7.2. examples 19

Page 24: Release 3.1

troposphere Documentation, Release 4.0.1

examples.CloudFormation_Init_ConfigSet module

examples.CloudFront_Distribution_S3 module

examples.CloudFront_StreamingDistribution_S3 module

examples.CloudTrail module

examples.CloudWatchEventsSample module

examples.CodeBuild module

examples.CodeDeploy module

examples.CodePipeline module

examples.CustomResource module

class examples.CustomResource.CustomPlacementGroup(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.validators.cloudformation.AWSCustomObject

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'PlacementGroupName': (<class 'str'>, True), 'ServiceToken':(<class 'str'>, True)}

resource: Dict[str, Any]

resource_type: Optional[str] = 'Custom::PlacementGroup'

template: Optional[Template]

title: Optional[str]

examples.Dlm module

examples.DynamoDB_Table module

examples.DynamoDB_Table_With_GSI_And_NonKeyAttributes_Projection module

examples.DynamoDB_Table_With_GlobalSecondaryIndex module

examples.DynamoDB_Table_With_KinesisStreamSpecification module

examples.DynamoDB_Tables_OnDemand module

examples.EC2Conditions module

20 Chapter 7. Licensing

Page 25: Release 3.1

troposphere Documentation, Release 4.0.1

examples.EC2InstanceSample module

examples.EC2_Remove_Ephemeral_Drive module

examples.ECRSample module

examples.ECSCluster module

examples.ECSFargate module

examples.EFS module

examples.ELBSample module

examples.ELBSample.AddAMI(template)

examples.ELBSample.main()

examples.EMR_Cluster module

examples.EMR_Cluster.generate_rules(rules_name)

examples.ElastiCacheRedis module

Converted from ElastiCache_Redis.template located at: http://aws.amazon.com/cloudformation/aws-cloudformation-templates/

In addition to troposphere, this script requires awacs (Amazon Web Access Control Subsystem)

examples.ElastiCacheRedis.main()Create a ElastiCache Redis Node and EC2 Instance

examples.ElasticBeanstalk_Nodejs_Sample module

examples.ElasticsearchDomain module

examples.Firehose_with_Redshift module

examples.IAM_Policies_SNS_Publish_To_SQS module

examples.IAM_Roles_and_InstanceProfiles module

examples.IAM_Users_Groups_and_Policies module

examples.IAM_Users_snippet module

examples.IoTAnalytics module

examples.IoTSample module

examples.Kinesis_Stream module

7.2. examples 21

Page 26: Release 3.1

troposphere Documentation, Release 4.0.1

examples.Lambda module

examples.Mediapackage module

examples.Metadata module

examples.MskCluster module

examples.NatGateway module

examples.NetworkLB module

examples.NetworkLB.AddAMI(template)

examples.NetworkLB.main()

examples.OpenStack_AutoScaling module

examples.OpenStack_Server module

examples.OpsWorksSnippet module

examples.RDS_Snapshot_On_Delete module

examples.RDS_VPC module

examples.RDS_with_DBParameterGroup module

examples.Redshift module

examples.RedshiftClusterInVpc module

examples.Route53_A module

examples.Route53_CNAME module

examples.Route53_RoundRobin module

examples.S3_Bucket module

examples.S3_Bucket_With_AccelerateConfiguration module

examples.S3_Bucket_With_Versioning_And_Lifecycle_Rules module

examples.S3_Website_Bucket_With_Retain_On_Delete module

examples.SQSDLQ module

examples.SQSEncrypt module

examples.SQS_With_CloudWatch_Alarms module

22 Chapter 7. Licensing

Page 27: Release 3.1

troposphere Documentation, Release 4.0.1

examples.SSMExample module

examples.Secretsmanager module

examples.Secretsmanager_Rds module

examples.Serverless_Api_Backend module

examples.Serverless_Deployment_Preference module

examples.Serverless_S3_Processor module

examples.VPC_EC2_Instance_With_Multiple_Dynamic_IPAddresses module

examples.VPC_With_VPN_Connection module

examples.VPC_single_instance_in_subnet module

examples.VpnEndpoint module

examples.WAF_Common_Attacks_Sample module

examples.WAF_Regional_Common_Attacks_Sample module

examples.WaitObject module

Module contents

7.3 troposphere

7.3.1 troposphere package

Subpackages

troposphere.helpers package

Submodules

troposphere.helpers.userdata module

troposphere.helpers.userdata.from_file(filepath, delimiter='', blanklines=False)Imports userdata from a file.

:param filepath The absolute path to the file.

Param delimiter Delimiter to use with the troposphere.Join().

:param blanklines If blank lines should be ignored

rtype: troposphere.Base64 :return The base64 representation of the file.

7.3. troposphere 23

Page 28: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.helpers.userdata.from_file_sub(filepath)Imports userdata from a file, using Sub for replacing inline variables such as ${AWS::Region}

:param filepath The absolute path to the file.

rtype: troposphere.Base64 :return The base64 representation of the file.

Module contents

troposphere.openstack package

Submodules

troposphere.openstack.heat module

Openstack Heat

Due to the strange nature of the OpenStack compatability layer, some values that should be integers fail to validate andneed to be represented as strings. For this reason, we duplicate the AWS::AutoScaling::AutoScalingGroup and changethese types.

class troposphere.openstack.heat.AWSAutoScalingGroup(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Fix issues with OpenStack compatability layer.

Due to the strange nature of the OpenStack compatability layer, some values that should be integers fail to validateand need to be represented as strings. For this reason, we duplicate the AWS::AutoScaling::AutoScalingGroupand change these types.

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'AvailabilityZones': (<class 'list'>, True), 'Cooldown':(<function integer>, False), 'DesiredCapacity': (<class 'str'>, False),'HealthCheckGracePeriod': (<function integer>, False), 'HealthCheckType': (<class'str'>, False), 'LaunchConfigurationName': (<class 'str'>, True),'LoadBalancerNames': (<class 'list'>, False), 'MaxSize': (<class 'str'>, True),'MinSize': (<class 'str'>, True), 'Tags': (<class 'list'>, False),'VPCZoneIdentifier': (<class 'list'>, False)}

resource: Dict[str, Any]

resource_type: Optional[str] = 'AWS::AutoScaling::AutoScalingGroup'

template: Optional[Template]

title: Optional[str]

24 Chapter 7. Licensing

Page 29: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.openstack.neutron module

class troposphere.openstack.neutron.AddressPair(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'ip_address': (<class 'str'>, True), 'mac_address': (<class'str'>, False)}

resource: Dict[str, Any]

resource_type: Optional[str]

template: Optional[Template]

title: Optional[str]

class troposphere.openstack.neutron.Firewall(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'admin_state_up': (<function boolean>, False), 'description':(<class 'str'>, False), 'firewall_policy_id': (<class 'str'>, True), 'name':(<class 'str'>, False)}

resource: Dict[str, Any]

resource_type: Optional[str] = 'OS::Neutron::Firewall'

template: Optional[Template]

title: Optional[str]

class troposphere.openstack.neutron.FirewallPolicy(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

7.3. troposphere 25

Page 30: Release 3.1

troposphere Documentation, Release 4.0.1

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'audited': (<function boolean>, False), 'description': (<class'str'>, False), 'firewall_rules': (<class 'list'>, True), 'name': (<class 'str'>,False), 'shared': (<function boolean>, False)}

resource: Dict[str, Any]

resource_type: Optional[str] = 'OS::Neutron::FirewallPolicy'

template: Optional[Template]

title: Optional[str]

class troposphere.openstack.neutron.FirewallRule(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'action': (<class 'str'>, False), 'description': (<class 'str'>,False), 'destination_ip_address': (<class 'str'>, False), 'destination_port':(<function network_port>, False), 'enabled': (<function boolean>, False),'ip_version': (<class 'str'>, False), 'name': (<class 'str'>, False), 'protocol':(<class 'str'>, False), 'shared': (<function boolean>, False), 'source_ip_address':(<class 'str'>, False), 'source_port': (<function network_port>, False)}

resource: Dict[str, Any]

resource_type: Optional[str] = 'OS::Neutron::FirewallRule'

template: Optional[Template]

title: Optional[str]

validate()

class troposphere.openstack.neutron.FixedIP(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'ip_address': (<class 'str'>, False), 'subnet_id': (<class'str'>, False)}

resource: Dict[str, Any]

resource_type: Optional[str]

template: Optional[Template]

title: Optional[str]

26 Chapter 7. Licensing

Page 31: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.openstack.neutron.FloatingIP(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'fixed_ip_address': (<class 'str'>, False),'floating_network_id': (<class 'str'>, True), 'port_id': (<class 'str'>, False),'value_specs': (<class 'dict'>, False)}

resource: Dict[str, Any]

resource_type: Optional[str] = 'OS::Neutron::FloatingIP'

template: Optional[Template]

title: Optional[str]

class troposphere.openstack.neutron.FloatingIPAssociation(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'fixed_ip_address': (<class 'str'>, False), 'floatingip_id':(<class 'str'>, True), 'port_id': (<class 'str'>, False)}

resource: Dict[str, Any]

resource_type: Optional[str] = 'OS::Neutron::FloatingIPAssociation'

template: Optional[Template]

title: Optional[str]

class troposphere.openstack.neutron.HealthMonitor(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

7.3. troposphere 27

Page 32: Release 3.1

troposphere Documentation, Release 4.0.1

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'admin_state_up': (<function boolean>, False), 'delay':(<function positive_integer>, True), 'expected_codes': (<class 'str'>, False),'http_method': (<class 'str'>, False), 'max_retries': (<function integer>, True),'timeout': (<function integer>, True), 'type': (<class 'str'>, True), 'url_path':(<class 'str'>, False)}

resource: Dict[str, Any]

resource_type: Optional[str] = 'OS::Neutron::HealthMonitor'

template: Optional[Template]

title: Optional[str]

validate()

class troposphere.openstack.neutron.LoadBalancer(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'members': (<class 'list'>, False), 'pool_id': (<class'troposphere.openstack.neutron.Pool'>, True), 'protocol_port': (<functionnetwork_port>, True)}

resource: Dict[str, Any]

resource_type: Optional[str] = 'OS::Neutron::LoadBalancer'

template: Optional[Template]

title: Optional[str]

class troposphere.openstack.neutron.Net(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'admin_state_up': (<function boolean>, False), 'name': (<class'str'>, False), 'shared': (<function boolean>, False), 'tenant_id': (<class'str'>, False), 'value_specs': (<class 'dict'>, False)}

resource: Dict[str, Any]

resource_type: Optional[str] = 'OS::Neutron::Net'

template: Optional[Template]

28 Chapter 7. Licensing

Page 33: Release 3.1

troposphere Documentation, Release 4.0.1

title: Optional[str]

class troposphere.openstack.neutron.Pool(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'admin_state_up': (<function boolean>, False), 'description':(<class 'str'>, False), 'lb_method': (<class 'str'>, True), 'monitors': (<class'list'>, False), 'name': (<class 'str'>, False), 'protocol': (<class 'str'>,True), 'subnet_id': (<class 'str'>, True), 'vip': (<class'troposphere.openstack.neutron.VIP'>, False)}

resource: Dict[str, Any]

resource_type: Optional[str] = 'OS::Neutron::Pool'

template: Optional[Template]

title: Optional[str]

validate()

class troposphere.openstack.neutron.PoolMember(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'address': (<class 'str'>, True), 'admin_state_up': (<functionboolean>, False), 'pool_id': (<class 'troposphere.openstack.neutron.Pool'>, True),'protocol_port': (<function network_port>, True), 'weight': (<functioninteger_range.<locals>.integer_range_checker>, False)}

resource: Dict[str, Any]

resource_type: Optional[str] = 'OS::Neutron::PoolMember'

template: Optional[Template]

title: Optional[str]

class troposphere.openstack.neutron.Port(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

attributes: List[str]

do_validation: bool

7.3. troposphere 29

Page 34: Release 3.1

troposphere Documentation, Release 4.0.1

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'admin_state_up': (<function boolean>, False),'allowed_address_pairs': (<class 'list'>, False), 'device_id': (<class 'str'>,False), 'fixed_ips': (<class 'list'>, False), 'mac_address': (<class 'str'>,False), 'name': (<class 'str'>, False), 'network_id': (<class 'str'>, True),'security_groups': (<class 'list'>, False), 'value_specs': (<class 'dict'>,False)}

resource: Dict[str, Any]

resource_type: Optional[str] = 'OS::Neutron::Port'

template: Optional[Template]

title: Optional[str]

class troposphere.openstack.neutron.SecurityGroup(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'description': (<class 'str'>, True), 'name': (<class 'str'>,False), 'rules': (<class 'list'>, False)}

resource: Dict[str, Any]

resource_type: Optional[str] = 'OS::Neutron::SecurityGroup'

template: Optional[Template]

title: Optional[str]

class troposphere.openstack.neutron.SecurityGroupRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'direction': (<class 'str'>, False), 'ethertype': (<class'str'>, False), 'port_range_max': (<function network_port>, False),'port_range_min': (<function network_port>, False), 'protocol': (<class 'str'>,False), 'remote_group_id': (<class 'str'>, False), 'remote_ip_prefix': (<class'str'>, False), 'remote_mode': (<class 'str'>, False)}

resource: Dict[str, Any]

resource_type: Optional[str]

30 Chapter 7. Licensing

Page 35: Release 3.1

troposphere Documentation, Release 4.0.1

template: Optional[Template]

title: Optional[str]

validate()

class troposphere.openstack.neutron.SessionPersistence(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'cookie_name': (<class 'str'>, False), 'type': (<class 'str'>,False)}

resource: Dict[str, Any]

resource_type: Optional[str]

template: Optional[Template]

title: Optional[str]

validate()

class troposphere.openstack.neutron.VIP(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'address': (<class 'str'>, False), 'admin_state_up': (<functionboolean>, False), 'connection_limit': (<function integer>, True), 'description':(<class 'str'>, False), 'name': (<class 'str'>, False), 'protocol_port':(<function network_port>, True), 'session_persistence': (<class'troposphere.openstack.neutron.SessionPersistence'>, False)}

resource: Dict[str, Any]

resource_type: Optional[str]

template: Optional[Template]

title: Optional[str]

7.3. troposphere 31

Page 36: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.openstack.nova module

class troposphere.openstack.nova.BlockDeviceMapping(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'delete_on_termination': (<function boolean>, False),'device_name': (<class 'str'>, True), 'snapshot_id': (<class 'str'>, False),'volume_id': (<class 'str'>, False), 'volume_size': (<function integer>, False)}

resource: Dict[str, Any]

resource_type: Optional[str]

template: Optional[Template]

title: Optional[str]

class troposphere.openstack.nova.BlockDeviceMappingV2(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'boot_index': (<function integer>, False),'delete_on_termination': (<function boolean>, False), 'device_name': (<class'str'>, False), 'device_type': (<class 'str'>, False), 'disk_bus': (<class 'str'>,False), 'ephemeral_format': (<class 'str'>, False), 'ephemeral_size': (<functioninteger>, False), 'image_id': (<class 'str'>, False), 'snapshot_id': (<class'str'>, False), 'swap_size': (<function integer>, False), 'volume_id': (<class'str'>, False), 'volume_size': (<function integer>, False)}

resource: Dict[str, Any]

resource_type: Optional[str]

template: Optional[Template]

title: Optional[str]

validate()

class troposphere.openstack.nova.FloatingIP(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

attributes: List[str]

do_validation: bool

32 Chapter 7. Licensing

Page 37: Release 3.1

troposphere Documentation, Release 4.0.1

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'pool': (<class 'str'>, False)}

resource: Dict[str, Any]

resource_type: Optional[str] = 'OS::Nova::FloatingIP'

template: Optional[Template]

title: Optional[str]

class troposphere.openstack.nova.FloatingIPAssociation(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'floating_ip': (<class 'str'>, True), 'server_ip': (<class'str'>, True)}

resource: Dict[str, Any]

resource_type: Optional[str] = 'OS::Nova::FloatingIPAssociation'

template: Optional[Template]

title: Optional[str]

class troposphere.openstack.nova.KeyPair(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'name': (<class 'str'>, True), 'public_key': (<class 'str'>,False), 'save_private_key': (<function boolean>, False)}

resource: Dict[str, Any]

resource_type: Optional[str] = 'OS::Nova::KeyPair'

template: Optional[Template]

title: Optional[str]

class troposphere.openstack.nova.Network(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

attributes: List[str]

7.3. troposphere 33

Page 38: Release 3.1

troposphere Documentation, Release 4.0.1

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'fixed_ip': (<class 'str'>, False), 'network': (<class 'str'>,False), 'port': (<function network_port>, False)}

resource: Dict[str, Any]

resource_type: Optional[str]

template: Optional[Template]

title: Optional[str]

class troposphere.openstack.nova.Server(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

attributes: List[str]

do_validation: bool

properties: Dict[str, Any]

propnames: Set[str]

props: ClassVar[Dict[str, Tuple[Union[Tuple[type, ...], type, Callable[[Any],Any]], bool]]] = {'admin_pass': (<class 'str'>, False), 'admin_user': (<class'str'>, False), 'availability_zone': (<class 'str'>, False),'block_device_mapping': (<class 'list'>, False), 'block_device_mapping_v2':(<class 'list'>, False), 'config_drive': (<class 'str'>, False), 'diskConfig':(<class 'str'>, False), 'flavor': (<class 'str'>, False), 'flavor_update_policy':(<class 'str'>, False), 'image': (<class 'str'>, True), 'image_update_policy':(<class 'str'>, False), 'key_name': (<class 'str'>, False), 'metadata': (<class'dict'>, False), 'name': (<class 'str'>, False), 'networks': (<class 'list'>,True), 'personality': (<class 'dict'>, False), 'reservation_id': (<class 'str'>,False), 'scheduler_hints': (<class 'dict'>, False), 'security_groups': (<class'list'>, False), 'software_config_transport': (<class 'str'>, False), 'user_data':(<class 'str'>, False), 'user_data_format': (<class 'str'>, False)}

resource: Dict[str, Any]

resource_type: Optional[str] = 'OS::Nova::Server'

template: Optional[Template]

title: Optional[str]

validate()

34 Chapter 7. Licensing

Page 39: Release 3.1

troposphere Documentation, Release 4.0.1

Module contents

OpenStack

The package to support OpenStack templates using troposphere.

Submodules

troposphere.accessanalyzer module

class troposphere.accessanalyzer.Analyzer(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

Analyzer

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AnalyzerName': (<class 'str'>, False), 'ArchiveRules': ([<class'troposphere.accessanalyzer.ArchiveRule'>], False), 'Tags': (<class'troposphere.Tags'>, False), 'Type': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::AccessAnalyzer::Analyzer'

class troposphere.accessanalyzer.ArchiveRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ArchiveRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Filter': ([<class 'troposphere.accessanalyzer.Filter'>], True), 'RuleName':(<class 'str'>, True)}

class troposphere.accessanalyzer.Filter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Filter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Contains': ([<class 'str'>], False), 'Eq': ([<class 'str'>], False), 'Exists':(<function boolean>, False), 'Neq': ([<class 'str'>], False), 'Property': (<class'str'>, True)}

troposphere.acmpca module

class troposphere.acmpca.AccessDescription(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AccessDescription

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessLocation': (<class 'troposphere.acmpca.GeneralName'>, True),'AccessMethod': (<class 'troposphere.acmpca.AccessMethod'>, True)}

7.3. troposphere 35

Page 40: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.acmpca.AccessMethod(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AccessMethod

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessMethodType': (<class 'str'>, False), 'CustomObjectIdentifier': (<class'str'>, False)}

class troposphere.acmpca.ApiPassthrough(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ApiPassthrough

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Extensions': (<class 'troposphere.acmpca.Extensions'>, False), 'Subject':(<class 'troposphere.acmpca.Subject'>, False)}

class troposphere.acmpca.Certificate(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Certificate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiPassthrough': (<class 'troposphere.acmpca.ApiPassthrough'>, False),'CertificateAuthorityArn': (<class 'str'>, True), 'CertificateSigningRequest':(<class 'str'>, True), 'SigningAlgorithm': (<function validate_signing_algorithm>,True), 'TemplateArn': (<class 'str'>, False), 'Validity': (<class'troposphere.acmpca.Validity'>, True), 'ValidityNotBefore': (<class'troposphere.acmpca.Validity'>, False)}

resource_type: Optional[str] = 'AWS::ACMPCA::Certificate'

class troposphere.acmpca.CertificateAuthority(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

CertificateAuthority

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CsrExtensions': (<class 'troposphere.acmpca.CsrExtensions'>, False),'KeyAlgorithm': (<function validate_key_algorithm>, True),'KeyStorageSecurityStandard': (<class 'str'>, False), 'RevocationConfiguration':(<class 'troposphere.acmpca.RevocationConfiguration'>, False), 'SigningAlgorithm':(<function validate_signing_algorithm>, True), 'Subject': (<class'troposphere.acmpca.Subject'>, True), 'Tags': (<class 'troposphere.Tags'>, False),'Type': (<function validate_certificateauthority_type>, True)}

resource_type: Optional[str] = 'AWS::ACMPCA::CertificateAuthority'

class troposphere.acmpca.CertificateAuthorityActivation(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

36 Chapter 7. Licensing

Page 41: Release 3.1

troposphere Documentation, Release 4.0.1

CertificateAuthorityActivation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Certificate': (<class 'str'>, True), 'CertificateAuthorityArn': (<class 'str'>,True), 'CertificateChain': (<class 'str'>, False), 'Status': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::ACMPCA::CertificateAuthorityActivation'

class troposphere.acmpca.CrlConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CrlConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CustomCname': (<class 'str'>, False), 'Enabled': (<function boolean>, False),'ExpirationInDays': (<function integer>, False), 'S3BucketName': (<class 'str'>,False), 'S3ObjectAcl': (<class 'str'>, False)}

class troposphere.acmpca.CsrExtensions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CsrExtensions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KeyUsage': (<class 'troposphere.acmpca.KeyUsage'>, False),'SubjectInformationAccess': ([<class 'troposphere.acmpca.AccessDescription'>],False)}

class troposphere.acmpca.CustomAttribute(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CustomAttribute

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ObjectIdentifier': (<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.acmpca.CustomExtension(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CustomExtension

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Critical': (<function boolean>, False), 'ObjectIdentifier': (<class 'str'>,True), 'Value': (<class 'str'>, True)}

class troposphere.acmpca.EdiPartyName(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EdiPartyName

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'NameAssigner': (<class 'str'>, True), 'PartyName': (<class 'str'>, True)}

class troposphere.acmpca.ExtendedKeyUsage(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 37

Page 42: Release 3.1

troposphere Documentation, Release 4.0.1

ExtendedKeyUsage

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ExtendedKeyUsageObjectIdentifier': (<class 'str'>, False),'ExtendedKeyUsageType': (<class 'str'>, False)}

class troposphere.acmpca.Extensions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Extensions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificatePolicies': ([<class 'troposphere.acmpca.PolicyInformation'>], False),'CustomExtensions': ([<class 'troposphere.acmpca.CustomExtension'>], False),'ExtendedKeyUsage': ([<class 'troposphere.acmpca.ExtendedKeyUsage'>], False),'KeyUsage': (<class 'troposphere.acmpca.KeyUsage'>, False),'SubjectAlternativeNames': ([<class 'troposphere.acmpca.GeneralName'>], False)}

class troposphere.acmpca.GeneralName(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GeneralName

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DirectoryName': (<class 'troposphere.acmpca.Subject'>, False), 'DnsName':(<class 'str'>, False), 'EdiPartyName': (<class 'troposphere.acmpca.EdiPartyName'>,False), 'IpAddress': (<class 'str'>, False), 'OtherName': (<class'troposphere.acmpca.OtherName'>, False), 'RegisteredId': (<class 'str'>, False),'Rfc822Name': (<class 'str'>, False), 'UniformResourceIdentifier': (<class 'str'>,False)}

class troposphere.acmpca.KeyUsage(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KeyUsage

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CRLSign': (<function boolean>, False), 'DataEncipherment': (<function boolean>,False), 'DecipherOnly': (<function boolean>, False), 'DigitalSignature':(<function boolean>, False), 'EncipherOnly': (<function boolean>, False),'KeyAgreement': (<function boolean>, False), 'KeyCertSign': (<function boolean>,False), 'KeyEncipherment': (<function boolean>, False), 'NonRepudiation':(<function boolean>, False)}

class troposphere.acmpca.OcspConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OcspConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False), 'OcspCustomCname': (<class 'str'>,False)}

class troposphere.acmpca.OtherName(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

38 Chapter 7. Licensing

Page 43: Release 3.1

troposphere Documentation, Release 4.0.1

OtherName

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TypeId': (<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.acmpca.Permission(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Permission

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Actions': ([<class 'str'>], True), 'CertificateAuthorityArn': (<class 'str'>,True), 'Principal': (<class 'str'>, True), 'SourceAccount': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::ACMPCA::Permission'

class troposphere.acmpca.PolicyInformation(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PolicyInformation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertPolicyId': (<class 'str'>, True), 'PolicyQualifiers': ([<class'troposphere.acmpca.PolicyQualifierInfo'>], False)}

class troposphere.acmpca.PolicyQualifierInfo(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PolicyQualifierInfo

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PolicyQualifierId': (<class 'str'>, True), 'Qualifier': (<class'troposphere.acmpca.Qualifier'>, True)}

class troposphere.acmpca.Qualifier(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Qualifier

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CpsUri': (<class 'str'>, True)}

class troposphere.acmpca.RevocationConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RevocationConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CrlConfiguration': (<class 'troposphere.acmpca.CrlConfiguration'>, False),'OcspConfiguration': (<class 'troposphere.acmpca.OcspConfiguration'>, False)}

class troposphere.acmpca.Subject(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Subject

7.3. troposphere 39

Page 44: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CommonName': (<class 'str'>, False), 'Country': (<class 'str'>, False),'CustomAttributes': ([<class 'troposphere.acmpca.CustomAttribute'>], False),'DistinguishedNameQualifier': (<class 'str'>, False), 'GenerationQualifier':(<class 'str'>, False), 'GivenName': (<class 'str'>, False), 'Initials': (<class'str'>, False), 'Locality': (<class 'str'>, False), 'Organization': (<class'str'>, False), 'OrganizationalUnit': (<class 'str'>, False), 'Pseudonym': (<class'str'>, False), 'SerialNumber': (<class 'str'>, False), 'State': (<class 'str'>,False), 'Surname': (<class 'str'>, False), 'Title': (<class 'str'>, False)}

class troposphere.acmpca.Validity(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Validity

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Type': (<function validate_validity_type>, True), 'Value': (<function double>,True)}

troposphere.amazonmq module

class troposphere.amazonmq.Broker(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Broker

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthenticationStrategy': (<class 'str'>, False), 'AutoMinorVersionUpgrade':(<function boolean>, True), 'BrokerName': (<class 'str'>, True), 'Configuration':(<class 'troposphere.amazonmq.ConfigurationId'>, False), 'DeploymentMode': (<class'str'>, True), 'EncryptionOptions': (<class'troposphere.amazonmq.EncryptionOptions'>, False), 'EngineType': (<class 'str'>,True), 'EngineVersion': (<class 'str'>, True), 'HostInstanceType': (<class 'str'>,True), 'LdapServerMetadata': (<class 'troposphere.amazonmq.LdapServerMetadata'>,False), 'Logs': (<class 'troposphere.amazonmq.LogsConfiguration'>, False),'MaintenanceWindowStartTime': (<class 'troposphere.amazonmq.MaintenanceWindow'>,False), 'PubliclyAccessible': (<function boolean>, True), 'SecurityGroups':([<class 'str'>], False), 'StorageType': (<class 'str'>, False), 'SubnetIds':([<class 'str'>], False), 'Tags': (<function validate_tags_or_list>, False),'Users': ([<class 'troposphere.amazonmq.User'>], True)}

resource_type: Optional[str] = 'AWS::AmazonMQ::Broker'

class troposphere.amazonmq.Configuration(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Configuration

40 Chapter 7. Licensing

Page 45: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthenticationStrategy': (<class 'str'>, False), 'Data': (<class 'str'>, True),'Description': (<class 'str'>, False), 'EngineType': (<class 'str'>, True),'EngineVersion': (<class 'str'>, True), 'Name': (<class 'str'>, True), 'Tags':(<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::AmazonMQ::Configuration'

class troposphere.amazonmq.ConfigurationAssociation(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ConfigurationAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Broker': (<class 'str'>, True), 'Configuration': (<class'troposphere.amazonmq.ConfigurationId'>, True)}

resource_type: Optional[str] = 'AWS::AmazonMQ::ConfigurationAssociation'

class troposphere.amazonmq.ConfigurationId(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConfigurationId

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Id':(<class 'str'>, True), 'Revision': (<function integer>, True)}

class troposphere.amazonmq.EncryptionOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EncryptionOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KmsKeyId': (<class 'str'>, False), 'UseAwsOwnedKey': (<function boolean>, True)}

class troposphere.amazonmq.LdapServerMetadata(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LdapServerMetadata

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Hosts': ([<class 'str'>], True), 'RoleBase': (<class 'str'>, True), 'RoleName':(<class 'str'>, False), 'RoleSearchMatching': (<class 'str'>, True),'RoleSearchSubtree': (<function boolean>, False), 'ServiceAccountPassword':(<class 'str'>, True), 'ServiceAccountUsername': (<class 'str'>, True), 'UserBase':(<class 'str'>, True), 'UserRoleName': (<class 'str'>, False),'UserSearchMatching': (<class 'str'>, True), 'UserSearchSubtree': (<functionboolean>, False)}

class troposphere.amazonmq.LogsConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LogsConfiguration

7.3. troposphere 41

Page 46: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Audit': (<function boolean>, False), 'General': (<function boolean>, False)}

class troposphere.amazonmq.MaintenanceWindow(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MaintenanceWindow

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DayOfWeek': (<class 'str'>, True), 'TimeOfDay': (<class 'str'>, True),'TimeZone': (<class 'str'>, True)}

class troposphere.amazonmq.User(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

User

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConsoleAccess': (<function boolean>, False), 'Groups': ([<class 'str'>], False),'Password': (<class 'str'>, True), 'Username': (<class 'str'>, True)}

troposphere.amplify module

class troposphere.amplify.App(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

App

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessToken': (<class 'str'>, False), 'AutoBranchCreationConfig': (<class'troposphere.amplify.AutoBranchCreationConfig'>, False), 'BasicAuthConfig': (<class'troposphere.amplify.BasicAuthConfig'>, False), 'BuildSpec': (<class 'str'>,False), 'CustomHeaders': (<class 'str'>, False), 'CustomRules': ([<class'troposphere.amplify.CustomRule'>], False), 'Description': (<class 'str'>, False),'EnableBranchAutoDeletion': (<function boolean>, False), 'EnvironmentVariables':([<class 'troposphere.amplify.EnvironmentVariable'>], False), 'IAMServiceRole':(<class 'str'>, False), 'Name': (<class 'str'>, True), 'OauthToken': (<class'str'>, False), 'Repository': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::Amplify::App'

class troposphere.amplify.AutoBranchCreationConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AutoBranchCreationConfig

42 Chapter 7. Licensing

Page 47: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoBranchCreationPatterns': ([<class 'str'>], False), 'BasicAuthConfig':(<class 'troposphere.amplify.BasicAuthConfig'>, False), 'BuildSpec': (<class'str'>, False), 'EnableAutoBranchCreation': (<function boolean>, False),'EnableAutoBuild': (<function boolean>, False), 'EnablePerformanceMode':(<function boolean>, False), 'EnablePullRequestPreview': (<function boolean>,False), 'EnvironmentVariables': ([<class'troposphere.amplify.EnvironmentVariable'>], False), 'PullRequestEnvironmentName':(<class 'str'>, False), 'Stage': (<class 'str'>, False)}

class troposphere.amplify.BasicAuthConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BasicAuthConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EnableBasicAuth': (<function boolean>, False), 'Password': (<class 'str'>,True), 'Username': (<class 'str'>, True)}

class troposphere.amplify.Branch(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Branch

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AppId': (<class 'str'>, True), 'BasicAuthConfig': (<class'troposphere.amplify.BasicAuthConfig'>, False), 'BranchName': (<class 'str'>,True), 'BuildSpec': (<class 'str'>, False), 'Description': (<class 'str'>, False),'EnableAutoBuild': (<function boolean>, False), 'EnablePerformanceMode':(<function boolean>, False), 'EnablePullRequestPreview': (<function boolean>,False), 'EnvironmentVariables': ([<class'troposphere.amplify.EnvironmentVariable'>], False), 'PullRequestEnvironmentName':(<class 'str'>, False), 'Stage': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::Amplify::Branch'

class troposphere.amplify.CustomRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CustomRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Condition': (<class 'str'>, False), 'Source': (<class 'str'>, True), 'Status':(<class 'str'>, False), 'Target': (<class 'str'>, True)}

class troposphere.amplify.Domain(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Domain

7.3. troposphere 43

Page 48: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AppId': (<class 'str'>, True), 'AutoSubDomainCreationPatterns': ([<class'str'>], False), 'AutoSubDomainIAMRole': (<class 'str'>, False), 'DomainName':(<class 'str'>, True), 'EnableAutoSubDomain': (<function boolean>, False),'SubDomainSettings': ([<class 'troposphere.amplify.SubDomainSetting'>], True)}

resource_type: Optional[str] = 'AWS::Amplify::Domain'

class troposphere.amplify.EnvironmentVariable(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EnvironmentVariable

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.amplify.SubDomainSetting(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SubDomainSetting

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BranchName': (<class 'str'>, True), 'Prefix': (<class 'str'>, True)}

troposphere.analytics module

class troposphere.analytics.Application(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Application

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationCode': (<class 'str'>, False), 'ApplicationDescription': (<class'str'>, False), 'ApplicationName': (<class 'str'>, False), 'Inputs': ([<class'troposphere.analytics.Input'>], True)}

resource_type: Optional[str] = 'AWS::KinesisAnalytics::Application'

class troposphere.analytics.ApplicationOutput(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ApplicationOutput

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationName': (<class 'str'>, True), 'Output': (<class'troposphere.analytics.Output'>, True)}

resource_type: Optional[str] = 'AWS::KinesisAnalytics::ApplicationOutput'

44 Chapter 7. Licensing

Page 49: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.analytics.ApplicationReferenceDataSource(title: Optional[str], template:Optional[troposphere.Template] =None, validation: bool = True,**kwargs: Any)

Bases: troposphere.AWSObject

ApplicationReferenceDataSource

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationName': (<class 'str'>, True), 'ReferenceDataSource': (<class'troposphere.analytics.ReferenceDataSource'>, True)}

resource_type: Optional[str] ='AWS::KinesisAnalytics::ApplicationReferenceDataSource'

class troposphere.analytics.CSVMappingParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CSVMappingParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RecordColumnDelimiter': (<class 'str'>, True), 'RecordRowDelimiter': (<class'str'>, True)}

class troposphere.analytics.DestinationSchema(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DestinationSchema

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RecordFormatType': (<class 'str'>, False)}

class troposphere.analytics.Input(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Input

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InputParallelism': (<class 'troposphere.analytics.InputParallelism'>, False),'InputProcessingConfiguration': (<class'troposphere.analytics.InputProcessingConfiguration'>, False), 'InputSchema':(<class 'troposphere.analytics.InputSchema'>, True), 'KinesisFirehoseInput':(<class 'troposphere.analytics.KinesisFirehoseInput'>, False),'KinesisStreamsInput': (<class 'troposphere.analytics.KinesisStreamsInput'>,False), 'NamePrefix': (<class 'str'>, True)}

class troposphere.analytics.InputLambdaProcessor(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InputLambdaProcessor

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ResourceARN': (<class 'str'>, True), 'RoleARN': (<class 'str'>, True)}

class troposphere.analytics.InputParallelism(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 45

Page 50: Release 3.1

troposphere Documentation, Release 4.0.1

InputParallelism

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Count': (<function integer>, False)}

class troposphere.analytics.InputProcessingConfiguration(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

InputProcessingConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InputLambdaProcessor': (<class 'troposphere.analytics.InputLambdaProcessor'>,False)}

class troposphere.analytics.InputSchema(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InputSchema

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RecordColumns': ([<class 'troposphere.analytics.RecordColumn'>], True),'RecordEncoding': (<class 'str'>, False), 'RecordFormat': (<class'troposphere.analytics.RecordFormat'>, True)}

class troposphere.analytics.JSONMappingParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

JSONMappingParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RecordRowPath': (<class 'str'>, True)}

class troposphere.analytics.KinesisFirehoseInput(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KinesisFirehoseInput

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ResourceARN': (<class 'str'>, True), 'RoleARN': (<class 'str'>, True)}

class troposphere.analytics.KinesisFirehoseOutput(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KinesisFirehoseOutput

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ResourceARN': (<class 'str'>, True), 'RoleARN': (<class 'str'>, True)}

class troposphere.analytics.KinesisStreamsInput(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KinesisStreamsInput

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ResourceARN': (<class 'str'>, True), 'RoleARN': (<class 'str'>, True)}

46 Chapter 7. Licensing

Page 51: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.analytics.KinesisStreamsOutput(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KinesisStreamsOutput

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ResourceARN': (<class 'str'>, True), 'RoleARN': (<class 'str'>, True)}

class troposphere.analytics.LambdaOutput(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LambdaOutput

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ResourceARN': (<class 'str'>, True), 'RoleARN': (<class 'str'>, True)}

class troposphere.analytics.MappingParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MappingParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CSVMappingParameters': (<class 'troposphere.analytics.CSVMappingParameters'>,False), 'JSONMappingParameters': (<class'troposphere.analytics.JSONMappingParameters'>, False)}

class troposphere.analytics.Output(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Output

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DestinationSchema': (<class 'troposphere.analytics.DestinationSchema'>, True),'KinesisFirehoseOutput': (<class 'troposphere.analytics.KinesisFirehoseOutput'>,False), 'KinesisStreamsOutput': (<class'troposphere.analytics.KinesisStreamsOutput'>, False), 'LambdaOutput': (<class'troposphere.analytics.LambdaOutput'>, False), 'Name': (<class 'str'>, False)}

class troposphere.analytics.RecordColumn(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RecordColumn

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Mapping': (<class 'str'>, False), 'Name': (<class 'str'>, True), 'SqlType':(<class 'str'>, True)}

class troposphere.analytics.RecordFormat(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RecordFormat

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MappingParameters': (<class 'troposphere.analytics.MappingParameters'>, False),'RecordFormatType': (<class 'str'>, True)}

7.3. troposphere 47

Page 52: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.analytics.ReferenceDataSource(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ReferenceDataSource

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ReferenceSchema': (<class 'troposphere.analytics.ReferenceSchema'>, True),'S3ReferenceDataSource': (<class 'troposphere.analytics.S3ReferenceDataSource'>,False), 'TableName': (<class 'str'>, False)}

class troposphere.analytics.ReferenceSchema(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ReferenceSchema

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RecordColumns': ([<class 'troposphere.analytics.RecordColumn'>], True),'RecordEncoding': (<class 'str'>, False), 'RecordFormat': (<class'troposphere.analytics.RecordFormat'>, True)}

class troposphere.analytics.S3ReferenceDataSource(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3ReferenceDataSource

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketARN': (<class 'str'>, True), 'FileKey': (<class 'str'>, True),'ReferenceRoleARN': (<class 'str'>, True)}

troposphere.apigateway module

class troposphere.apigateway.AccessLogSetting(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AccessLogSetting

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DestinationArn': (<class 'str'>, False), 'Format': (<class 'str'>, False)}

class troposphere.apigateway.Account(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Account

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudWatchRoleArn': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::ApiGateway::Account'

class troposphere.apigateway.ApiKey(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ApiKey

48 Chapter 7. Licensing

Page 53: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CustomerId': (<class 'str'>, False), 'Description': (<class 'str'>, False),'Enabled': (<function boolean>, False), 'GenerateDistinctId': (<function boolean>,False), 'Name': (<class 'str'>, False), 'StageKeys': ([<class'troposphere.apigateway.StageKey'>], False), 'Tags': (<class 'troposphere.Tags'>,False), 'Value': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::ApiGateway::ApiKey'

class troposphere.apigateway.ApiStage(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ApiStage

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiId': (<class 'str'>, False), 'Stage': (<class 'str'>, False), 'Throttle':(<class 'dict'>, False)}

class troposphere.apigateway.Authorizer(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Authorizer

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthType': (<class 'str'>, False), 'AuthorizerCredentials': (<class 'str'>,False), 'AuthorizerResultTtlInSeconds': (<function validate_authorizer_ttl>,False), 'AuthorizerUri': (<class 'str'>, False), 'IdentitySource': (<class 'str'>,False), 'IdentityValidationExpression': (<class 'str'>, False), 'Name': (<class'str'>, True), 'ProviderARNs': ([<class 'str'>], False), 'RestApiId': (<class'str'>, True), 'Type': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::ApiGateway::Authorizer'

class troposphere.apigateway.BasePathMapping(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

BasePathMapping

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BasePath': (<class 'str'>, False), 'DomainName': (<class 'str'>, True), 'Id':(<class 'str'>, False), 'RestApiId': (<class 'str'>, False), 'Stage': (<class'str'>, False)}

resource_type: Optional[str] = 'AWS::ApiGateway::BasePathMapping'

class troposphere.apigateway.CanarySetting(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CanarySetting

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PercentTraffic': (<function double>, False), 'StageVariableOverrides': (<class'dict'>, False), 'UseStageCache': (<function boolean>, False)}

7.3. troposphere 49

Page 54: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.apigateway.ClientCertificate(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ClientCertificate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>,False)}

resource_type: Optional[str] = 'AWS::ApiGateway::ClientCertificate'

class troposphere.apigateway.Deployment(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Deployment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeploymentCanarySettings': (<class'troposphere.apigateway.DeploymentCanarySettings'>, False), 'Description': (<class'str'>, False), 'RestApiId': (<class 'str'>, True), 'StageDescription': (<class'troposphere.apigateway.StageDescription'>, False), 'StageName': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::ApiGateway::Deployment'

class troposphere.apigateway.DeploymentCanarySettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DeploymentCanarySettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PercentTraffic': (<function double>, False), 'StageVariableOverrides': (<class'dict'>, False), 'UseStageCache': (<function boolean>, False)}

class troposphere.apigateway.DocumentationPart(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DocumentationPart

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Location': (<class 'troposphere.apigateway.Location'>, True), 'Properties':(<class 'str'>, True), 'RestApiId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::ApiGateway::DocumentationPart'

class troposphere.apigateway.DocumentationVersion(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DocumentationVersion

50 Chapter 7. Licensing

Page 55: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'DocumentationVersion': (<class 'str'>,True), 'RestApiId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::ApiGateway::DocumentationVersion'

class troposphere.apigateway.DomainName(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DomainName

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateArn': (<class 'str'>, False), 'DomainName': (<class 'str'>, False),'EndpointConfiguration': (<class 'troposphere.apigateway.EndpointConfiguration'>,False), 'MutualTlsAuthentication': (<class'troposphere.apigateway.MutualTlsAuthentication'>, False),'OwnershipVerificationCertificateArn': (<class 'str'>, False),'RegionalCertificateArn': (<class 'str'>, False), 'SecurityPolicy': (<class'str'>, False), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::ApiGateway::DomainName'

class troposphere.apigateway.EndpointConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EndpointConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Types': ([<class 'str'>], False), 'VpcEndpointIds': ([<class 'str'>], False)}

class troposphere.apigateway.GatewayResponse(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

GatewayResponse

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ResponseParameters': (<class 'dict'>, False), 'ResponseTemplates': (<class'dict'>, False), 'ResponseType': (<function validate_gateway_response_type>, True),'RestApiId': (<class 'str'>, True), 'StatusCode': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::ApiGateway::GatewayResponse'

class troposphere.apigateway.Integration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Integration

7.3. troposphere 51

Page 56: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CacheKeyParameters': ([<class 'str'>], False), 'CacheNamespace': (<class 'str'>,False), 'ConnectionId': (<class 'str'>, False), 'ConnectionType': (<class 'str'>,False), 'ContentHandling': (<class 'str'>, False), 'Credentials': (<class 'str'>,False), 'IntegrationHttpMethod': (<class 'str'>, False), 'IntegrationResponses':([<class 'troposphere.apigateway.IntegrationResponse'>], False),'PassthroughBehavior': (<class 'str'>, False), 'RequestParameters': (<class'dict'>, False), 'RequestTemplates': (<class 'dict'>, False), 'TimeoutInMillis':(<function validate_timeout_in_millis>, False), 'Type': (<class 'str'>, False),'Uri': (<class 'str'>, False)}

class troposphere.apigateway.IntegrationResponse(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

IntegrationResponse

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContentHandling': (<class 'str'>, False), 'ResponseParameters': (<class 'dict'>,False), 'ResponseTemplates': (<class 'dict'>, False), 'SelectionPattern': (<class'str'>, False), 'StatusCode': (<class 'str'>, True)}

class troposphere.apigateway.Location(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Location

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Method': (<class 'str'>, False), 'Name': (<class 'str'>, False), 'Path':(<class 'str'>, False), 'StatusCode': (<class 'str'>, False), 'Type': (<class'str'>, False)}

class troposphere.apigateway.Method(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Method

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiKeyRequired': (<function boolean>, False), 'AuthorizationScopes': ([<class'str'>], False), 'AuthorizationType': (<class 'str'>, False), 'AuthorizerId':(<class 'str'>, False), 'HttpMethod': (<class 'str'>, True), 'Integration':(<class 'troposphere.apigateway.Integration'>, False), 'MethodResponses': ([<class'troposphere.apigateway.MethodResponse'>], False), 'OperationName': (<class 'str'>,False), 'RequestModels': (<class 'dict'>, False), 'RequestParameters': (<class'dict'>, False), 'RequestValidatorId': (<class 'str'>, False), 'ResourceId':(<class 'str'>, True), 'RestApiId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::ApiGateway::Method'

class troposphere.apigateway.MethodResponse(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MethodResponse

52 Chapter 7. Licensing

Page 57: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ResponseModels': (<class 'dict'>, False), 'ResponseParameters': (<class 'dict'>,False), 'StatusCode': (<class 'str'>, True)}

class troposphere.apigateway.MethodSetting(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MethodSetting

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CacheDataEncrypted': (<function boolean>, False), 'CacheTtlInSeconds':(<function integer>, False), 'CachingEnabled': (<function boolean>, False),'DataTraceEnabled': (<function boolean>, False), 'HttpMethod': (<class 'str'>,False), 'LoggingLevel': (<class 'str'>, False), 'MetricsEnabled': (<functionboolean>, False), 'ResourcePath': (<class 'str'>, False), 'ThrottlingBurstLimit':(<function integer>, False), 'ThrottlingRateLimit': (<function double>, False)}

class troposphere.apigateway.Model(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Model

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContentType': (<class 'str'>, False), 'Description': (<class 'str'>, False),'Name': (<class 'str'>, False), 'RestApiId': (<class 'str'>, True), 'Schema':(<function dict_or_string>, False)}

resource_type: Optional[str] = 'AWS::ApiGateway::Model'

validate()

class troposphere.apigateway.MutualTlsAuthentication(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MutualTlsAuthentication

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TruststoreUri': (<class 'str'>, False), 'TruststoreVersion': (<class 'str'>,False)}

class troposphere.apigateway.QuotaSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

QuotaSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Limit': (<function integer>, False), 'Offset': (<function integer>, False),'Period': (<class 'str'>, False)}

class troposphere.apigateway.RequestValidator(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

RequestValidator

7.3. troposphere 53

Page 58: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'RestApiId': (<class 'str'>, True),'ValidateRequestBody': (<function boolean>, False), 'ValidateRequestParameters':(<function boolean>, False)}

resource_type: Optional[str] = 'AWS::ApiGateway::RequestValidator'

class troposphere.apigateway.Resource(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Resource

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ParentId': (<class 'str'>, True), 'PathPart': (<class 'str'>, True),'RestApiId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::ApiGateway::Resource'

class troposphere.apigateway.RestApi(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

RestApi

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiKeySourceType': (<class 'str'>, False), 'BinaryMediaTypes': ([<class 'str'>],False), 'Body': (<class 'dict'>, False), 'BodyS3Location': (<class'troposphere.apigateway.S3Location'>, False), 'CloneFrom': (<class 'str'>, False),'Description': (<class 'str'>, False), 'DisableExecuteApiEndpoint': (<functionboolean>, False), 'EndpointConfiguration': (<class'troposphere.apigateway.EndpointConfiguration'>, False), 'FailOnWarnings':(<function boolean>, False), 'MinimumCompressionSize': (<function integer>, False),'Mode': (<class 'str'>, False), 'Name': (<class 'str'>, False), 'Parameters':(<class 'dict'>, False), 'Policy': (<class 'dict'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::ApiGateway::RestApi'

class troposphere.apigateway.S3Location(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3Location

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Bucket': (<class 'str'>, False), 'ETag': (<class 'str'>, False), 'Key': (<class'str'>, False), 'Version': (<class 'str'>, False)}

class troposphere.apigateway.Stage(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Stage

54 Chapter 7. Licensing

Page 59: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessLogSetting': (<class 'troposphere.apigateway.AccessLogSetting'>, False),'CacheClusterEnabled': (<function boolean>, False), 'CacheClusterSize': (<class'str'>, False), 'CanarySetting': (<class'troposphere.apigateway.StageCanarySetting'>, False), 'ClientCertificateId':(<class 'str'>, False), 'DeploymentId': (<class 'str'>, False), 'Description':(<class 'str'>, False), 'DocumentationVersion': (<class 'str'>, False),'MethodSettings': ([<class 'troposphere.apigateway.MethodSetting'>], False),'RestApiId': (<class 'str'>, True), 'StageName': (<class 'str'>, False), 'Tags':(<function validate_tags_or_list>, False), 'TracingEnabled': (<function boolean>,False), 'Variables': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::ApiGateway::Stage'

class troposphere.apigateway.StageCanarySetting(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

StageCanarySetting

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeploymentId': (<class 'str'>, False), 'PercentTraffic': (<function double>,False), 'StageVariableOverrides': (<class 'dict'>, False), 'UseStageCache':(<function boolean>, False)}

class troposphere.apigateway.StageDescription(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

StageDescription

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessLogSetting': (<class 'troposphere.apigateway.AccessLogSetting'>, False),'CacheClusterEnabled': (<function boolean>, False), 'CacheClusterSize': (<class'str'>, False), 'CacheDataEncrypted': (<function boolean>, False),'CacheTtlInSeconds': (<function integer>, False), 'CachingEnabled': (<functionboolean>, False), 'CanarySetting': (<class'troposphere.apigateway.DeploymentCanarySettings'>, False), 'ClientCertificateId':(<class 'str'>, False), 'DataTraceEnabled': (<function boolean>, False),'Description': (<class 'str'>, False), 'DocumentationVersion': (<class 'str'>,False), 'LoggingLevel': (<class 'str'>, False), 'MethodSettings': ([<class'troposphere.apigateway.MethodSetting'>], False), 'MetricsEnabled': (<functionboolean>, False), 'Tags': (<function validate_tags_or_list>, False),'ThrottlingBurstLimit': (<function integer>, False), 'ThrottlingRateLimit':(<function double>, False), 'TracingEnabled': (<function boolean>, False),'Variables': (<class 'dict'>, False)}

class troposphere.apigateway.StageKey(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

StageKey

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RestApiId': (<class 'str'>, False), 'StageName': (<class 'str'>, False)}

class troposphere.apigateway.ThrottleSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 55

Page 60: Release 3.1

troposphere Documentation, Release 4.0.1

ThrottleSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BurstLimit': (<function integer>, False), 'RateLimit': (<function double>,False)}

class troposphere.apigateway.UsagePlan(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

UsagePlan

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiStages': ([<class 'troposphere.apigateway.ApiStage'>], False), 'Description':(<class 'str'>, False), 'Quota': (<class 'troposphere.apigateway.QuotaSettings'>,False), 'Tags': (<class 'troposphere.Tags'>, False), 'Throttle': (<class'troposphere.apigateway.ThrottleSettings'>, False), 'UsagePlanName': (<class'str'>, False)}

resource_type: Optional[str] = 'AWS::ApiGateway::UsagePlan'

class troposphere.apigateway.UsagePlanKey(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

UsagePlanKey

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KeyId': (<class 'str'>, True), 'KeyType': (<class 'str'>, True), 'UsagePlanId':(<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::ApiGateway::UsagePlanKey'

class troposphere.apigateway.VpcLink(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VpcLink

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'Name': (<class 'str'>, True), 'Tags':(<class 'troposphere.Tags'>, False), 'TargetArns': ([<class 'str'>], True)}

resource_type: Optional[str] = 'AWS::ApiGateway::VpcLink'

56 Chapter 7. Licensing

Page 61: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.apigatewayv2 module

class troposphere.apigatewayv2.AccessLogSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AccessLogSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DestinationArn': (<class 'str'>, False), 'Format': (<class 'str'>, False)}

class troposphere.apigatewayv2.Api(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Api

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiKeySelectionExpression': (<class 'str'>, False), 'BasePath': (<class 'str'>,False), 'Body': (<class 'dict'>, False), 'BodyS3Location': (<class'troposphere.apigatewayv2.BodyS3Location'>, False), 'CorsConfiguration': (<class'troposphere.apigatewayv2.Cors'>, False), 'CredentialsArn': (<class 'str'>, False),'Description': (<class 'str'>, False), 'DisableExecuteApiEndpoint': (<functionboolean>, False), 'DisableSchemaValidation': (<function boolean>, False),'FailOnWarnings': (<function boolean>, False), 'Name': (<class 'str'>, False),'ProtocolType': (<class 'str'>, False), 'RouteKey': (<class 'str'>, False),'RouteSelectionExpression': (<class 'str'>, False), 'Tags': (<class 'dict'>,False), 'Target': (<class 'str'>, False), 'Version': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::ApiGatewayV2::Api'

class troposphere.apigatewayv2.ApiGatewayManagedOverrides(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ApiGatewayManagedOverrides

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiId': (<class 'str'>, True), 'Integration': (<class'troposphere.apigatewayv2.IntegrationOverrides'>, False), 'Route': (<class'troposphere.apigatewayv2.RouteOverrides'>, False), 'Stage': (<class'troposphere.apigatewayv2.StageOverrides'>, False)}

resource_type: Optional[str] = 'AWS::ApiGatewayV2::ApiGatewayManagedOverrides'

class troposphere.apigatewayv2.ApiMapping(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

ApiMapping

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiId': (<class 'str'>, True), 'ApiMappingKey': (<class 'str'>, False),'DomainName': (<class 'str'>, True), 'Stage': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::ApiGatewayV2::ApiMapping'

7.3. troposphere 57

Page 62: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.apigatewayv2.Authorizer(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

Authorizer

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiId': (<class 'str'>, True), 'AuthorizerCredentialsArn': (<class 'str'>,False), 'AuthorizerPayloadFormatVersion': (<class 'str'>, False),'AuthorizerResultTtlInSeconds': (<function validate_authorizer_ttl>, False),'AuthorizerType': (<function validate_authorizer_type>, True), 'AuthorizerUri':(<class 'str'>, False), 'EnableSimpleResponses': (<function boolean>, False),'IdentitySource': ([<class 'str'>], False), 'IdentityValidationExpression':(<class 'str'>, False), 'JwtConfiguration': (<class'troposphere.apigatewayv2.JWTConfiguration'>, False), 'Name': (<class 'str'>,True)}

resource_type: Optional[str] = 'AWS::ApiGatewayV2::Authorizer'

class troposphere.apigatewayv2.BodyS3Location(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BodyS3Location

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Bucket': (<class 'str'>, False), 'Etag': (<class 'str'>, False), 'Key': (<class'str'>, False), 'Version': (<class 'str'>, False)}

class troposphere.apigatewayv2.Cors(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Cors

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllowCredentials': (<function boolean>, False), 'AllowHeaders': ([<class'str'>], False), 'AllowMethods': ([<class 'str'>], False), 'AllowOrigins':([<class 'str'>], False), 'ExposeHeaders': ([<class 'str'>], False), 'MaxAge':(<function integer>, False)}

class troposphere.apigatewayv2.Deployment(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

Deployment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiId': (<class 'str'>, True), 'Description': (<class 'str'>, False),'StageName': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::ApiGatewayV2::Deployment'

class troposphere.apigatewayv2.DomainName(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

58 Chapter 7. Licensing

Page 63: Release 3.1

troposphere Documentation, Release 4.0.1

DomainName

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DomainName': (<class 'str'>, True), 'DomainNameConfigurations': ([<class'troposphere.apigatewayv2.DomainNameConfiguration'>], False),'MutualTlsAuthentication': (<class'troposphere.apigatewayv2.MutualTlsAuthentication'>, False), 'Tags': (<class'dict'>, False)}

resource_type: Optional[str] = 'AWS::ApiGatewayV2::DomainName'

class troposphere.apigatewayv2.DomainNameConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DomainNameConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateArn': (<class 'str'>, False), 'CertificateName': (<class 'str'>,False), 'EndpointType': (<class 'str'>, False),'OwnershipVerificationCertificateArn': (<class 'str'>, False), 'SecurityPolicy':(<class 'str'>, False)}

class troposphere.apigatewayv2.Integration(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

Integration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiId': (<class 'str'>, True), 'ConnectionId': (<class 'str'>, False),'ConnectionType': (<class 'str'>, False), 'ContentHandlingStrategy': (<functionvalidate_content_handling_strategy>, False), 'CredentialsArn': (<class 'str'>,False), 'Description': (<class 'str'>, False), 'IntegrationMethod': (<class'str'>, False), 'IntegrationSubtype': (<class 'str'>, False), 'IntegrationType':(<function validate_integration_type>, True), 'IntegrationUri': (<class 'str'>,False), 'PassthroughBehavior': (<function validate_passthrough_behavior>, False),'PayloadFormatVersion': (<class 'str'>, False), 'RequestParameters': (<class'dict'>, False), 'RequestTemplates': (<class 'dict'>, False), 'ResponseParameters':(<class 'dict'>, False), 'TemplateSelectionExpression': (<class 'str'>, False),'TimeoutInMillis': (<function validate_timeout_in_millis>, False), 'TlsConfig':(<class 'troposphere.apigatewayv2.TlsConfig'>, False)}

resource_type: Optional[str] = 'AWS::ApiGatewayV2::Integration'

class troposphere.apigatewayv2.IntegrationOverrides(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

IntegrationOverrides

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'IntegrationMethod': (<class 'str'>,False), 'PayloadFormatVersion': (<class 'str'>, False), 'TimeoutInMillis':(<function integer>, False)}

7.3. troposphere 59

Page 64: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.apigatewayv2.IntegrationResponse(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

IntegrationResponse

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiId': (<class 'str'>, True), 'ContentHandlingStrategy': (<functionvalidate_content_handling_strategy>, False), 'IntegrationId': (<class 'str'>,True), 'IntegrationResponseKey': (<class 'str'>, True), 'ResponseParameters':(<class 'dict'>, False), 'ResponseTemplates': (<class 'dict'>, False),'TemplateSelectionExpression': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::ApiGatewayV2::IntegrationResponse'

class troposphere.apigatewayv2.JWTConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

JWTConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Audience': ([<class 'str'>], False), 'Issuer': (<class 'str'>, False)}

class troposphere.apigatewayv2.Model(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Model

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiId': (<class 'str'>, True), 'ContentType': (<class 'str'>, False),'Description': (<class 'str'>, False), 'Name': (<class 'str'>, True), 'Schema':(<function dict_or_string>, True)}

resource_type: Optional[str] = 'AWS::ApiGatewayV2::Model'

validate()

class troposphere.apigatewayv2.MutualTlsAuthentication(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MutualTlsAuthentication

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TruststoreUri': (<class 'str'>, False), 'TruststoreVersion': (<class 'str'>,False)}

class troposphere.apigatewayv2.ParameterConstraints(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ParameterConstraints

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Required': (<function boolean>, True)}

class troposphere.apigatewayv2.ResponseParameter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

60 Chapter 7. Licensing

Page 65: Release 3.1

troposphere Documentation, Release 4.0.1

ResponseParameter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Destination': (<class 'str'>, True), 'Source': (<class 'str'>, True)}

class troposphere.apigatewayv2.ResponseParameterList(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ResponseParameterList

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ResponseParameters': ([<class 'troposphere.apigatewayv2.ResponseParameter'>],False)}

class troposphere.apigatewayv2.Route(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Route

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiId': (<class 'str'>, True), 'ApiKeyRequired': (<function boolean>, False),'AuthorizationScopes': ([<class 'str'>], False), 'AuthorizationType': (<class'str'>, False), 'AuthorizerId': (<class 'str'>, False), 'ModelSelectionExpression':(<class 'str'>, False), 'OperationName': (<class 'str'>, False), 'RequestModels':(<class 'dict'>, False), 'RequestParameters': (<class 'dict'>, False), 'RouteKey':(<class 'str'>, True), 'RouteResponseSelectionExpression': (<class 'str'>, False),'Target': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::ApiGatewayV2::Route'

class troposphere.apigatewayv2.RouteOverrides(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RouteOverrides

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthorizationScopes': ([<class 'str'>], False), 'AuthorizationType': (<class'str'>, False), 'AuthorizerId': (<class 'str'>, False), 'OperationName': (<class'str'>, False), 'Target': (<class 'str'>, False)}

class troposphere.apigatewayv2.RouteResponse(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

RouteResponse

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiId': (<class 'str'>, True), 'ModelSelectionExpression': (<class 'str'>,False), 'ResponseModels': (<class 'dict'>, False), 'ResponseParameters': (<class'dict'>, False), 'RouteId': (<class 'str'>, True), 'RouteResponseKey': (<class'str'>, True)}

resource_type: Optional[str] = 'AWS::ApiGatewayV2::RouteResponse'

7.3. troposphere 61

Page 66: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.apigatewayv2.RouteSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RouteSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DataTraceEnabled': (<function boolean>, False), 'DetailedMetricsEnabled':(<function boolean>, False), 'LoggingLevel': (<function validate_logging_level>,False), 'ThrottlingBurstLimit': (<function integer>, False), 'ThrottlingRateLimit':(<function double>, False)}

class troposphere.apigatewayv2.Stage(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Stage

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessLogSettings': (<class 'troposphere.apigatewayv2.AccessLogSettings'>,False), 'AccessPolicyId': (<class 'str'>, False), 'ApiId': (<class 'str'>, True),'AutoDeploy': (<function boolean>, False), 'ClientCertificateId': (<class 'str'>,False), 'DefaultRouteSettings': (<class 'troposphere.apigatewayv2.RouteSettings'>,False), 'DeploymentId': (<class 'str'>, False), 'Description': (<class 'str'>,False), 'RouteSettings': (<class 'dict'>, False), 'StageName': (<class 'str'>,True), 'StageVariables': (<class 'dict'>, False), 'Tags': (<functionvalidate_tags_or_list>, False)}

resource_type: Optional[str] = 'AWS::ApiGatewayV2::Stage'

class troposphere.apigatewayv2.StageOverrides(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

StageOverrides

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessLogSettings': (<class 'troposphere.apigatewayv2.AccessLogSettings'>,False), 'AutoDeploy': (<function boolean>, False), 'DefaultRouteSettings': (<class'troposphere.apigatewayv2.RouteSettings'>, False), 'Description': (<class 'str'>,False), 'RouteSettings': (<class 'dict'>, False), 'StageVariables': (<class'dict'>, False)}

class troposphere.apigatewayv2.TlsConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TlsConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ServerNameToVerify': (<class 'str'>, False)}

class troposphere.apigatewayv2.VpcLink(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VpcLink

62 Chapter 7. Licensing

Page 67: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'SecurityGroupIds': ([<class 'str'>], False),'SubnetIds': ([<class 'str'>], True), 'Tags': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::ApiGatewayV2::VpcLink'

troposphere.appconfig module

class troposphere.appconfig.Application(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Application

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'Name': (<class 'str'>, True), 'Tags':(<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::AppConfig::Application'

class troposphere.appconfig.ConfigurationProfile(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ConfigurationProfile

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationId': (<class 'str'>, True), 'Description': (<class 'str'>, False),'LocationUri': (<class 'str'>, True), 'Name': (<class 'str'>, True),'RetrievalRoleArn': (<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>,False), 'Type': (<class 'str'>, False), 'Validators': ([<class'troposphere.appconfig.Validators'>], False)}

resource_type: Optional[str] = 'AWS::AppConfig::ConfigurationProfile'

class troposphere.appconfig.Deployment(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Deployment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationId': (<class 'str'>, True), 'ConfigurationProfileId': (<class 'str'>,True), 'ConfigurationVersion': (<class 'str'>, True), 'DeploymentStrategyId':(<class 'str'>, True), 'Description': (<class 'str'>, False), 'EnvironmentId':(<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::AppConfig::Deployment'

class troposphere.appconfig.DeploymentStrategy(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DeploymentStrategy

7.3. troposphere 63

Page 68: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeploymentDurationInMinutes': (<function double>, True), 'Description': (<class'str'>, False), 'FinalBakeTimeInMinutes': (<function double>, False),'GrowthFactor': (<function double>, True), 'GrowthType': (<functionvalidate_growth_type>, False), 'Name': (<class 'str'>, True), 'ReplicateTo':(<function validate_replicate_to>, True), 'Tags': (<class 'troposphere.Tags'>,False)}

resource_type: Optional[str] = 'AWS::AppConfig::DeploymentStrategy'

class troposphere.appconfig.Environment(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Environment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationId': (<class 'str'>, True), 'Description': (<class 'str'>, False),'Monitors': ([<class 'troposphere.appconfig.Monitors'>], False), 'Name': (<class'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::AppConfig::Environment'

class troposphere.appconfig.HostedConfigurationVersion(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

HostedConfigurationVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationId': (<class 'str'>, True), 'ConfigurationProfileId': (<class 'str'>,True), 'Content': (<class 'str'>, True), 'ContentType': (<class 'str'>, True),'Description': (<class 'str'>, False), 'LatestVersionNumber': (<function double>,False)}

resource_type: Optional[str] = 'AWS::AppConfig::HostedConfigurationVersion'

class troposphere.appconfig.Monitors(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Monitors

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AlarmArn': (<class 'str'>, False), 'AlarmRoleArn': (<class 'str'>, False)}

class troposphere.appconfig.Validators(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Validators

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Content': (<class 'str'>, False), 'Type': (<function validate_validator_type>,False)}

64 Chapter 7. Licensing

Page 69: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.appflow module

class troposphere.appflow.AggregationConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AggregationConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AggregationType': (<class 'str'>, False)}

class troposphere.appflow.AmplitudeConnectorProfileCredentials(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

AmplitudeConnectorProfileCredentials

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiKey': (<class 'str'>, True), 'SecretKey': (<class 'str'>, True)}

class troposphere.appflow.AmplitudeSourceProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AmplitudeSourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Object': (<class 'str'>, True)}

class troposphere.appflow.ConnectorOAuthRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConnectorOAuthRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthCode': (<class 'str'>, False), 'RedirectUri': (<class 'str'>, False)}

class troposphere.appflow.ConnectorOperator(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConnectorOperator

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Amplitude': (<class 'str'>, False), 'Datadog': (<class 'str'>, False),'Dynatrace': (<class 'str'>, False), 'GoogleAnalytics': (<class 'str'>, False),'InforNexus': (<class 'str'>, False), 'Marketo': (<class 'str'>, False), 'S3':(<class 'str'>, False), 'SAPOData': (<class 'str'>, False), 'Salesforce': (<class'str'>, False), 'ServiceNow': (<class 'str'>, False), 'Singular': (<class 'str'>,False), 'Slack': (<class 'str'>, False), 'Trendmicro': (<class 'str'>, False),'Veeva': (<class 'str'>, False), 'Zendesk': (<class 'str'>, False)}

class troposphere.appflow.ConnectorProfile(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

ConnectorProfile

7.3. troposphere 65

Page 70: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectionMode': (<class 'str'>, True), 'ConnectorProfileConfig': (<class'troposphere.appflow.ConnectorProfileConfig'>, False), 'ConnectorProfileName':(<class 'str'>, True), 'ConnectorType': (<class 'str'>, True), 'KMSArn': (<class'str'>, False)}

resource_type: Optional[str] = 'AWS::AppFlow::ConnectorProfile'

class troposphere.appflow.ConnectorProfileConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConnectorProfileConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectorProfileCredentials': (<class'troposphere.appflow.ConnectorProfileCredentials'>, True),'ConnectorProfileProperties': (<class'troposphere.appflow.ConnectorProfileProperties'>, False)}

class troposphere.appflow.ConnectorProfileCredentials(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConnectorProfileCredentials

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Amplitude': (<class 'troposphere.appflow.AmplitudeConnectorProfileCredentials'>,False), 'Datadog': (<class'troposphere.appflow.DatadogConnectorProfileCredentials'>, False), 'Dynatrace':(<class 'troposphere.appflow.DynatraceConnectorProfileCredentials'>, False),'GoogleAnalytics': (<class'troposphere.appflow.GoogleAnalyticsConnectorProfileCredentials'>, False),'InforNexus': (<class 'troposphere.appflow.InforNexusConnectorProfileCredentials'>,False), 'Marketo': (<class'troposphere.appflow.MarketoConnectorProfileCredentials'>, False), 'Redshift':(<class 'troposphere.appflow.RedshiftConnectorProfileCredentials'>, False),'SAPOData': (<class 'troposphere.appflow.SAPODataConnectorProfileCredentials'>,False), 'Salesforce': (<class'troposphere.appflow.SalesforceConnectorProfileCredentials'>, False), 'ServiceNow':(<class 'troposphere.appflow.ServiceNowConnectorProfileCredentials'>, False),'Singular': (<class 'troposphere.appflow.SingularConnectorProfileCredentials'>,False), 'Slack': (<class 'troposphere.appflow.SlackConnectorProfileCredentials'>,False), 'Snowflake': (<class'troposphere.appflow.SnowflakeConnectorProfileCredentials'>, False), 'Trendmicro':(<class 'troposphere.appflow.TrendmicroConnectorProfileCredentials'>, False),'Veeva': (<class 'troposphere.appflow.VeevaConnectorProfileCredentials'>, False),'Zendesk': (<class 'troposphere.appflow.ZendeskConnectorProfileCredentials'>,False)}

class troposphere.appflow.ConnectorProfileProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConnectorProfileProperties

66 Chapter 7. Licensing

Page 71: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Datadog': (<class 'troposphere.appflow.DatadogConnectorProfileProperties'>,False), 'Dynatrace': (<class'troposphere.appflow.DynatraceConnectorProfileProperties'>, False), 'InforNexus':(<class 'troposphere.appflow.InforNexusConnectorProfileProperties'>, False),'Marketo': (<class 'troposphere.appflow.MarketoConnectorProfileProperties'>,False), 'Redshift': (<class'troposphere.appflow.RedshiftConnectorProfileProperties'>, False), 'SAPOData':(<class 'troposphere.appflow.SAPODataConnectorProfileProperties'>, False),'Salesforce': (<class 'troposphere.appflow.SalesforceConnectorProfileProperties'>,False), 'ServiceNow': (<class'troposphere.appflow.ServiceNowConnectorProfileProperties'>, False), 'Slack':(<class 'troposphere.appflow.SlackConnectorProfileProperties'>, False), 'Snowflake':(<class 'troposphere.appflow.SnowflakeConnectorProfileProperties'>, False), 'Veeva':(<class 'troposphere.appflow.VeevaConnectorProfileProperties'>, False), 'Zendesk':(<class 'troposphere.appflow.ZendeskConnectorProfileProperties'>, False)}

class troposphere.appflow.DatadogConnectorProfileCredentials(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

DatadogConnectorProfileCredentials

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiKey': (<class 'str'>, True), 'ApplicationKey': (<class 'str'>, True)}

class troposphere.appflow.DatadogConnectorProfileProperties(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

DatadogConnectorProfileProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InstanceUrl': (<class 'str'>, True)}

class troposphere.appflow.DatadogSourceProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DatadogSourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Object': (<class 'str'>, True)}

class troposphere.appflow.DestinationConnectorProperties(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

DestinationConnectorProperties

7.3. troposphere 67

Page 72: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EventBridge': (<class 'troposphere.appflow.EventBridgeDestinationProperties'>,False), 'LookoutMetrics': (<class'troposphere.appflow.LookoutMetricsDestinationProperties'>, False), 'Marketo':(<class 'troposphere.appflow.MarketoDestinationProperties'>, False), 'Redshift':(<class 'troposphere.appflow.RedshiftDestinationProperties'>, False), 'S3': (<class'troposphere.appflow.S3DestinationProperties'>, False), 'SAPOData': (<class'troposphere.appflow.SAPODataDestinationProperties'>, False), 'Salesforce': (<class'troposphere.appflow.SalesforceDestinationProperties'>, False), 'Snowflake':(<class 'troposphere.appflow.SnowflakeDestinationProperties'>, False), 'Upsolver':(<class 'troposphere.appflow.UpsolverDestinationProperties'>, False), 'Zendesk':(<class 'troposphere.appflow.ZendeskDestinationProperties'>, False)}

class troposphere.appflow.DestinationFlowConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DestinationFlowConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectorProfileName': (<class 'str'>, False), 'ConnectorType': (<class 'str'>,True), 'DestinationConnectorProperties': (<class'troposphere.appflow.DestinationConnectorProperties'>, True)}

class troposphere.appflow.DynatraceConnectorProfileCredentials(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

DynatraceConnectorProfileCredentials

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiToken': (<class 'str'>, True)}

class troposphere.appflow.DynatraceConnectorProfileProperties(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

DynatraceConnectorProfileProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InstanceUrl': (<class 'str'>, True)}

class troposphere.appflow.DynatraceSourceProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DynatraceSourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Object': (<class 'str'>, True)}

class troposphere.appflow.ErrorHandlingConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ErrorHandlingConfig

68 Chapter 7. Licensing

Page 73: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketName': (<class 'str'>, False), 'BucketPrefix': (<class 'str'>, False),'FailOnFirstError': (<function boolean>, False)}

class troposphere.appflow.EventBridgeDestinationProperties(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

EventBridgeDestinationProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ErrorHandlingConfig': (<class 'troposphere.appflow.ErrorHandlingConfig'>, False),'Object': (<class 'str'>, True)}

class troposphere.appflow.Flow(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Flow

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'DestinationFlowConfigList': ([<class'troposphere.appflow.DestinationFlowConfig'>], True), 'FlowName': (<class 'str'>,True), 'KMSArn': (<class 'str'>, False), 'SourceFlowConfig': (<class'troposphere.appflow.SourceFlowConfig'>, True), 'Tags': (<class'troposphere.Tags'>, False), 'Tasks': ([<class 'troposphere.appflow.Task'>], True),'TriggerConfig': (<class 'troposphere.appflow.TriggerConfig'>, True)}

resource_type: Optional[str] = 'AWS::AppFlow::Flow'

class troposphere.appflow.GoogleAnalyticsConnectorProfileCredentials(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

GoogleAnalyticsConnectorProfileCredentials

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessToken': (<class 'str'>, False), 'ClientId': (<class 'str'>, True),'ClientSecret': (<class 'str'>, True), 'ConnectorOAuthRequest': (<class'troposphere.appflow.ConnectorOAuthRequest'>, False), 'RefreshToken': (<class'str'>, False)}

class troposphere.appflow.GoogleAnalyticsSourceProperties(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

GoogleAnalyticsSourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Object': (<class 'str'>, True)}

class troposphere.appflow.IncrementalPullConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

IncrementalPullConfig

7.3. troposphere 69

Page 74: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DatetimeTypeFieldName': (<class 'str'>, False)}

class troposphere.appflow.InforNexusConnectorProfileCredentials(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

InforNexusConnectorProfileCredentials

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessKeyId': (<class 'str'>, True), 'Datakey': (<class 'str'>, True),'SecretAccessKey': (<class 'str'>, True), 'UserId': (<class 'str'>, True)}

class troposphere.appflow.InforNexusConnectorProfileProperties(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

InforNexusConnectorProfileProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InstanceUrl': (<class 'str'>, True)}

class troposphere.appflow.InforNexusSourceProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InforNexusSourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Object': (<class 'str'>, True)}

class troposphere.appflow.LookoutMetricsDestinationProperties(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

LookoutMetricsDestinationProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Object': (<class 'str'>, False)}

class troposphere.appflow.MarketoConnectorProfileCredentials(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

MarketoConnectorProfileCredentials

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessToken': (<class 'str'>, False), 'ClientId': (<class 'str'>, True),'ClientSecret': (<class 'str'>, True), 'ConnectorOAuthRequest': (<class'troposphere.appflow.ConnectorOAuthRequest'>, False)}

class troposphere.appflow.MarketoConnectorProfileProperties(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

MarketoConnectorProfileProperties

70 Chapter 7. Licensing

Page 75: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InstanceUrl': (<class 'str'>, True)}

class troposphere.appflow.MarketoDestinationProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MarketoDestinationProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ErrorHandlingConfig': (<class 'troposphere.appflow.ErrorHandlingConfig'>, False),'Object': (<class 'str'>, True)}

class troposphere.appflow.MarketoSourceProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MarketoSourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Object': (<class 'str'>, True)}

class troposphere.appflow.OAuthProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OAuthProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthCodeUrl': (<class 'str'>, False), 'OAuthScopes': ([<class 'str'>], False),'TokenUrl': (<class 'str'>, False)}

class troposphere.appflow.PrefixConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PrefixConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PrefixFormat': (<class 'str'>, False), 'PrefixType': (<class 'str'>, False)}

class troposphere.appflow.RedshiftConnectorProfileCredentials(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

RedshiftConnectorProfileCredentials

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Password': (<class 'str'>, True), 'Username': (<class 'str'>, True)}

class troposphere.appflow.RedshiftConnectorProfileProperties(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

RedshiftConnectorProfileProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketName': (<class 'str'>, True), 'BucketPrefix': (<class 'str'>, False),'DatabaseUrl': (<class 'str'>, True), 'RoleArn': (<class 'str'>, True)}

7.3. troposphere 71

Page 76: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.appflow.RedshiftDestinationProperties(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

RedshiftDestinationProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketPrefix': (<class 'str'>, False), 'ErrorHandlingConfig': (<class'troposphere.appflow.ErrorHandlingConfig'>, False), 'IntermediateBucketName':(<class 'str'>, True), 'Object': (<class 'str'>, True)}

class troposphere.appflow.S3DestinationProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3DestinationProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketName': (<class 'str'>, True), 'BucketPrefix': (<class 'str'>, False),'S3OutputFormatConfig': (<class 'troposphere.appflow.S3OutputFormatConfig'>,False)}

class troposphere.appflow.S3InputFormatConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3InputFormatConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'S3InputFileType': (<class 'str'>, False)}

class troposphere.appflow.S3OutputFormatConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3OutputFormatConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AggregationConfig': (<class 'troposphere.appflow.AggregationConfig'>, False),'FileType': (<class 'str'>, False), 'PrefixConfig': (<class'troposphere.appflow.PrefixConfig'>, False)}

class troposphere.appflow.S3SourceProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3SourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketName': (<class 'str'>, True), 'BucketPrefix': (<class 'str'>, True),'S3InputFormatConfig': (<class 'troposphere.appflow.S3InputFormatConfig'>, False)}

class troposphere.appflow.SAPODataConnectorProfileCredentials(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

SAPODataConnectorProfileCredentials

72 Chapter 7. Licensing

Page 77: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BasicAuthCredentials': (<class 'dict'>, False), 'OAuthCredentials': (<class'dict'>, False)}

class troposphere.appflow.SAPODataConnectorProfileProperties(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

SAPODataConnectorProfileProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationHostUrl': (<class 'str'>, False), 'ApplicationServicePath': (<class'str'>, False), 'ClientNumber': (<class 'str'>, False), 'LogonLanguage': (<class'str'>, False), 'OAuthProperties': (<class 'troposphere.appflow.OAuthProperties'>,False), 'PortNumber': (<function integer>, False), 'PrivateLinkServiceName':(<class 'str'>, False)}

class troposphere.appflow.SAPODataDestinationProperties(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

SAPODataDestinationProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ErrorHandlingConfig': (<class 'troposphere.appflow.ErrorHandlingConfig'>, False),'IdFieldNames': ([<class 'str'>], False), 'ObjectPath': (<class 'str'>, True),'SuccessResponseHandlingConfig': (<class'troposphere.appflow.SuccessResponseHandlingConfig'>, False), 'WriteOperationType':(<class 'str'>, False)}

class troposphere.appflow.SAPODataSourceProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SAPODataSourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ObjectPath': (<class 'str'>, True)}

class troposphere.appflow.SalesforceConnectorProfileCredentials(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

SalesforceConnectorProfileCredentials

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessToken': (<class 'str'>, False), 'ClientCredentialsArn': (<class 'str'>,False), 'ConnectorOAuthRequest': (<class'troposphere.appflow.ConnectorOAuthRequest'>, False), 'RefreshToken': (<class'str'>, False)}

class troposphere.appflow.SalesforceConnectorProfileProperties(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

SalesforceConnectorProfileProperties

7.3. troposphere 73

Page 78: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InstanceUrl': (<class 'str'>, False), 'isSandboxEnvironment': (<functionboolean>, False)}

class troposphere.appflow.SalesforceDestinationProperties(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

SalesforceDestinationProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ErrorHandlingConfig': (<class 'troposphere.appflow.ErrorHandlingConfig'>, False),'IdFieldNames': ([<class 'str'>], False), 'Object': (<class 'str'>, True),'WriteOperationType': (<class 'str'>, False)}

class troposphere.appflow.SalesforceSourceProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SalesforceSourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EnableDynamicFieldUpdate': (<function boolean>, False), 'IncludeDeletedRecords':(<function boolean>, False), 'Object': (<class 'str'>, True)}

class troposphere.appflow.ScheduledTriggerProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ScheduledTriggerProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DataPullMode': (<class 'str'>, False), 'ScheduleEndTime': (<function double>,False), 'ScheduleExpression': (<class 'str'>, True), 'ScheduleOffset': (<functiondouble>, False), 'ScheduleStartTime': (<function double>, False), 'TimeZone':(<class 'str'>, False)}

class troposphere.appflow.ServiceNowConnectorProfileCredentials(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ServiceNowConnectorProfileCredentials

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Password': (<class 'str'>, True), 'Username': (<class 'str'>, True)}

class troposphere.appflow.ServiceNowConnectorProfileProperties(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ServiceNowConnectorProfileProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InstanceUrl': (<class 'str'>, True)}

class troposphere.appflow.ServiceNowSourceProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

74 Chapter 7. Licensing

Page 79: Release 3.1

troposphere Documentation, Release 4.0.1

ServiceNowSourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Object': (<class 'str'>, True)}

class troposphere.appflow.SingularConnectorProfileCredentials(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

SingularConnectorProfileCredentials

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiKey': (<class 'str'>, True)}

class troposphere.appflow.SingularSourceProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SingularSourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Object': (<class 'str'>, True)}

class troposphere.appflow.SlackConnectorProfileCredentials(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

SlackConnectorProfileCredentials

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessToken': (<class 'str'>, False), 'ClientId': (<class 'str'>, True),'ClientSecret': (<class 'str'>, True), 'ConnectorOAuthRequest': (<class'troposphere.appflow.ConnectorOAuthRequest'>, False)}

class troposphere.appflow.SlackConnectorProfileProperties(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

SlackConnectorProfileProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InstanceUrl': (<class 'str'>, True)}

class troposphere.appflow.SlackSourceProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SlackSourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Object': (<class 'str'>, True)}

class troposphere.appflow.SnowflakeConnectorProfileCredentials(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

SnowflakeConnectorProfileCredentials

7.3. troposphere 75

Page 80: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Password': (<class 'str'>, True), 'Username': (<class 'str'>, True)}

class troposphere.appflow.SnowflakeConnectorProfileProperties(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

SnowflakeConnectorProfileProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccountName': (<class 'str'>, False), 'BucketName': (<class 'str'>, True),'BucketPrefix': (<class 'str'>, False), 'PrivateLinkServiceName': (<class 'str'>,False), 'Region': (<class 'str'>, False), 'Stage': (<class 'str'>, True),'Warehouse': (<class 'str'>, True)}

class troposphere.appflow.SnowflakeDestinationProperties(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

SnowflakeDestinationProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketPrefix': (<class 'str'>, False), 'ErrorHandlingConfig': (<class'troposphere.appflow.ErrorHandlingConfig'>, False), 'IntermediateBucketName':(<class 'str'>, True), 'Object': (<class 'str'>, True)}

class troposphere.appflow.SourceConnectorProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SourceConnectorProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Amplitude': (<class 'troposphere.appflow.AmplitudeSourceProperties'>, False),'Datadog': (<class 'troposphere.appflow.DatadogSourceProperties'>, False),'Dynatrace': (<class 'troposphere.appflow.DynatraceSourceProperties'>, False),'GoogleAnalytics': (<class 'troposphere.appflow.GoogleAnalyticsSourceProperties'>,False), 'InforNexus': (<class 'troposphere.appflow.InforNexusSourceProperties'>,False), 'Marketo': (<class 'troposphere.appflow.MarketoSourceProperties'>, False),'S3': (<class 'troposphere.appflow.S3SourceProperties'>, False), 'SAPOData':(<class 'troposphere.appflow.SAPODataSourceProperties'>, False), 'Salesforce':(<class 'troposphere.appflow.SalesforceSourceProperties'>, False), 'ServiceNow':(<class 'troposphere.appflow.ServiceNowSourceProperties'>, False), 'Singular':(<class 'troposphere.appflow.SingularSourceProperties'>, False), 'Slack': (<class'troposphere.appflow.SlackSourceProperties'>, False), 'Trendmicro': (<class'troposphere.appflow.TrendmicroSourceProperties'>, False), 'Veeva': (<class'troposphere.appflow.VeevaSourceProperties'>, False), 'Zendesk': (<class'troposphere.appflow.ZendeskSourceProperties'>, False)}

class troposphere.appflow.SourceFlowConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SourceFlowConfig

76 Chapter 7. Licensing

Page 81: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectorProfileName': (<class 'str'>, False), 'ConnectorType': (<class 'str'>,True), 'IncrementalPullConfig': (<class'troposphere.appflow.IncrementalPullConfig'>, False), 'SourceConnectorProperties':(<class 'troposphere.appflow.SourceConnectorProperties'>, True)}

class troposphere.appflow.SuccessResponseHandlingConfig(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

SuccessResponseHandlingConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketName': (<class 'str'>, False), 'BucketPrefix': (<class 'str'>, False)}

class troposphere.appflow.Task(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Task

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectorOperator': (<class 'troposphere.appflow.ConnectorOperator'>, False),'DestinationField': (<class 'str'>, False), 'SourceFields': ([<class 'str'>],True), 'TaskProperties': ([<class 'troposphere.appflow.TaskPropertiesObject'>],False), 'TaskType': (<class 'str'>, True)}

class troposphere.appflow.TaskPropertiesObject(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TaskPropertiesObject

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.appflow.TrendmicroConnectorProfileCredentials(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

TrendmicroConnectorProfileCredentials

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiSecretKey': (<class 'str'>, True)}

class troposphere.appflow.TrendmicroSourceProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TrendmicroSourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Object': (<class 'str'>, True)}

class troposphere.appflow.TriggerConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TriggerConfig

7.3. troposphere 77

Page 82: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TriggerProperties': (<class 'troposphere.appflow.ScheduledTriggerProperties'>,False), 'TriggerType': (<class 'str'>, True)}

class troposphere.appflow.UpsolverDestinationProperties(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

UpsolverDestinationProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketName': (<class 'str'>, True), 'BucketPrefix': (<class 'str'>, False),'S3OutputFormatConfig': (<class'troposphere.appflow.UpsolverS3OutputFormatConfig'>, True)}

class troposphere.appflow.UpsolverS3OutputFormatConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

UpsolverS3OutputFormatConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AggregationConfig': (<class 'troposphere.appflow.AggregationConfig'>, False),'FileType': (<class 'str'>, False), 'PrefixConfig': (<class'troposphere.appflow.PrefixConfig'>, True)}

class troposphere.appflow.VeevaConnectorProfileCredentials(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

VeevaConnectorProfileCredentials

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Password': (<class 'str'>, True), 'Username': (<class 'str'>, True)}

class troposphere.appflow.VeevaConnectorProfileProperties(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

VeevaConnectorProfileProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InstanceUrl': (<class 'str'>, True)}

class troposphere.appflow.VeevaSourceProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VeevaSourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DocumentType': (<class 'str'>, False), 'IncludeAllVersions': (<functionboolean>, False), 'IncludeRenditions': (<function boolean>, False),'IncludeSourceFiles': (<function boolean>, False), 'Object': (<class 'str'>,True)}

78 Chapter 7. Licensing

Page 83: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.appflow.ZendeskConnectorProfileCredentials(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ZendeskConnectorProfileCredentials

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessToken': (<class 'str'>, False), 'ClientId': (<class 'str'>, True),'ClientSecret': (<class 'str'>, True), 'ConnectorOAuthRequest': (<class'troposphere.appflow.ConnectorOAuthRequest'>, False)}

class troposphere.appflow.ZendeskConnectorProfileProperties(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ZendeskConnectorProfileProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InstanceUrl': (<class 'str'>, True)}

class troposphere.appflow.ZendeskDestinationProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ZendeskDestinationProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ErrorHandlingConfig': (<class 'troposphere.appflow.ErrorHandlingConfig'>, False),'IdFieldNames': ([<class 'str'>], False), 'Object': (<class 'str'>, True),'WriteOperationType': (<class 'str'>, False)}

class troposphere.appflow.ZendeskSourceProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ZendeskSourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Object': (<class 'str'>, True)}

troposphere.appintegrations module

class troposphere.appintegrations.DataIntegration(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DataIntegration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'KmsKey': (<class 'str'>, True), 'Name':(<class 'str'>, True), 'ScheduleConfig': (<class'troposphere.appintegrations.ScheduleConfig'>, True), 'SourceURI': (<class 'str'>,True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::AppIntegrations::DataIntegration'

7.3. troposphere 79

Page 84: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.appintegrations.EventFilter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EventFilter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Source': (<class 'str'>, True)}

class troposphere.appintegrations.EventIntegration(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

EventIntegration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'EventBridgeBus': (<class 'str'>, True),'EventFilter': (<class 'troposphere.appintegrations.EventFilter'>, True), 'Name':(<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::AppIntegrations::EventIntegration'

class troposphere.appintegrations.ScheduleConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ScheduleConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FirstExecutionFrom': (<class 'str'>, True), 'Object': (<class 'str'>, True),'ScheduleExpression': (<class 'str'>, True)}

troposphere.applicationautoscaling module

class troposphere.applicationautoscaling.CustomizedMetricSpecification(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

CustomizedMetricSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Dimensions': ([<class 'troposphere.applicationautoscaling.MetricDimension'>],False), 'MetricName': (<class 'str'>, True), 'Namespace': (<class 'str'>, True),'Statistic': (<class 'str'>, True), 'Unit': (<class 'str'>, False)}

class troposphere.applicationautoscaling.MetricDimension(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

MetricDimension

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.applicationautoscaling.PredefinedMetricSpecification(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

80 Chapter 7. Licensing

Page 85: Release 3.1

troposphere Documentation, Release 4.0.1

PredefinedMetricSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PredefinedMetricType': (<class 'str'>, True), 'ResourceLabel': (<class 'str'>,False)}

class troposphere.applicationautoscaling.ScalableTarget(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ScalableTarget

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxCapacity': (<function integer>, True), 'MinCapacity': (<function integer>,True), 'ResourceId': (<class 'str'>, True), 'RoleARN': (<class 'str'>, True),'ScalableDimension': (<class 'str'>, True), 'ScheduledActions': ([<class'troposphere.applicationautoscaling.ScheduledAction'>], False), 'ServiceNamespace':(<class 'str'>, True), 'SuspendedState': (<class'troposphere.applicationautoscaling.SuspendedState'>, False)}

resource_type: Optional[str] = 'AWS::ApplicationAutoScaling::ScalableTarget'

class troposphere.applicationautoscaling.ScalableTargetAction(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ScalableTargetAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxCapacity': (<function integer>, False), 'MinCapacity': (<function integer>,False)}

class troposphere.applicationautoscaling.ScalingPolicy(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ScalingPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PolicyName': (<class 'str'>, True), 'PolicyType': (<class 'str'>, True),'ResourceId': (<class 'str'>, False), 'ScalableDimension': (<class 'str'>, False),'ScalingTargetId': (<class 'str'>, False), 'ServiceNamespace': (<class 'str'>,False), 'StepScalingPolicyConfiguration': (<class'troposphere.applicationautoscaling.StepScalingPolicyConfiguration'>, False),'TargetTrackingScalingPolicyConfiguration': (<class'troposphere.applicationautoscaling.TargetTrackingScalingPolicyConfiguration'>,False)}

resource_type: Optional[str] = 'AWS::ApplicationAutoScaling::ScalingPolicy'

class troposphere.applicationautoscaling.ScheduledAction(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

ScheduledAction

7.3. troposphere 81

Page 86: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EndTime': (<class 'str'>, False), 'ScalableTargetAction': (<class'troposphere.applicationautoscaling.ScalableTargetAction'>, False), 'Schedule':(<class 'str'>, True), 'ScheduledActionName': (<class 'str'>, True), 'StartTime':(<class 'str'>, False), 'Timezone': (<class 'str'>, False)}

class troposphere.applicationautoscaling.StepAdjustment(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

StepAdjustment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MetricIntervalLowerBound': (<function double>, False),'MetricIntervalUpperBound': (<function double>, False), 'ScalingAdjustment':(<function integer>, True)}

class troposphere.applicationautoscaling.StepScalingPolicyConfiguration(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

StepScalingPolicyConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AdjustmentType': (<class 'str'>, False), 'Cooldown': (<function integer>,False), 'MetricAggregationType': (<class 'str'>, False), 'MinAdjustmentMagnitude':(<function integer>, False), 'StepAdjustments': ([<class'troposphere.applicationautoscaling.StepAdjustment'>], False)}

class troposphere.applicationautoscaling.SuspendedState(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

SuspendedState

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DynamicScalingInSuspended': (<function boolean>, False),'DynamicScalingOutSuspended': (<function boolean>, False),'ScheduledScalingSuspended': (<function boolean>, False)}

class troposphere.applicationautoscaling.TargetTrackingScalingPolicyConfiguration(title: Op-tional[str]= None,**kwargs:Any)

Bases: troposphere.AWSProperty

TargetTrackingScalingPolicyConfiguration

82 Chapter 7. Licensing

Page 87: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CustomizedMetricSpecification': (<class'troposphere.applicationautoscaling.CustomizedMetricSpecification'>, False),'DisableScaleIn': (<function boolean>, False), 'PredefinedMetricSpecification':(<class 'troposphere.applicationautoscaling.PredefinedMetricSpecification'>, False),'ScaleInCooldown': (<function integer>, False), 'ScaleOutCooldown': (<functioninteger>, False), 'TargetValue': (<function double>, True)}

troposphere.applicationinsights module

class troposphere.applicationinsights.Alarm(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Alarm

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AlarmName': (<class 'str'>, True), 'Severity': (<class 'str'>, False)}

class troposphere.applicationinsights.AlarmMetric(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AlarmMetric

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AlarmMetricName': (<class 'str'>, True)}

class troposphere.applicationinsights.Application(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Application

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoConfigurationEnabled': (<function boolean>, False), 'CWEMonitorEnabled':(<function boolean>, False), 'ComponentMonitoringSettings': ([<class'troposphere.applicationinsights.ComponentMonitoringSetting'>], False),'CustomComponents': ([<class 'troposphere.applicationinsights.CustomComponent'>],False), 'LogPatternSets': ([<class'troposphere.applicationinsights.LogPatternSet'>], False), 'OpsCenterEnabled':(<function boolean>, False), 'OpsItemSNSTopicArn': (<class 'str'>, False),'ResourceGroupName': (<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>,False)}

resource_type: Optional[str] = 'AWS::ApplicationInsights::Application'

class troposphere.applicationinsights.ComponentConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ComponentConfiguration

7.3. troposphere 83

Page 88: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConfigurationDetails': (<class'troposphere.applicationinsights.ConfigurationDetails'>, False),'SubComponentTypeConfigurations': ([<class'troposphere.applicationinsights.SubComponentTypeConfiguration'>], False)}

class troposphere.applicationinsights.ComponentMonitoringSetting(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ComponentMonitoringSetting

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComponentARN': (<class 'str'>, False), 'ComponentConfigurationMode': (<class'str'>, True), 'ComponentName': (<class 'str'>, False),'CustomComponentConfiguration': (<class'troposphere.applicationinsights.ComponentConfiguration'>, False),'DefaultOverwriteComponentConfiguration': (<class'troposphere.applicationinsights.ComponentConfiguration'>, False), 'Tier': (<class'str'>, True)}

class troposphere.applicationinsights.ConfigurationDetails(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

ConfigurationDetails

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AlarmMetrics': ([<class 'troposphere.applicationinsights.AlarmMetric'>], False),'Alarms': ([<class 'troposphere.applicationinsights.Alarm'>], False),'HAClusterPrometheusExporter': (<class'troposphere.applicationinsights.HAClusterPrometheusExporter'>, False),'HANAPrometheusExporter': (<class'troposphere.applicationinsights.HANAPrometheusExporter'>, False),'JMXPrometheusExporter': (<class'troposphere.applicationinsights.JMXPrometheusExporter'>, False), 'Logs': ([<class'troposphere.applicationinsights.Log'>], False), 'WindowsEvents': ([<class'troposphere.applicationinsights.WindowsEvent'>], False)}

class troposphere.applicationinsights.CustomComponent(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CustomComponent

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComponentName': (<class 'str'>, True), 'ResourceList': ([<class 'str'>], True)}

class troposphere.applicationinsights.HAClusterPrometheusExporter(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

HAClusterPrometheusExporter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PrometheusPort': (<class 'str'>, False)}

84 Chapter 7. Licensing

Page 89: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.applicationinsights.HANAPrometheusExporter(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

HANAPrometheusExporter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AgreeToInstallHANADBClient': (<function boolean>, True), 'HANAPort': (<class'str'>, True), 'HANASID': (<class 'str'>, True), 'HANASecretName': (<class 'str'>,True), 'PrometheusPort': (<class 'str'>, False)}

class troposphere.applicationinsights.JMXPrometheusExporter(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

JMXPrometheusExporter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HostPort': (<class 'str'>, False), 'JMXURL': (<class 'str'>, False),'PrometheusPort': (<class 'str'>, False)}

class troposphere.applicationinsights.Log(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Log

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Encoding': (<class 'str'>, False), 'LogGroupName': (<class 'str'>, False),'LogPath': (<class 'str'>, False), 'LogType': (<class 'str'>, True), 'PatternSet':(<class 'str'>, False)}

class troposphere.applicationinsights.LogPattern(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LogPattern

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Pattern': (<class 'str'>, True), 'PatternName': (<class 'str'>, True), 'Rank':(<function integer>, True)}

class troposphere.applicationinsights.LogPatternSet(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LogPatternSet

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LogPatterns': ([<class 'troposphere.applicationinsights.LogPattern'>], True),'PatternSetName': (<class 'str'>, True)}

class troposphere.applicationinsights.SubComponentConfigurationDetails(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

SubComponentConfigurationDetails

7.3. troposphere 85

Page 90: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AlarmMetrics': ([<class 'troposphere.applicationinsights.AlarmMetric'>], False),'Logs': ([<class 'troposphere.applicationinsights.Log'>], False), 'WindowsEvents':([<class 'troposphere.applicationinsights.WindowsEvent'>], False)}

class troposphere.applicationinsights.SubComponentTypeConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

SubComponentTypeConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SubComponentConfigurationDetails': (<class'troposphere.applicationinsights.SubComponentConfigurationDetails'>, True),'SubComponentType': (<class 'str'>, True)}

class troposphere.applicationinsights.WindowsEvent(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

WindowsEvent

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EventLevels': ([<class 'str'>], True), 'EventName': (<class 'str'>, True),'LogGroupName': (<class 'str'>, True), 'PatternSet': (<class 'str'>, False)}

troposphere.appmesh module

class troposphere.appmesh.AccessLog(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AccessLog

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'File': (<class 'troposphere.appmesh.FileAccessLog'>, False)}

class troposphere.appmesh.AwsCloudMapInstanceAttribute(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AwsCloudMapInstanceAttribute

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.appmesh.AwsCloudMapServiceDiscovery(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AwsCloudMapServiceDiscovery

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Attributes': ([<class 'troposphere.appmesh.AwsCloudMapInstanceAttribute'>],False), 'NamespaceName': (<class 'str'>, True), 'ServiceName': (<class 'str'>,True)}

86 Chapter 7. Licensing

Page 91: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.appmesh.Backend(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Backend

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'VirtualService': (<class 'troposphere.appmesh.VirtualServiceBackend'>, False)}

class troposphere.appmesh.BackendDefaults(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BackendDefaults

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClientPolicy': (<class 'troposphere.appmesh.ClientPolicy'>, False)}

class troposphere.appmesh.ClientPolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ClientPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'TLS':(<class 'troposphere.appmesh.ClientPolicyTls'>, False)}

class troposphere.appmesh.ClientPolicyTls(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ClientPolicyTls

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Certificate': (<class 'troposphere.appmesh.ClientTlsCertificate'>, False),'Enforce': (<function boolean>, False), 'Ports': ([<function integer>], False),'Validation': (<class 'troposphere.appmesh.TlsValidationContext'>, True)}

class troposphere.appmesh.ClientTlsCertificate(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ClientTlsCertificate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'File': (<class 'troposphere.appmesh.ListenerTlsFileCertificate'>, False), 'SDS':(<class 'troposphere.appmesh.ListenerTlsSdsCertificate'>, False)}

class troposphere.appmesh.DnsServiceDiscovery(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DnsServiceDiscovery

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Hostname': (<class 'str'>, True), 'ResponseType': (<class 'str'>, False)}

class troposphere.appmesh.Duration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Duration

7.3. troposphere 87

Page 92: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Unit': (<class 'str'>, True), 'Value': (<function integer>, True)}

class troposphere.appmesh.EgressFilter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EgressFilter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Type': (<class 'str'>, True)}

class troposphere.appmesh.FileAccessLog(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FileAccessLog

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Path': (<class 'str'>, True)}

class troposphere.appmesh.GatewayRoute(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

GatewayRoute

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GatewayRouteName': (<class 'str'>, False), 'MeshName': (<class 'str'>, True),'MeshOwner': (<class 'str'>, False), 'Spec': (<class'troposphere.appmesh.GatewayRouteSpec'>, True), 'Tags': (<class'troposphere.Tags'>, False), 'VirtualGatewayName': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::AppMesh::GatewayRoute'

class troposphere.appmesh.GatewayRouteHostnameMatch(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GatewayRouteHostnameMatch

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Exact': (<class 'str'>, False), 'Suffix': (<class 'str'>, False)}

class troposphere.appmesh.GatewayRouteHostnameRewrite(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GatewayRouteHostnameRewrite

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DefaultTargetHostname': (<class 'str'>, False)}

class troposphere.appmesh.GatewayRouteMetadataMatch(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GatewayRouteMetadataMatch

88 Chapter 7. Licensing

Page 93: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Exact': (<class 'str'>, False), 'Prefix': (<class 'str'>, False), 'Range':(<class 'troposphere.appmesh.GatewayRouteRangeMatch'>, False), 'Regex': (<class'str'>, False), 'Suffix': (<class 'str'>, False)}

class troposphere.appmesh.GatewayRouteRangeMatch(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GatewayRouteRangeMatch

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'End':(<function integer>, True), 'Start': (<function integer>, True)}

class troposphere.appmesh.GatewayRouteSpec(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GatewayRouteSpec

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GrpcRoute': (<class 'troposphere.appmesh.GrpcGatewayRoute'>, False),'Http2Route': (<class 'troposphere.appmesh.HttpGatewayRoute'>, False), 'HttpRoute':(<class 'troposphere.appmesh.HttpGatewayRoute'>, False), 'Priority': (<functioninteger>, False)}

class troposphere.appmesh.GatewayRouteTarget(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GatewayRouteTarget

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'VirtualService': (<class 'troposphere.appmesh.GatewayRouteVirtualService'>,True)}

class troposphere.appmesh.GatewayRouteVirtualService(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GatewayRouteVirtualService

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'VirtualServiceName': (<class 'str'>, True)}

class troposphere.appmesh.GrpcGatewayRoute(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GrpcGatewayRoute

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Action': (<class 'troposphere.appmesh.GrpcGatewayRouteAction'>, True), 'Match':(<class 'troposphere.appmesh.GrpcGatewayRouteMatch'>, True)}

class troposphere.appmesh.GrpcGatewayRouteAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GrpcGatewayRouteAction

7.3. troposphere 89

Page 94: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Rewrite': (<class 'troposphere.appmesh.GrpcGatewayRouteRewrite'>, False),'Target': (<class 'troposphere.appmesh.GatewayRouteTarget'>, True)}

class troposphere.appmesh.GrpcGatewayRouteMatch(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GrpcGatewayRouteMatch

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Hostname': (<class 'troposphere.appmesh.GatewayRouteHostnameMatch'>, False),'Metadata': ([<class 'troposphere.appmesh.GrpcGatewayRouteMetadata'>], False),'ServiceName': (<class 'str'>, False)}

class troposphere.appmesh.GrpcGatewayRouteMetadata(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GrpcGatewayRouteMetadata

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Invert': (<function boolean>, False), 'Match': (<class'troposphere.appmesh.GatewayRouteMetadataMatch'>, False), 'Name': (<class 'str'>,True)}

class troposphere.appmesh.GrpcGatewayRouteRewrite(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GrpcGatewayRouteRewrite

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Hostname': (<class 'troposphere.appmesh.GatewayRouteHostnameRewrite'>, False)}

class troposphere.appmesh.GrpcRetryPolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GrpcRetryPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GrpcRetryEvents': ([<class 'str'>], False), 'HttpRetryEvents': ([<class 'str'>],False), 'MaxRetries': (<function integer>, True), 'PerRetryTimeout': (<class'troposphere.appmesh.Duration'>, True), 'TcpRetryEvents': ([<class 'str'>], False)}

class troposphere.appmesh.GrpcRoute(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GrpcRoute

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Action': (<class 'troposphere.appmesh.GrpcRouteAction'>, True), 'Match': (<class'troposphere.appmesh.GrpcRouteMatch'>, True), 'RetryPolicy': (<class'troposphere.appmesh.GrpcRetryPolicy'>, False), 'Timeout': (<class'troposphere.appmesh.GrpcTimeout'>, False)}

class troposphere.appmesh.GrpcRouteAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

90 Chapter 7. Licensing

Page 95: Release 3.1

troposphere Documentation, Release 4.0.1

GrpcRouteAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'WeightedTargets': ([<class 'troposphere.appmesh.WeightedTarget'>], True)}

class troposphere.appmesh.GrpcRouteMatch(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GrpcRouteMatch

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Metadata': ([<class 'troposphere.appmesh.GrpcRouteMetadata'>], False),'MethodName': (<class 'str'>, False), 'ServiceName': (<class 'str'>, False)}

class troposphere.appmesh.GrpcRouteMetadata(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GrpcRouteMetadata

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Invert': (<function boolean>, False), 'Match': (<class'troposphere.appmesh.GrpcRouteMetadataMatchMethod'>, False), 'Name': (<class'str'>, True)}

class troposphere.appmesh.GrpcRouteMetadataMatchMethod(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GrpcRouteMetadataMatchMethod

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Exact': (<class 'str'>, False), 'Prefix': (<class 'str'>, False), 'Range':(<class 'troposphere.appmesh.MatchRange'>, False), 'Regex': (<class 'str'>, False),'Suffix': (<class 'str'>, False)}

class troposphere.appmesh.GrpcTimeout(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GrpcTimeout

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Idle': (<class 'troposphere.appmesh.Duration'>, False), 'PerRequest': (<class'troposphere.appmesh.Duration'>, False)}

class troposphere.appmesh.HeaderMatchMethod(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HeaderMatchMethod

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Exact': (<class 'str'>, False), 'Prefix': (<class 'str'>, False), 'Range':(<class 'troposphere.appmesh.MatchRange'>, False), 'Regex': (<class 'str'>, False),'Suffix': (<class 'str'>, False)}

class troposphere.appmesh.HealthCheck(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 91

Page 96: Release 3.1

troposphere Documentation, Release 4.0.1

HealthCheck

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HealthyThreshold': (<function integer>, True), 'IntervalMillis': (<functioninteger>, True), 'Path': (<class 'str'>, False), 'Port': (<function integer>,False), 'Protocol': (<class 'str'>, True), 'TimeoutMillis': (<function integer>,True), 'UnhealthyThreshold': (<function integer>, True)}

class troposphere.appmesh.HttpGatewayRoute(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpGatewayRoute

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Action': (<class 'troposphere.appmesh.HttpGatewayRouteAction'>, True), 'Match':(<class 'troposphere.appmesh.HttpGatewayRouteMatch'>, True)}

class troposphere.appmesh.HttpGatewayRouteAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpGatewayRouteAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Rewrite': (<class 'troposphere.appmesh.HttpGatewayRouteRewrite'>, False),'Target': (<class 'troposphere.appmesh.GatewayRouteTarget'>, True)}

class troposphere.appmesh.HttpGatewayRouteHeader(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpGatewayRouteHeader

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Invert': (<function boolean>, False), 'Match': (<class'troposphere.appmesh.HttpGatewayRouteHeaderMatch'>, False), 'Name': (<class 'str'>,True)}

class troposphere.appmesh.HttpGatewayRouteHeaderMatch(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpGatewayRouteHeaderMatch

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Exact': (<class 'str'>, False), 'Prefix': (<class 'str'>, False), 'Range':(<class 'troposphere.appmesh.GatewayRouteRangeMatch'>, False), 'Regex': (<class'str'>, False), 'Suffix': (<class 'str'>, False)}

class troposphere.appmesh.HttpGatewayRouteMatch(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpGatewayRouteMatch

92 Chapter 7. Licensing

Page 97: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Headers': ([<class 'troposphere.appmesh.HttpGatewayRouteHeader'>], False),'Hostname': (<class 'troposphere.appmesh.GatewayRouteHostnameMatch'>, False),'Method': (<class 'str'>, False), 'Path': (<class'troposphere.appmesh.HttpPathMatch'>, False), 'Prefix': (<class 'str'>, False),'QueryParameters': ([<class 'troposphere.appmesh.QueryParameter'>], False)}

class troposphere.appmesh.HttpGatewayRoutePathRewrite(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpGatewayRoutePathRewrite

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Exact': (<class 'str'>, False)}

class troposphere.appmesh.HttpGatewayRoutePrefixRewrite(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

HttpGatewayRoutePrefixRewrite

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DefaultPrefix': (<class 'str'>, False), 'Value': (<class 'str'>, False)}

class troposphere.appmesh.HttpGatewayRouteRewrite(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpGatewayRouteRewrite

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Hostname': (<class 'troposphere.appmesh.GatewayRouteHostnameRewrite'>, False),'Path': (<class 'troposphere.appmesh.HttpGatewayRoutePathRewrite'>, False),'Prefix': (<class 'troposphere.appmesh.HttpGatewayRoutePrefixRewrite'>, False)}

class troposphere.appmesh.HttpPathMatch(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpPathMatch

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Exact': (<class 'str'>, False), 'Regex': (<class 'str'>, False)}

class troposphere.appmesh.HttpQueryParameterMatch(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpQueryParameterMatch

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Exact': (<class 'str'>, False)}

class troposphere.appmesh.HttpRetryPolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpRetryPolicy

7.3. troposphere 93

Page 98: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HttpRetryEvents': ([<class 'str'>], False), 'MaxRetries': (<function integer>,True), 'PerRetryTimeout': (<class 'troposphere.appmesh.Duration'>, True),'TcpRetryEvents': ([<class 'str'>], False)}

class troposphere.appmesh.HttpRoute(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpRoute

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Action': (<class 'troposphere.appmesh.HttpRouteAction'>, True), 'Match': (<class'troposphere.appmesh.HttpRouteMatch'>, True), 'RetryPolicy': (<class'troposphere.appmesh.HttpRetryPolicy'>, False), 'Timeout': (<class'troposphere.appmesh.HttpTimeout'>, False)}

class troposphere.appmesh.HttpRouteAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpRouteAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'WeightedTargets': ([<class 'troposphere.appmesh.WeightedTarget'>], True)}

class troposphere.appmesh.HttpRouteHeader(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpRouteHeader

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Invert': (<function boolean>, False), 'Match': (<class'troposphere.appmesh.HeaderMatchMethod'>, False), 'Name': (<class 'str'>, True)}

class troposphere.appmesh.HttpRouteMatch(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpRouteMatch

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Headers': ([<class 'troposphere.appmesh.HttpRouteHeader'>], False), 'Method':(<class 'str'>, False), 'Path': (<class 'troposphere.appmesh.HttpPathMatch'>,False), 'Prefix': (<class 'str'>, False), 'QueryParameters': ([<class'troposphere.appmesh.QueryParameter'>], False), 'Scheme': (<class 'str'>, False)}

class troposphere.appmesh.HttpTimeout(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpTimeout

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Idle': (<class 'troposphere.appmesh.Duration'>, False), 'PerRequest': (<class'troposphere.appmesh.Duration'>, False)}

class troposphere.appmesh.Listener(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

94 Chapter 7. Licensing

Page 99: Release 3.1

troposphere Documentation, Release 4.0.1

Listener

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectionPool': (<class 'troposphere.appmesh.VirtualNodeConnectionPool'>,False), 'HealthCheck': (<class 'troposphere.appmesh.HealthCheck'>, False),'OutlierDetection': (<class 'troposphere.appmesh.OutlierDetection'>, False),'PortMapping': (<class 'troposphere.appmesh.PortMapping'>, True), 'TLS': (<class'troposphere.appmesh.ListenerTls'>, False), 'Timeout': (<class'troposphere.appmesh.ListenerTimeout'>, False)}

class troposphere.appmesh.ListenerTimeout(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ListenerTimeout

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GRPC': (<class 'troposphere.appmesh.GrpcTimeout'>, False), 'HTTP': (<class'troposphere.appmesh.HttpTimeout'>, False), 'HTTP2': (<class'troposphere.appmesh.HttpTimeout'>, False), 'TCP': (<class'troposphere.appmesh.TcpTimeout'>, False)}

class troposphere.appmesh.ListenerTls(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ListenerTls

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Certificate': (<class 'troposphere.appmesh.ListenerTlsCertificate'>, True),'Mode': (<function validate_listenertls_mode>, True), 'Validation': (<class'troposphere.appmesh.ListenerTlsValidationContext'>, False)}

class troposphere.appmesh.ListenerTlsAcmCertificate(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ListenerTlsAcmCertificate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateArn': (<class 'str'>, True)}

class troposphere.appmesh.ListenerTlsCertificate(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ListenerTlsCertificate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'ACM':(<class 'troposphere.appmesh.ListenerTlsAcmCertificate'>, False), 'File': (<class'troposphere.appmesh.ListenerTlsFileCertificate'>, False), 'SDS': (<class'troposphere.appmesh.ListenerTlsSdsCertificate'>, False)}

class troposphere.appmesh.ListenerTlsFileCertificate(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ListenerTlsFileCertificate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateChain': (<class 'str'>, True), 'PrivateKey': (<class 'str'>, True)}

7.3. troposphere 95

Page 100: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.appmesh.ListenerTlsSdsCertificate(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ListenerTlsSdsCertificate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SecretName': (<class 'str'>, True)}

class troposphere.appmesh.ListenerTlsValidationContext(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ListenerTlsValidationContext

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SubjectAlternativeNames': (<class 'troposphere.appmesh.SubjectAlternativeNames'>,False), 'Trust': (<class 'troposphere.appmesh.ListenerTlsValidationContextTrust'>,True)}

class troposphere.appmesh.ListenerTlsValidationContextTrust(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ListenerTlsValidationContextTrust

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'File': (<class 'troposphere.appmesh.TlsValidationContextFileTrust'>, False),'SDS': (<class 'troposphere.appmesh.TlsValidationContextSdsTrust'>, False)}

class troposphere.appmesh.Logging(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Logging

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessLog': (<class 'troposphere.appmesh.AccessLog'>, False)}

class troposphere.appmesh.MatchRange(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MatchRange

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'End':(<function integer>, True), 'Start': (<function integer>, True)}

class troposphere.appmesh.Mesh(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Mesh

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MeshName': (<class 'str'>, False), 'Spec': (<class'troposphere.appmesh.MeshSpec'>, False), 'Tags': (<class 'troposphere.Tags'>,False)}

resource_type: Optional[str] = 'AWS::AppMesh::Mesh'

96 Chapter 7. Licensing

Page 101: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.appmesh.MeshServiceDiscovery(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MeshServiceDiscovery

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {}

class troposphere.appmesh.MeshSpec(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MeshSpec

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EgressFilter': (<class 'troposphere.appmesh.EgressFilter'>, False)}

class troposphere.appmesh.OutlierDetection(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OutlierDetection

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BaseEjectionDuration': (<class 'troposphere.appmesh.Duration'>, True),'Interval': (<class 'troposphere.appmesh.Duration'>, True), 'MaxEjectionPercent':(<function integer>, True), 'MaxServerErrors': (<function integer>, True)}

class troposphere.appmesh.PortMapping(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PortMapping

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Port': (<function integer>, True), 'Protocol': (<class 'str'>, True)}

class troposphere.appmesh.QueryParameter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

QueryParameter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Match': (<class 'troposphere.appmesh.HttpQueryParameterMatch'>, False), 'Name':(<class 'str'>, True)}

class troposphere.appmesh.Route(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Route

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MeshName': (<class 'str'>, True), 'MeshOwner': (<class 'str'>, False),'RouteName': (<class 'str'>, False), 'Spec': (<class'troposphere.appmesh.RouteSpec'>, True), 'Tags': (<class 'troposphere.Tags'>,False), 'VirtualRouterName': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::AppMesh::Route'

7.3. troposphere 97

Page 102: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.appmesh.RouteSpec(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RouteSpec

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GrpcRoute': (<class 'troposphere.appmesh.GrpcRoute'>, False), 'Http2Route':(<class 'troposphere.appmesh.HttpRoute'>, False), 'HttpRoute': (<class'troposphere.appmesh.HttpRoute'>, False), 'Priority': (<function integer>, False),'TcpRoute': (<class 'troposphere.appmesh.TcpRoute'>, False)}

class troposphere.appmesh.ServiceDiscovery(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ServiceDiscovery

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AWSCloudMap': (<class 'troposphere.appmesh.AwsCloudMapServiceDiscovery'>, False),'DNS': (<class 'troposphere.appmesh.DnsServiceDiscovery'>, False)}

class troposphere.appmesh.SubjectAlternativeNameMatchers(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

SubjectAlternativeNameMatchers

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Exact': ([<class 'str'>], False)}

class troposphere.appmesh.SubjectAlternativeNames(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SubjectAlternativeNames

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Match': (<class 'troposphere.appmesh.SubjectAlternativeNameMatchers'>, True)}

class troposphere.appmesh.TcpRoute(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TcpRoute

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Action': (<class 'troposphere.appmesh.TcpRouteAction'>, True), 'Timeout':(<class 'troposphere.appmesh.TcpTimeout'>, False)}

class troposphere.appmesh.TcpRouteAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TcpRouteAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'WeightedTargets': ([<class 'troposphere.appmesh.WeightedTarget'>], True)}

class troposphere.appmesh.TcpTimeout(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

98 Chapter 7. Licensing

Page 103: Release 3.1

troposphere Documentation, Release 4.0.1

TcpTimeout

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Idle': (<class 'troposphere.appmesh.Duration'>, False)}

class troposphere.appmesh.TlsValidationContext(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TlsValidationContext

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SubjectAlternativeNames': (<class 'troposphere.appmesh.SubjectAlternativeNames'>,False), 'Trust': (<class 'troposphere.appmesh.TlsValidationContextTrust'>, True)}

class troposphere.appmesh.TlsValidationContextAcmTrust(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TlsValidationContextAcmTrust

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateAuthorityArns': ([<class 'str'>], True)}

class troposphere.appmesh.TlsValidationContextFileTrust(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

TlsValidationContextFileTrust

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateChain': (<class 'str'>, True)}

class troposphere.appmesh.TlsValidationContextSdsTrust(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TlsValidationContextSdsTrust

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SecretName': (<class 'str'>, True)}

class troposphere.appmesh.TlsValidationContextTrust(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TlsValidationContextTrust

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'ACM':(<class 'troposphere.appmesh.TlsValidationContextAcmTrust'>, False), 'File':(<class 'troposphere.appmesh.TlsValidationContextFileTrust'>, False), 'SDS': (<class'troposphere.appmesh.TlsValidationContextSdsTrust'>, False)}

class troposphere.appmesh.VirtualGateway(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VirtualGateway

7.3. troposphere 99

Page 104: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MeshName': (<class 'str'>, True), 'MeshOwner': (<class 'str'>, False), 'Spec':(<class 'troposphere.appmesh.VirtualGatewaySpec'>, True), 'Tags': (<class'troposphere.Tags'>, False), 'VirtualGatewayName': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::AppMesh::VirtualGateway'

class troposphere.appmesh.VirtualGatewayAccessLog(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VirtualGatewayAccessLog

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'File': (<class 'troposphere.appmesh.VirtualGatewayFileAccessLog'>, False)}

class troposphere.appmesh.VirtualGatewayBackendDefaults(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

VirtualGatewayBackendDefaults

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClientPolicy': (<class 'troposphere.appmesh.VirtualGatewayClientPolicy'>, False)}

class troposphere.appmesh.VirtualGatewayClientPolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VirtualGatewayClientPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'TLS':(<class 'troposphere.appmesh.VirtualGatewayClientPolicyTls'>, False)}

class troposphere.appmesh.VirtualGatewayClientPolicyTls(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

VirtualGatewayClientPolicyTls

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Certificate': (<class 'troposphere.appmesh.VirtualGatewayClientTlsCertificate'>,False), 'Enforce': (<function boolean>, False), 'Ports': ([<function integer>],False), 'Validation': (<class'troposphere.appmesh.VirtualGatewayTlsValidationContext'>, True)}

class troposphere.appmesh.VirtualGatewayClientTlsCertificate(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

VirtualGatewayClientTlsCertificate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'File': (<class 'troposphere.appmesh.VirtualGatewayListenerTlsFileCertificate'>,False), 'SDS': (<class'troposphere.appmesh.VirtualGatewayListenerTlsSdsCertificate'>, False)}

100 Chapter 7. Licensing

Page 105: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.appmesh.VirtualGatewayConnectionPool(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VirtualGatewayConnectionPool

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GRPC': (<class 'troposphere.appmesh.VirtualGatewayGrpcConnectionPool'>, False),'HTTP': (<class 'troposphere.appmesh.VirtualGatewayHttpConnectionPool'>, False),'HTTP2': (<class 'troposphere.appmesh.VirtualGatewayHttp2ConnectionPool'>, False)}

class troposphere.appmesh.VirtualGatewayFileAccessLog(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VirtualGatewayFileAccessLog

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Path': (<class 'str'>, True)}

class troposphere.appmesh.VirtualGatewayGrpcConnectionPool(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

VirtualGatewayGrpcConnectionPool

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxRequests': (<function integer>, True)}

class troposphere.appmesh.VirtualGatewayHealthCheckPolicy(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

VirtualGatewayHealthCheckPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HealthyThreshold': (<function integer>, True), 'IntervalMillis': (<functioninteger>, True), 'Path': (<class 'str'>, False), 'Port': (<function integer>,False), 'Protocol': (<class 'str'>, True), 'TimeoutMillis': (<function integer>,True), 'UnhealthyThreshold': (<function integer>, True)}

class troposphere.appmesh.VirtualGatewayHttp2ConnectionPool(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

VirtualGatewayHttp2ConnectionPool

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxRequests': (<function integer>, True)}

class troposphere.appmesh.VirtualGatewayHttpConnectionPool(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

VirtualGatewayHttpConnectionPool

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxConnections': (<function integer>, True), 'MaxPendingRequests': (<functioninteger>, False)}

7.3. troposphere 101

Page 106: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.appmesh.VirtualGatewayListener(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VirtualGatewayListener

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectionPool': (<class 'troposphere.appmesh.VirtualGatewayConnectionPool'>,False), 'HealthCheck': (<class'troposphere.appmesh.VirtualGatewayHealthCheckPolicy'>, False), 'PortMapping':(<class 'troposphere.appmesh.VirtualGatewayPortMapping'>, True), 'TLS': (<class'troposphere.appmesh.VirtualGatewayListenerTls'>, False)}

class troposphere.appmesh.VirtualGatewayListenerTls(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VirtualGatewayListenerTls

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Certificate': (<class'troposphere.appmesh.VirtualGatewayListenerTlsCertificate'>, True), 'Mode': (<class'str'>, True), 'Validation': (<class'troposphere.appmesh.VirtualGatewayListenerTlsValidationContext'>, False)}

class troposphere.appmesh.VirtualGatewayListenerTlsAcmCertificate(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

VirtualGatewayListenerTlsAcmCertificate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateArn': (<class 'str'>, True)}

class troposphere.appmesh.VirtualGatewayListenerTlsCertificate(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

VirtualGatewayListenerTlsCertificate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'ACM':(<class 'troposphere.appmesh.VirtualGatewayListenerTlsAcmCertificate'>, False),'File': (<class 'troposphere.appmesh.VirtualGatewayListenerTlsFileCertificate'>,False), 'SDS': (<class'troposphere.appmesh.VirtualGatewayListenerTlsSdsCertificate'>, False)}

class troposphere.appmesh.VirtualGatewayListenerTlsFileCertificate(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

VirtualGatewayListenerTlsFileCertificate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateChain': (<class 'str'>, True), 'PrivateKey': (<class 'str'>, True)}

class troposphere.appmesh.VirtualGatewayListenerTlsSdsCertificate(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

102 Chapter 7. Licensing

Page 107: Release 3.1

troposphere Documentation, Release 4.0.1

VirtualGatewayListenerTlsSdsCertificate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SecretName': (<class 'str'>, True)}

class troposphere.appmesh.VirtualGatewayListenerTlsValidationContext(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

VirtualGatewayListenerTlsValidationContext

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SubjectAlternativeNames': (<class 'troposphere.appmesh.SubjectAlternativeNames'>,False), 'Trust': (<class'troposphere.appmesh.VirtualGatewayListenerTlsValidationContextTrust'>, True)}

class troposphere.appmesh.VirtualGatewayListenerTlsValidationContextTrust(title: Optional[str]= None, **kwargs:Any)

Bases: troposphere.AWSProperty

VirtualGatewayListenerTlsValidationContextTrust

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'File': (<class'troposphere.appmesh.VirtualGatewayTlsValidationContextFileTrust'>, False), 'SDS':(<class 'troposphere.appmesh.VirtualGatewayTlsValidationContextSdsTrust'>, False)}

class troposphere.appmesh.VirtualGatewayLogging(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VirtualGatewayLogging

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessLog': (<class 'troposphere.appmesh.VirtualGatewayAccessLog'>, False)}

class troposphere.appmesh.VirtualGatewayPortMapping(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VirtualGatewayPortMapping

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Port': (<function integer>, True), 'Protocol': (<class 'str'>, True)}

class troposphere.appmesh.VirtualGatewaySpec(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VirtualGatewaySpec

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BackendDefaults': (<class 'troposphere.appmesh.VirtualGatewayBackendDefaults'>,False), 'Listeners': ([<class 'troposphere.appmesh.VirtualGatewayListener'>],True), 'Logging': (<class 'troposphere.appmesh.VirtualGatewayLogging'>, False)}

7.3. troposphere 103

Page 108: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.appmesh.VirtualGatewayTlsValidationContext(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

VirtualGatewayTlsValidationContext

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SubjectAlternativeNames': (<class 'troposphere.appmesh.SubjectAlternativeNames'>,False), 'Trust': (<class'troposphere.appmesh.VirtualGatewayTlsValidationContextTrust'>, True)}

class troposphere.appmesh.VirtualGatewayTlsValidationContextAcmTrust(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

VirtualGatewayTlsValidationContextAcmTrust

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateAuthorityArns': ([<class 'str'>], True)}

class troposphere.appmesh.VirtualGatewayTlsValidationContextFileTrust(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

VirtualGatewayTlsValidationContextFileTrust

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateChain': (<class 'str'>, True)}

class troposphere.appmesh.VirtualGatewayTlsValidationContextSdsTrust(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

VirtualGatewayTlsValidationContextSdsTrust

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SecretName': (<class 'str'>, True)}

class troposphere.appmesh.VirtualGatewayTlsValidationContextTrust(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

VirtualGatewayTlsValidationContextTrust

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'ACM':(<class 'troposphere.appmesh.VirtualGatewayTlsValidationContextAcmTrust'>, False),'File': (<class 'troposphere.appmesh.VirtualGatewayTlsValidationContextFileTrust'>,False), 'SDS': (<class'troposphere.appmesh.VirtualGatewayTlsValidationContextSdsTrust'>, False)}

class troposphere.appmesh.VirtualNode(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VirtualNode

104 Chapter 7. Licensing

Page 109: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MeshName': (<class 'str'>, True), 'MeshOwner': (<class 'str'>, False), 'Spec':(<class 'troposphere.appmesh.VirtualNodeSpec'>, True), 'Tags': (<class'troposphere.Tags'>, False), 'VirtualNodeName': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::AppMesh::VirtualNode'

class troposphere.appmesh.VirtualNodeConnectionPool(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VirtualNodeConnectionPool

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GRPC': (<class 'troposphere.appmesh.VirtualNodeGrpcConnectionPool'>, False),'HTTP': (<class 'troposphere.appmesh.VirtualNodeHttpConnectionPool'>, False),'HTTP2': (<class 'troposphere.appmesh.VirtualNodeHttp2ConnectionPool'>, False),'TCP': (<class 'troposphere.appmesh.VirtualNodeTcpConnectionPool'>, False)}

class troposphere.appmesh.VirtualNodeGrpcConnectionPool(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

VirtualNodeGrpcConnectionPool

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxRequests': (<function integer>, True)}

class troposphere.appmesh.VirtualNodeHttp2ConnectionPool(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

VirtualNodeHttp2ConnectionPool

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxRequests': (<function integer>, True)}

class troposphere.appmesh.VirtualNodeHttpConnectionPool(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

VirtualNodeHttpConnectionPool

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxConnections': (<function integer>, True), 'MaxPendingRequests': (<functioninteger>, False)}

class troposphere.appmesh.VirtualNodeServiceProvider(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VirtualNodeServiceProvider

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'VirtualNodeName': (<class 'str'>, True)}

class troposphere.appmesh.VirtualNodeSpec(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 105

Page 110: Release 3.1

troposphere Documentation, Release 4.0.1

VirtualNodeSpec

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BackendDefaults': (<class 'troposphere.appmesh.BackendDefaults'>, False),'Backends': ([<class 'troposphere.appmesh.Backend'>], False), 'Listeners':([<class 'troposphere.appmesh.Listener'>], False), 'Logging': (<class'troposphere.appmesh.Logging'>, False), 'ServiceDiscovery': (<class'troposphere.appmesh.ServiceDiscovery'>, False)}

class troposphere.appmesh.VirtualNodeTcpConnectionPool(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VirtualNodeTcpConnectionPool

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxConnections': (<function integer>, True)}

class troposphere.appmesh.VirtualRouter(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VirtualRouter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MeshName': (<class 'str'>, True), 'MeshOwner': (<class 'str'>, False), 'Spec':(<class 'troposphere.appmesh.VirtualRouterSpec'>, True), 'Tags': (<class'troposphere.Tags'>, False), 'VirtualRouterName': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::AppMesh::VirtualRouter'

class troposphere.appmesh.VirtualRouterListener(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VirtualRouterListener

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PortMapping': (<class 'troposphere.appmesh.PortMapping'>, True)}

class troposphere.appmesh.VirtualRouterServiceProvider(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VirtualRouterServiceProvider

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'VirtualRouterName': (<class 'str'>, True)}

class troposphere.appmesh.VirtualRouterSpec(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VirtualRouterSpec

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Listeners': ([<class 'troposphere.appmesh.VirtualRouterListener'>], True)}

class troposphere.appmesh.VirtualService(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

106 Chapter 7. Licensing

Page 111: Release 3.1

troposphere Documentation, Release 4.0.1

VirtualService

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MeshName': (<class 'str'>, True), 'MeshOwner': (<class 'str'>, False), 'Spec':(<class 'troposphere.appmesh.VirtualServiceSpec'>, True), 'Tags': (<class'troposphere.Tags'>, False), 'VirtualServiceName': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::AppMesh::VirtualService'

class troposphere.appmesh.VirtualServiceBackend(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VirtualServiceBackend

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClientPolicy': (<class 'troposphere.appmesh.ClientPolicy'>, False),'VirtualServiceName': (<class 'str'>, True)}

class troposphere.appmesh.VirtualServiceProvider(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VirtualServiceProvider

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'VirtualNode': (<class 'troposphere.appmesh.VirtualNodeServiceProvider'>, False),'VirtualRouter': (<class 'troposphere.appmesh.VirtualRouterServiceProvider'>,False)}

class troposphere.appmesh.VirtualServiceSpec(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VirtualServiceSpec

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Provider': (<class 'troposphere.appmesh.VirtualServiceProvider'>, False)}

class troposphere.appmesh.WeightedTarget(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

WeightedTarget

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'VirtualNode': (<class 'str'>, True), 'Weight': (<function integer>, True)}

troposphere.apprunner module

class troposphere.apprunner.AuthenticationConfiguration(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

AuthenticationConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessRoleArn': (<class 'str'>, False), 'ConnectionArn': (<class 'str'>, False)}

7.3. troposphere 107

Page 112: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.apprunner.CodeConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CodeConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CodeConfigurationValues': (<class'troposphere.apprunner.CodeConfigurationValues'>, False), 'ConfigurationSource':(<class 'str'>, True)}

class troposphere.apprunner.CodeConfigurationValues(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CodeConfigurationValues

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BuildCommand': (<class 'str'>, False), 'Port': (<class 'str'>, False),'Runtime': (<class 'str'>, True), 'RuntimeEnvironmentVariables': ([<class'troposphere.apprunner.KeyValuePair'>], False), 'StartCommand': (<class 'str'>,False)}

class troposphere.apprunner.CodeRepository(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CodeRepository

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CodeConfiguration': (<class 'troposphere.apprunner.CodeConfiguration'>, False),'RepositoryUrl': (<class 'str'>, True), 'SourceCodeVersion': (<class'troposphere.apprunner.SourceCodeVersion'>, True)}

class troposphere.apprunner.EgressConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EgressConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EgressType': (<class 'str'>, True), 'VpcConnectorArn': (<class 'str'>, False)}

class troposphere.apprunner.EncryptionConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EncryptionConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KmsKey': (<class 'str'>, True)}

class troposphere.apprunner.HealthCheckConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HealthCheckConfiguration

108 Chapter 7. Licensing

Page 113: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HealthyThreshold': (<function integer>, False), 'Interval': (<function integer>,False), 'Path': (<class 'str'>, False), 'Protocol': (<class 'str'>, False),'Timeout': (<function integer>, False), 'UnhealthyThreshold': (<function integer>,False)}

class troposphere.apprunner.ImageConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ImageConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Port': (<class 'str'>, False), 'RuntimeEnvironmentVariables': ([<class'troposphere.apprunner.KeyValuePair'>], False), 'StartCommand': (<class 'str'>,False)}

class troposphere.apprunner.ImageRepository(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ImageRepository

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ImageConfiguration': (<class 'troposphere.apprunner.ImageConfiguration'>, False),'ImageIdentifier': (<class 'str'>, True), 'ImageRepositoryType': (<class 'str'>,True)}

class troposphere.apprunner.InstanceConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InstanceConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Cpu':(<class 'str'>, False), 'InstanceRoleArn': (<class 'str'>, False), 'Memory':(<class 'str'>, False)}

class troposphere.apprunner.KeyValuePair(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KeyValuePair

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'Value': (<class 'str'>, False)}

class troposphere.apprunner.NetworkConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NetworkConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EgressConfiguration': (<class 'troposphere.apprunner.EgressConfiguration'>,True)}

7.3. troposphere 109

Page 114: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.apprunner.ObservabilityConfiguration(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ObservabilityConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ObservabilityConfigurationName': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False), 'TraceConfiguration': (<class'troposphere.apprunner.TraceConfiguration'>, False)}

resource_type: Optional[str] = 'AWS::AppRunner::ObservabilityConfiguration'

class troposphere.apprunner.Service(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Service

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoScalingConfigurationArn': (<class 'str'>, False), 'EncryptionConfiguration':(<class 'troposphere.apprunner.EncryptionConfiguration'>, False),'HealthCheckConfiguration': (<class'troposphere.apprunner.HealthCheckConfiguration'>, False), 'InstanceConfiguration':(<class 'troposphere.apprunner.InstanceConfiguration'>, False),'NetworkConfiguration': (<class 'troposphere.apprunner.NetworkConfiguration'>,False), 'ObservabilityConfiguration': (<class'troposphere.apprunner.ServiceObservabilityConfiguration'>, False), 'ServiceName':(<class 'str'>, False), 'SourceConfiguration': (<class'troposphere.apprunner.SourceConfiguration'>, True), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::AppRunner::Service'

class troposphere.apprunner.ServiceObservabilityConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ServiceObservabilityConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ObservabilityConfigurationArn': (<class 'str'>, False), 'ObservabilityEnabled':(<function boolean>, True)}

class troposphere.apprunner.SourceCodeVersion(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SourceCodeVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Type': (<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.apprunner.SourceConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SourceConfiguration

110 Chapter 7. Licensing

Page 115: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthenticationConfiguration': (<class'troposphere.apprunner.AuthenticationConfiguration'>, False),'AutoDeploymentsEnabled': (<function boolean>, False), 'CodeRepository': (<class'troposphere.apprunner.CodeRepository'>, False), 'ImageRepository': (<class'troposphere.apprunner.ImageRepository'>, False)}

class troposphere.apprunner.TraceConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TraceConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Vendor': (<class 'str'>, True)}

class troposphere.apprunner.VpcConnector(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VpcConnector

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SecurityGroups': ([<class 'str'>], False), 'Subnets': ([<class 'str'>], True),'Tags': (<class 'troposphere.Tags'>, False), 'VpcConnectorName': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::AppRunner::VpcConnector'

troposphere.appstream module

class troposphere.appstream.AccessEndpoint(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AccessEndpoint

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EndpointType': (<class 'str'>, True), 'VpceId': (<class 'str'>, True)}

class troposphere.appstream.AppBlock(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

AppBlock

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'DisplayName': (<class 'str'>, False),'Name': (<class 'str'>, True), 'SetupScriptDetails': (<class'troposphere.appstream.ScriptDetails'>, True), 'SourceS3Location': (<class'troposphere.appstream.S3Location'>, True), 'Tags': (<functionvalidate_tags_or_list>, False)}

resource_type: Optional[str] = 'AWS::AppStream::AppBlock'

7.3. troposphere 111

Page 116: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.appstream.Application(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Application

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AppBlockArn': (<class 'str'>, True), 'AttributesToDelete': ([<class 'str'>],False), 'Description': (<class 'str'>, False), 'DisplayName': (<class 'str'>,False), 'IconS3Location': (<class 'troposphere.appstream.S3Location'>, True),'InstanceFamilies': ([<class 'str'>], True), 'LaunchParameters': (<class 'str'>,False), 'LaunchPath': (<class 'str'>, True), 'Name': (<class 'str'>, True),'Platforms': ([<class 'str'>], True), 'Tags': (<function validate_tags_or_list>,False), 'WorkingDirectory': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::AppStream::Application'

class troposphere.appstream.ApplicationEntitlementAssociation(title: Optional[str], template:Optional[troposphere.Template] =None, validation: bool = True,**kwargs: Any)

Bases: troposphere.AWSObject

ApplicationEntitlementAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationIdentifier': (<class 'str'>, True), 'EntitlementName': (<class'str'>, True), 'StackName': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::AppStream::ApplicationEntitlementAssociation'

class troposphere.appstream.ApplicationFleetAssociation(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ApplicationFleetAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationArn': (<class 'str'>, True), 'FleetName': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::AppStream::ApplicationFleetAssociation'

class troposphere.appstream.ApplicationSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ApplicationSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, True), 'SettingsGroup': (<class 'str'>, False)}

class troposphere.appstream.Attribute(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Attribute

112 Chapter 7. Licensing

Page 117: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.appstream.ComputeCapacity(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ComputeCapacity

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DesiredInstances': (<function integer>, True)}

class troposphere.appstream.DirectoryConfig(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

DirectoryConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DirectoryName': (<class 'str'>, True), 'OrganizationalUnitDistinguishedNames':([<class 'str'>], True), 'ServiceAccountCredentials': (<class'troposphere.appstream.ServiceAccountCredentials'>, True)}

resource_type: Optional[str] = 'AWS::AppStream::DirectoryConfig'

class troposphere.appstream.DomainJoinInfo(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DomainJoinInfo

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DirectoryName': (<class 'str'>, False), 'OrganizationalUnitDistinguishedName':(<class 'str'>, False)}

class troposphere.appstream.Entitlement(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Entitlement

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AppVisibility': (<class 'str'>, True), 'Attributes': ([<class'troposphere.appstream.Attribute'>], True), 'Description': (<class 'str'>, False),'Name': (<class 'str'>, True), 'StackName': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::AppStream::Entitlement'

class troposphere.appstream.Fleet(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Fleet

7.3. troposphere 113

Page 118: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComputeCapacity': (<class 'troposphere.appstream.ComputeCapacity'>, False),'Description': (<class 'str'>, False), 'DisconnectTimeoutInSeconds': (<functioninteger>, False), 'DisplayName': (<class 'str'>, False), 'DomainJoinInfo': (<class'troposphere.appstream.DomainJoinInfo'>, False), 'EnableDefaultInternetAccess':(<function boolean>, False), 'FleetType': (<class 'str'>, False), 'IamRoleArn':(<class 'str'>, False), 'IdleDisconnectTimeoutInSeconds': (<function integer>,False), 'ImageArn': (<class 'str'>, False), 'ImageName': (<class 'str'>, False),'InstanceType': (<class 'str'>, True), 'MaxConcurrentSessions': (<functioninteger>, False), 'MaxUserDurationInSeconds': (<function integer>, False), 'Name':(<class 'str'>, True), 'Platform': (<class 'str'>, False),'SessionScriptS3Location': (<class 'troposphere.appstream.S3Location'>, False),'StreamView': (<class 'str'>, False), 'Tags': (<function validate_tags_or_list>,False), 'UsbDeviceFilterStrings': ([<class 'str'>], False), 'VpcConfig': (<class'troposphere.appstream.VpcConfig'>, False)}

resource_type: Optional[str] = 'AWS::AppStream::Fleet'

class troposphere.appstream.ImageBuilder(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ImageBuilder

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessEndpoints': ([<class 'troposphere.appstream.AccessEndpoint'>], False),'AppstreamAgentVersion': (<class 'str'>, False), 'Description': (<class 'str'>,False), 'DisplayName': (<class 'str'>, False), 'DomainJoinInfo': (<class'troposphere.appstream.DomainJoinInfo'>, False), 'EnableDefaultInternetAccess':(<function boolean>, False), 'IamRoleArn': (<class 'str'>, False), 'ImageArn':(<class 'str'>, False), 'ImageName': (<class 'str'>, False), 'InstanceType':(<class 'str'>, True), 'Name': (<class 'str'>, True), 'Tags': (<functionvalidate_tags_or_list>, False), 'VpcConfig': (<class'troposphere.appstream.VpcConfig'>, False)}

resource_type: Optional[str] = 'AWS::AppStream::ImageBuilder'

class troposphere.appstream.S3Location(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3Location

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'S3Bucket': (<class 'str'>, True), 'S3Key': (<class 'str'>, True)}

class troposphere.appstream.ScriptDetails(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ScriptDetails

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ExecutableParameters': (<class 'str'>, False), 'ExecutablePath': (<class 'str'>,True), 'ScriptS3Location': (<class 'troposphere.appstream.S3Location'>, True),'TimeoutInSeconds': (<function integer>, True)}

114 Chapter 7. Licensing

Page 119: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.appstream.ServiceAccountCredentials(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ServiceAccountCredentials

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccountName': (<class 'str'>, True), 'AccountPassword': (<class 'str'>, True)}

class troposphere.appstream.Stack(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Stack

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessEndpoints': ([<class 'troposphere.appstream.AccessEndpoint'>], False),'ApplicationSettings': (<class 'troposphere.appstream.ApplicationSettings'>,False), 'AttributesToDelete': ([<class 'str'>], False), 'DeleteStorageConnectors':(<function boolean>, False), 'Description': (<class 'str'>, False), 'DisplayName':(<class 'str'>, False), 'EmbedHostDomains': ([<class 'str'>], False),'FeedbackURL': (<class 'str'>, False), 'Name': (<class 'str'>, False),'RedirectURL': (<class 'str'>, False), 'StorageConnectors': ([<class'troposphere.appstream.StorageConnector'>], False), 'Tags': (<functionvalidate_tags_or_list>, False), 'UserSettings': ([<class'troposphere.appstream.UserSetting'>], False)}

resource_type: Optional[str] = 'AWS::AppStream::Stack'

class troposphere.appstream.StackFleetAssociation(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

StackFleetAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FleetName': (<class 'str'>, True), 'StackName': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::AppStream::StackFleetAssociation'

class troposphere.appstream.StackUserAssociation(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

StackUserAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthenticationType': (<class 'str'>, True), 'SendEmailNotification': (<functionboolean>, False), 'StackName': (<class 'str'>, True), 'UserName': (<class 'str'>,True)}

resource_type: Optional[str] = 'AWS::AppStream::StackUserAssociation'

class troposphere.appstream.StorageConnector(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

StorageConnector

7.3. troposphere 115

Page 120: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectorType': (<class 'str'>, True), 'Domains': ([<class 'str'>], False),'ResourceIdentifier': (<class 'str'>, False)}

class troposphere.appstream.User(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

User

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthenticationType': (<class 'str'>, True), 'FirstName': (<class 'str'>, False),'LastName': (<class 'str'>, False), 'MessageAction': (<class 'str'>, False),'UserName': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::AppStream::User'

class troposphere.appstream.UserSetting(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

UserSetting

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Action': (<class 'str'>, True), 'Permission': (<class 'str'>, True)}

class troposphere.appstream.VpcConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VpcConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SecurityGroupIds': ([<class 'str'>], False), 'SubnetIds': ([<class 'str'>],False)}

troposphere.appsync module

class troposphere.appsync.AdditionalAuthenticationProvider(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

AdditionalAuthenticationProvider

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthenticationType': (<class 'str'>, True), 'LambdaAuthorizerConfig': (<class'troposphere.appsync.LambdaAuthorizerConfig'>, False), 'OpenIDConnectConfig':(<class 'troposphere.appsync.OpenIDConnectConfig'>, False), 'UserPoolConfig':(<class 'troposphere.appsync.CognitoUserPoolConfig'>, False)}

class troposphere.appsync.ApiCache(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ApiCache

116 Chapter 7. Licensing

Page 121: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiCachingBehavior': (<class 'str'>, True), 'ApiId': (<class 'str'>, True),'AtRestEncryptionEnabled': (<function boolean>, False), 'TransitEncryptionEnabled':(<function boolean>, False), 'Ttl': (<function double>, True), 'Type': (<class'str'>, True)}

resource_type: Optional[str] = 'AWS::AppSync::ApiCache'

class troposphere.appsync.ApiKey(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ApiKey

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiId': (<class 'str'>, True), 'ApiKeyId': (<class 'str'>, False),'Description': (<class 'str'>, False), 'Expires': (<function double>, False)}

resource_type: Optional[str] = 'AWS::AppSync::ApiKey'

class troposphere.appsync.AuthorizationConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AuthorizationConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthorizationType': (<class 'str'>, True), 'AwsIamConfig': (<class'troposphere.appsync.AwsIamConfig'>, False)}

class troposphere.appsync.AwsIamConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AwsIamConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SigningRegion': (<class 'str'>, False), 'SigningServiceName': (<class 'str'>,False)}

class troposphere.appsync.CachingConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CachingConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CachingKeys': ([<class 'str'>], False), 'Ttl': (<function double>, True)}

class troposphere.appsync.CognitoUserPoolConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CognitoUserPoolConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AppIdClientRegex': (<class 'str'>, False), 'AwsRegion': (<class 'str'>, False),'UserPoolId': (<class 'str'>, False)}

7.3. troposphere 117

Page 122: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.appsync.DataSource(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DataSource

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiId': (<class 'str'>, True), 'Description': (<class 'str'>, False),'DynamoDBConfig': (<class 'troposphere.appsync.DynamoDBConfig'>, False),'ElasticsearchConfig': (<class 'troposphere.appsync.ElasticsearchConfig'>, False),'HttpConfig': (<class 'troposphere.appsync.HttpConfig'>, False), 'LambdaConfig':(<class 'troposphere.appsync.LambdaConfig'>, False), 'Name': (<class 'str'>, True),'OpenSearchServiceConfig': (<class 'troposphere.appsync.OpenSearchServiceConfig'>,False), 'RelationalDatabaseConfig': (<class'troposphere.appsync.RelationalDatabaseConfig'>, False), 'ServiceRoleArn': (<class'str'>, False), 'Type': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::AppSync::DataSource'

class troposphere.appsync.DeltaSyncConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DeltaSyncConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BaseTableTTL': (<class 'str'>, True), 'DeltaSyncTableName': (<class 'str'>,True), 'DeltaSyncTableTTL': (<class 'str'>, True)}

class troposphere.appsync.DomainName(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DomainName

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateArn': (<class 'str'>, True), 'Description': (<class 'str'>, False),'DomainName': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::AppSync::DomainName'

class troposphere.appsync.DomainNameApiAssociation(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DomainNameApiAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiId': (<class 'str'>, True), 'DomainName': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::AppSync::DomainNameApiAssociation'

class troposphere.appsync.DynamoDBConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DynamoDBConfig

118 Chapter 7. Licensing

Page 123: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AwsRegion': (<class 'str'>, True), 'DeltaSyncConfig': (<class'troposphere.appsync.DeltaSyncConfig'>, False), 'TableName': (<class 'str'>, True),'UseCallerCredentials': (<function boolean>, False), 'Versioned': (<functionboolean>, False)}

class troposphere.appsync.ElasticsearchConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ElasticsearchConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AwsRegion': (<class 'str'>, True), 'Endpoint': (<class 'str'>, True)}

class troposphere.appsync.FunctionConfiguration(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

FunctionConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiId': (<class 'str'>, True), 'DataSourceName': (<class 'str'>, True),'Description': (<class 'str'>, False), 'FunctionVersion': (<class 'str'>, True),'MaxBatchSize': (<function integer>, False), 'Name': (<class 'str'>, True),'RequestMappingTemplate': (<class 'str'>, False),'RequestMappingTemplateS3Location': (<class 'str'>, False),'ResponseMappingTemplate': (<class 'str'>, False),'ResponseMappingTemplateS3Location': (<class 'str'>, False), 'SyncConfig': (<class'troposphere.appsync.SyncConfig'>, False)}

resource_type: Optional[str] = 'AWS::AppSync::FunctionConfiguration'

class troposphere.appsync.GraphQLApi(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

GraphQLApi

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AdditionalAuthenticationProviders': ([<class'troposphere.appsync.AdditionalAuthenticationProvider'>], False),'AuthenticationType': (<class 'str'>, True), 'LambdaAuthorizerConfig': (<class'troposphere.appsync.LambdaAuthorizerConfig'>, False), 'LogConfig': (<class'troposphere.appsync.LogConfig'>, False), 'Name': (<class 'str'>, True),'OpenIDConnectConfig': (<class 'troposphere.appsync.OpenIDConnectConfig'>, False),'Tags': (<class 'troposphere.Tags'>, False), 'UserPoolConfig': (<class'troposphere.appsync.UserPoolConfig'>, False), 'XrayEnabled': (<function boolean>,False)}

resource_type: Optional[str] = 'AWS::AppSync::GraphQLApi'

class troposphere.appsync.GraphQLSchema(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

7.3. troposphere 119

Page 124: Release 3.1

troposphere Documentation, Release 4.0.1

GraphQLSchema

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiId': (<class 'str'>, True), 'Definition': (<class 'str'>, False),'DefinitionS3Location': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::AppSync::GraphQLSchema'

class troposphere.appsync.HttpConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthorizationConfig': (<class 'troposphere.appsync.AuthorizationConfig'>, False),'Endpoint': (<class 'str'>, True)}

class troposphere.appsync.LambdaAuthorizerConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LambdaAuthorizerConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthorizerResultTtlInSeconds': (<function double>, False), 'AuthorizerUri':(<class 'str'>, False), 'IdentityValidationExpression': (<class 'str'>, False)}

class troposphere.appsync.LambdaConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LambdaConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LambdaFunctionArn': (<class 'str'>, True)}

class troposphere.appsync.LambdaConflictHandlerConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LambdaConflictHandlerConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LambdaConflictHandlerArn': (<class 'str'>, False)}

class troposphere.appsync.LogConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LogConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudWatchLogsRoleArn': (<class 'str'>, False), 'ExcludeVerboseContent':(<function boolean>, False), 'FieldLogLevel': (<class 'str'>, False)}

class troposphere.appsync.OpenIDConnectConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OpenIDConnectConfig

120 Chapter 7. Licensing

Page 125: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthTTL': (<function double>, False), 'ClientId': (<class 'str'>, False),'IatTTL': (<function double>, False), 'Issuer': (<class 'str'>, False)}

class troposphere.appsync.OpenSearchServiceConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OpenSearchServiceConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AwsRegion': (<class 'str'>, True), 'Endpoint': (<class 'str'>, True)}

class troposphere.appsync.PipelineConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PipelineConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Functions': ([<class 'str'>], False)}

class troposphere.appsync.RdsHttpEndpointConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RdsHttpEndpointConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AwsRegion': (<class 'str'>, True), 'AwsSecretStoreArn': (<class 'str'>, True),'DatabaseName': (<class 'str'>, False), 'DbClusterIdentifier': (<class 'str'>,True), 'Schema': (<class 'str'>, False)}

class troposphere.appsync.RelationalDatabaseConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RelationalDatabaseConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RdsHttpEndpointConfig': (<class 'troposphere.appsync.RdsHttpEndpointConfig'>,False), 'RelationalDatabaseSourceType': (<class 'str'>, True)}

class troposphere.appsync.Resolver(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Resolver

7.3. troposphere 121

Page 126: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiId': (<class 'str'>, True), 'CachingConfig': (<class'troposphere.appsync.CachingConfig'>, False), 'DataSourceName': (<class 'str'>,False), 'FieldName': (<class 'str'>, True), 'Kind': (<functionresolver_kind_validator>, False), 'MaxBatchSize': (<function integer>, False),'PipelineConfig': (<class 'troposphere.appsync.PipelineConfig'>, False),'RequestMappingTemplate': (<class 'str'>, False),'RequestMappingTemplateS3Location': (<class 'str'>, False),'ResponseMappingTemplate': (<class 'str'>, False),'ResponseMappingTemplateS3Location': (<class 'str'>, False), 'SyncConfig': (<class'troposphere.appsync.SyncConfig'>, False), 'TypeName': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::AppSync::Resolver'

class troposphere.appsync.SyncConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SyncConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConflictDetection': (<class 'str'>, True), 'ConflictHandler': (<class 'str'>,False), 'LambdaConflictHandlerConfig': (<class'troposphere.appsync.LambdaConflictHandlerConfig'>, False)}

class troposphere.appsync.UserPoolConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

UserPoolConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AppIdClientRegex': (<class 'str'>, False), 'AwsRegion': (<class 'str'>, False),'DefaultAction': (<class 'str'>, False), 'UserPoolId': (<class 'str'>, False)}

troposphere.aps module

class troposphere.aps.RuleGroupsNamespace(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

RuleGroupsNamespace

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Data': (<class 'str'>, True), 'Name': (<class 'str'>, True), 'Tags': (<class'troposphere.Tags'>, False), 'Workspace': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::APS::RuleGroupsNamespace'

class troposphere.aps.Workspace(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Workspace

122 Chapter 7. Licensing

Page 127: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AlertManagerDefinition': (<class 'str'>, False), 'Alias': (<class 'str'>,False), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::APS::Workspace'

troposphere.ask module

class troposphere.ask.AuthenticationConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AuthenticationConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClientId': (<class 'str'>, True), 'ClientSecret': (<class 'str'>, True),'RefreshToken': (<class 'str'>, True)}

class troposphere.ask.Overrides(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Overrides

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Manifest': (<class 'dict'>, False)}

class troposphere.ask.Skill(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Skill

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthenticationConfiguration': (<class'troposphere.ask.AuthenticationConfiguration'>, True), 'SkillPackage': (<class'troposphere.ask.SkillPackage'>, True), 'VendorId': (<class 'str'>, True)}

resource_type: Optional[str] = 'Alexa::ASK::Skill'

class troposphere.ask.SkillPackage(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SkillPackage

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Overrides': (<class 'troposphere.ask.Overrides'>, False), 'S3Bucket': (<class'str'>, True), 'S3BucketRole': (<class 'str'>, False), 'S3Key': (<class 'str'>,True), 'S3ObjectVersion': (<class 'str'>, False)}

7.3. troposphere 123

Page 128: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.athena module

class troposphere.athena.DataCatalog(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DataCatalog

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'Name': (<class 'str'>, True),'Parameters': (<class 'dict'>, False), 'Tags': (<class 'troposphere.Tags'>,False), 'Type': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::Athena::DataCatalog'

class troposphere.athena.EncryptionConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EncryptionConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EncryptionOption': (<function validate_encryptionoption>, True), 'KmsKey':(<class 'str'>, False)}

class troposphere.athena.EngineVersion(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EngineVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EffectiveEngineVersion': (<class 'str'>, False), 'SelectedEngineVersion':(<class 'str'>, False)}

class troposphere.athena.NamedQuery(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

NamedQuery

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Database': (<class 'str'>, True), 'Description': (<class 'str'>, False), 'Name':(<class 'str'>, False), 'QueryString': (<class 'str'>, True), 'WorkGroup': (<class'str'>, False)}

resource_type: Optional[str] = 'AWS::Athena::NamedQuery'

class troposphere.athena.PreparedStatement(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

PreparedStatement

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'QueryStatement': (<class 'str'>, True),'StatementName': (<class 'str'>, True), 'WorkGroup': (<class 'str'>, True)}

124 Chapter 7. Licensing

Page 129: Release 3.1

troposphere Documentation, Release 4.0.1

resource_type: Optional[str] = 'AWS::Athena::PreparedStatement'

class troposphere.athena.ResultConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ResultConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EncryptionConfiguration': (<class 'troposphere.athena.EncryptionConfiguration'>,False), 'OutputLocation': (<class 'str'>, False)}

class troposphere.athena.WorkGroup(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

WorkGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'Name': (<class 'str'>, True),'RecursiveDeleteOption': (<function boolean>, False), 'State': (<functionvalidate_workgroup_state>, False), 'Tags': (<class 'troposphere.Tags'>, False),'WorkGroupConfiguration': (<class 'troposphere.athena.WorkGroupConfiguration'>,False)}

resource_type: Optional[str] = 'AWS::Athena::WorkGroup'

class troposphere.athena.WorkGroupConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

WorkGroupConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BytesScannedCutoffPerQuery': (<function integer>, False),'EnforceWorkGroupConfiguration': (<function boolean>, False), 'EngineVersion':(<class 'troposphere.athena.EngineVersion'>, False),'PublishCloudWatchMetricsEnabled': (<function boolean>, False),'RequesterPaysEnabled': (<function boolean>, False), 'ResultConfiguration':(<class 'troposphere.athena.ResultConfiguration'>, False)}

troposphere.auditmanager module

class troposphere.auditmanager.AWSAccount(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AWSAccount

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EmailAddress': (<class 'str'>, False), 'Id': (<class 'str'>, False), 'Name':(<class 'str'>, False)}

class troposphere.auditmanager.AWSService(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AWSService

7.3. troposphere 125

Page 130: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ServiceName': (<class 'str'>, False)}

class troposphere.auditmanager.Assessment(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

Assessment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssessmentReportsDestination': (<class'troposphere.auditmanager.AssessmentReportsDestination'>, False), 'AwsAccount':(<class 'troposphere.auditmanager.AWSAccount'>, False), 'Description': (<class'str'>, False), 'FrameworkId': (<class 'str'>, False), 'Name': (<class 'str'>,False), 'Roles': ([<class 'troposphere.auditmanager.Role'>], False), 'Scope':(<class 'troposphere.auditmanager.Scope'>, False), 'Status': (<class 'str'>,False), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::AuditManager::Assessment'

class troposphere.auditmanager.AssessmentReportsDestination(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

AssessmentReportsDestination

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Destination': (<class 'str'>, False), 'DestinationType': (<class 'str'>, False)}

class troposphere.auditmanager.Role(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Role

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RoleArn': (<class 'str'>, False), 'RoleType': (<class 'str'>, False)}

class troposphere.auditmanager.Scope(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Scope

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AwsAccounts': ([<class 'troposphere.auditmanager.AWSAccount'>], False),'AwsServices': ([<class 'troposphere.auditmanager.AWSService'>], False)}

126 Chapter 7. Licensing

Page 131: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.autoscaling module

class troposphere.autoscaling.AcceleratorCountRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AcceleratorCountRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.autoscaling.AcceleratorTotalMemoryMiBRequest(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

AcceleratorTotalMemoryMiBRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.autoscaling.AutoScalingGroup(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

AutoScalingGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoScalingGroupName': (<class 'str'>, False), 'AvailabilityZones': ([<class'str'>], False), 'CapacityRebalance': (<function boolean>, False), 'Context':(<class 'str'>, False), 'Cooldown': (<class 'str'>, False), 'DesiredCapacity':(<class 'str'>, False), 'DesiredCapacityType': (<class 'str'>, False),'HealthCheckGracePeriod': (<function integer>, False), 'HealthCheckType': (<class'str'>, False), 'InstanceId': (<class 'str'>, False), 'LaunchConfigurationName':(<class 'str'>, False), 'LaunchTemplate': (<class'troposphere.autoscaling.LaunchTemplateSpecification'>, False),'LifecycleHookSpecificationList': ([<class'troposphere.autoscaling.LifecycleHookSpecification'>], False), 'LoadBalancerNames':([<class 'str'>], False), 'MaxInstanceLifetime': (<function integer>, False),'MaxSize': (<function validate_int_to_str>, True), 'MetricsCollection': ([<class'troposphere.autoscaling.MetricsCollection'>], False), 'MinSize': (<functionvalidate_int_to_str>, True), 'MixedInstancesPolicy': (<class'troposphere.autoscaling.MixedInstancesPolicy'>, False),'NewInstancesProtectedFromScaleIn': (<function boolean>, False),'NotificationConfigurations': ([<class'troposphere.autoscaling.NotificationConfigurations'>], False), 'PlacementGroup':(<class 'str'>, False), 'ServiceLinkedRoleARN': (<class 'str'>, False), 'Tags':(<function validate_tags_or_list>, False), 'TargetGroupARNs': ([<class 'str'>],False), 'TerminationPolicies': ([<class 'str'>], False), 'VPCZoneIdentifier':([<class 'str'>], False)}

resource_type: Optional[str] = 'AWS::AutoScaling::AutoScalingGroup'

validate()

7.3. troposphere 127

Page 132: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.autoscaling.BaselineEbsBandwidthMbpsRequest(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

BaselineEbsBandwidthMbpsRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.autoscaling.BlockDeviceMapping(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BlockDeviceMapping

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeviceName': (<class 'str'>, True), 'Ebs': (<class'troposphere.autoscaling.EBSBlockDevice'>, False), 'NoDevice': (<function boolean>,False), 'VirtualName': (<class 'str'>, False)}

class troposphere.autoscaling.CustomizedMetricSpecification(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

CustomizedMetricSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Dimensions': ([<class 'troposphere.autoscaling.MetricDimension'>], False),'MetricName': (<class 'str'>, True), 'Namespace': (<class 'str'>, True),'Statistic': (<class 'str'>, True), 'Unit': (<class 'str'>, False)}

class troposphere.autoscaling.EBSBlockDevice(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EBSBlockDevice

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeleteOnTermination': (<function boolean>, False), 'Encrypted': (<functionboolean>, False), 'Iops': (<function integer>, False), 'SnapshotId': (<class'str'>, False), 'Throughput': (<function integer>, False), 'VolumeSize':(<function integer>, False), 'VolumeType': (<class 'str'>, False)}

class troposphere.autoscaling.InstanceRequirements(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InstanceRequirements

128 Chapter 7. Licensing

Page 133: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AcceleratorCount': (<class 'troposphere.autoscaling.AcceleratorCountRequest'>,False), 'AcceleratorManufacturers': ([<class 'str'>], False), 'AcceleratorNames':([<class 'str'>], False), 'AcceleratorTotalMemoryMiB': (<class'troposphere.autoscaling.AcceleratorTotalMemoryMiBRequest'>, False),'AcceleratorTypes': ([<class 'str'>], False), 'BareMetal': (<class 'str'>, False),'BaselineEbsBandwidthMbps': (<class'troposphere.autoscaling.BaselineEbsBandwidthMbpsRequest'>, False),'BurstablePerformance': (<class 'str'>, False), 'CpuManufacturers': ([<class'str'>], False), 'ExcludedInstanceTypes': ([<class 'str'>], False),'InstanceGenerations': ([<class 'str'>], False), 'LocalStorage': (<class 'str'>,False), 'LocalStorageTypes': ([<class 'str'>], False), 'MemoryGiBPerVCpu': (<class'troposphere.autoscaling.MemoryGiBPerVCpuRequest'>, False), 'MemoryMiB': (<class'troposphere.autoscaling.MemoryMiBRequest'>, False), 'NetworkInterfaceCount':(<class 'troposphere.autoscaling.NetworkInterfaceCountRequest'>, False),'OnDemandMaxPricePercentageOverLowestPrice': (<function integer>, False),'RequireHibernateSupport': (<function boolean>, False),'SpotMaxPricePercentageOverLowestPrice': (<function integer>, False),'TotalLocalStorageGB': (<class'troposphere.autoscaling.TotalLocalStorageGBRequest'>, False), 'VCpuCount': (<class'troposphere.autoscaling.VCpuCountRequest'>, False)}

class troposphere.autoscaling.InstanceReusePolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InstanceReusePolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ReuseOnScaleIn': (<function boolean>, False)}

class troposphere.autoscaling.InstancesDistribution(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InstancesDistribution

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'OnDemandAllocationStrategy': (<class 'str'>, False), 'OnDemandBaseCapacity':(<function integer>, False), 'OnDemandPercentageAboveBaseCapacity': (<functioninteger>, False), 'SpotAllocationStrategy': (<class 'str'>, False),'SpotInstancePools': (<function integer>, False), 'SpotMaxPrice': (<class 'str'>,False)}

class troposphere.autoscaling.LaunchConfiguration(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

LaunchConfiguration

7.3. troposphere 129

Page 134: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssociatePublicIpAddress': (<function boolean>, False), 'BlockDeviceMappings':([<class 'troposphere.autoscaling.BlockDeviceMapping'>], False), 'ClassicLinkVPCId':(<class 'str'>, False), 'ClassicLinkVPCSecurityGroups': ([<class 'str'>], False),'EbsOptimized': (<function boolean>, False), 'IamInstanceProfile': (<class 'str'>,False), 'ImageId': (<class 'str'>, True), 'InstanceId': (<class 'str'>, False),'InstanceMonitoring': (<function boolean>, False), 'InstanceType': (<class 'str'>,True), 'KernelId': (<class 'str'>, False), 'KeyName': (<class 'str'>, False),'LaunchConfigurationName': (<class 'str'>, False), 'MetadataOptions': (<class'troposphere.autoscaling.MetadataOptions'>, False), 'PlacementTenancy': (<class'str'>, False), 'RamDiskId': (<class 'str'>, False), 'SecurityGroups': ([<class'str'>], False), 'SpotPrice': (<class 'str'>, False), 'UserData': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::AutoScaling::LaunchConfiguration'

class troposphere.autoscaling.LaunchTemplate(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LaunchTemplate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LaunchTemplateSpecification': (<class'troposphere.autoscaling.LaunchTemplateSpecification'>, True), 'Overrides':([<class 'troposphere.autoscaling.LaunchTemplateOverrides'>], False)}

class troposphere.autoscaling.LaunchTemplateOverrides(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LaunchTemplateOverrides

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InstanceRequirements': (<class 'troposphere.autoscaling.InstanceRequirements'>,False), 'InstanceType': (<class 'str'>, False), 'LaunchTemplateSpecification':(<class 'troposphere.autoscaling.LaunchTemplateSpecification'>, False),'WeightedCapacity': (<class 'str'>, False)}

class troposphere.autoscaling.LaunchTemplateSpecification(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

LaunchTemplateSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LaunchTemplateId': (<class 'str'>, False), 'LaunchTemplateName': (<class 'str'>,False), 'Version': (<class 'str'>, True)}

validate()

class troposphere.autoscaling.LifecycleHook(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

LifecycleHook

130 Chapter 7. Licensing

Page 135: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoScalingGroupName': (<class 'str'>, True), 'DefaultResult': (<class 'str'>,False), 'HeartbeatTimeout': (<function integer>, False), 'LifecycleHookName':(<class 'str'>, False), 'LifecycleTransition': (<class 'str'>, True),'NotificationMetadata': (<class 'str'>, False), 'NotificationTargetARN': (<class'str'>, False), 'RoleARN': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::AutoScaling::LifecycleHook'

class troposphere.autoscaling.LifecycleHookSpecification(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

LifecycleHookSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DefaultResult': (<class 'str'>, False), 'HeartbeatTimeout': (<function integer>,False), 'LifecycleHookName': (<class 'str'>, True), 'LifecycleTransition': (<class'str'>, True), 'NotificationMetadata': (<class 'str'>, False),'NotificationTargetARN': (<class 'str'>, False), 'RoleARN': (<class 'str'>, False)}

class troposphere.autoscaling.MemoryGiBPerVCpuRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MemoryGiBPerVCpuRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.autoscaling.MemoryMiBRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MemoryMiBRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.autoscaling.MetadataOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MetadataOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HttpEndpoint': (<class 'str'>, False), 'HttpPutResponseHopLimit': (<functioninteger>, False), 'HttpTokens': (<class 'str'>, False)}

class troposphere.autoscaling.Metric(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Metric

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Dimensions': ([<class 'troposphere.autoscaling.MetricDimension'>], False),'MetricName': (<class 'str'>, True), 'Namespace': (<class 'str'>, True)}

7.3. troposphere 131

Page 136: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.autoscaling.MetricDataQuery(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MetricDataQuery

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Expression': (<class 'str'>, False), 'Id': (<class 'str'>, True), 'Label':(<class 'str'>, False), 'MetricStat': (<class'troposphere.autoscaling.MetricStat'>, False), 'ReturnData': (<function boolean>,False)}

class troposphere.autoscaling.MetricDimension(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MetricDimension

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.autoscaling.MetricStat(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MetricStat

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Metric': (<class 'troposphere.autoscaling.Metric'>, True), 'Stat': (<class'str'>, True), 'Unit': (<class 'str'>, False)}

class troposphere.autoscaling.MetricsCollection(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MetricsCollection

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Granularity': (<class 'str'>, True), 'Metrics': ([<class 'str'>], False)}

class troposphere.autoscaling.MixedInstancesPolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MixedInstancesPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InstancesDistribution': (<class 'troposphere.autoscaling.InstancesDistribution'>,False), 'LaunchTemplate': (<class 'troposphere.autoscaling.LaunchTemplate'>, True)}

class troposphere.autoscaling.NetworkInterfaceCountRequest(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

NetworkInterfaceCountRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.autoscaling.NotificationConfigurations(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

132 Chapter 7. Licensing

Page 137: Release 3.1

troposphere Documentation, Release 4.0.1

NotificationConfigurations

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'NotificationTypes': ([<class 'str'>], False), 'TopicARN': (<class 'str'>, True)}

class troposphere.autoscaling.PredefinedMetricSpecification(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

PredefinedMetricSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PredefinedMetricType': (<class 'str'>, True), 'ResourceLabel': (<class 'str'>,False)}

class troposphere.autoscaling.PredictiveScalingConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

PredictiveScalingConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxCapacityBreachBehavior': (<class 'str'>, False), 'MaxCapacityBuffer':(<function integer>, False), 'MetricSpecifications': ([<class'troposphere.autoscaling.PredictiveScalingMetricSpecification'>], True), 'Mode':(<class 'str'>, False), 'SchedulingBufferTime': (<function integer>, False)}

class troposphere.autoscaling.PredictiveScalingCustomizedCapacityMetric(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

PredictiveScalingCustomizedCapacityMetric

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MetricDataQueries': ([<class 'troposphere.autoscaling.MetricDataQuery'>], True)}

class troposphere.autoscaling.PredictiveScalingCustomizedLoadMetric(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

PredictiveScalingCustomizedLoadMetric

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MetricDataQueries': ([<class 'troposphere.autoscaling.MetricDataQuery'>], True)}

class troposphere.autoscaling.PredictiveScalingCustomizedScalingMetric(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

PredictiveScalingCustomizedScalingMetric

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MetricDataQueries': ([<class 'troposphere.autoscaling.MetricDataQuery'>], True)}

class troposphere.autoscaling.PredictiveScalingMetricSpecification(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

7.3. troposphere 133

Page 138: Release 3.1

troposphere Documentation, Release 4.0.1

PredictiveScalingMetricSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CustomizedCapacityMetricSpecification': (<class'troposphere.autoscaling.PredictiveScalingCustomizedCapacityMetric'>, False),'CustomizedLoadMetricSpecification': (<class'troposphere.autoscaling.PredictiveScalingCustomizedLoadMetric'>, False),'CustomizedScalingMetricSpecification': (<class'troposphere.autoscaling.PredictiveScalingCustomizedScalingMetric'>, False),'PredefinedLoadMetricSpecification': (<class'troposphere.autoscaling.PredictiveScalingPredefinedLoadMetric'>, False),'PredefinedMetricPairSpecification': (<class'troposphere.autoscaling.PredictiveScalingPredefinedMetricPair'>, False),'PredefinedScalingMetricSpecification': (<class'troposphere.autoscaling.PredictiveScalingPredefinedScalingMetric'>, False),'TargetValue': (<function double>, True)}

class troposphere.autoscaling.PredictiveScalingPredefinedLoadMetric(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

PredictiveScalingPredefinedLoadMetric

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PredefinedMetricType': (<class 'str'>, True), 'ResourceLabel': (<class 'str'>,False)}

class troposphere.autoscaling.PredictiveScalingPredefinedMetricPair(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

PredictiveScalingPredefinedMetricPair

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PredefinedMetricType': (<class 'str'>, True), 'ResourceLabel': (<class 'str'>,False)}

class troposphere.autoscaling.PredictiveScalingPredefinedScalingMetric(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

PredictiveScalingPredefinedScalingMetric

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PredefinedMetricType': (<class 'str'>, True), 'ResourceLabel': (<class 'str'>,False)}

class troposphere.autoscaling.ScalingPolicy(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

ScalingPolicy

134 Chapter 7. Licensing

Page 139: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AdjustmentType': (<class 'str'>, False), 'AutoScalingGroupName': (<class 'str'>,True), 'Cooldown': (<class 'str'>, False), 'EstimatedInstanceWarmup': (<functioninteger>, False), 'MetricAggregationType': (<class 'str'>, False),'MinAdjustmentMagnitude': (<function integer>, False), 'PolicyType': (<class'str'>, False), 'PredictiveScalingConfiguration': (<class'troposphere.autoscaling.PredictiveScalingConfiguration'>, False),'ScalingAdjustment': (<function integer>, False), 'StepAdjustments': ([<class'troposphere.autoscaling.StepAdjustments'>], False), 'TargetTrackingConfiguration':(<class 'troposphere.autoscaling.TargetTrackingConfiguration'>, False)}

resource_type: Optional[str] = 'AWS::AutoScaling::ScalingPolicy'

class troposphere.autoscaling.ScheduledAction(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ScheduledAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoScalingGroupName': (<class 'str'>, True), 'DesiredCapacity': (<functioninteger>, False), 'EndTime': (<class 'str'>, False), 'MaxSize': (<functioninteger>, False), 'MinSize': (<function integer>, False), 'Recurrence': (<class'str'>, False), 'StartTime': (<class 'str'>, False), 'TimeZone': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::AutoScaling::ScheduledAction'

class troposphere.autoscaling.StepAdjustments(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

StepAdjustments

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MetricIntervalLowerBound': (<function double>, False),'MetricIntervalUpperBound': (<function double>, False), 'ScalingAdjustment':(<function integer>, True)}

class troposphere.autoscaling.TargetTrackingConfiguration(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

TargetTrackingConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CustomizedMetricSpecification': (<class'troposphere.autoscaling.CustomizedMetricSpecification'>, False), 'DisableScaleIn':(<function boolean>, False), 'PredefinedMetricSpecification': (<class'troposphere.autoscaling.PredefinedMetricSpecification'>, False), 'TargetValue':(<function double>, True)}

class troposphere.autoscaling.TotalLocalStorageGBRequest(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

7.3. troposphere 135

Page 140: Release 3.1

troposphere Documentation, Release 4.0.1

TotalLocalStorageGBRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.autoscaling.VCpuCountRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VCpuCountRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.autoscaling.WarmPool(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

WarmPool

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoScalingGroupName': (<class 'str'>, True), 'InstanceReusePolicy': (<class'troposphere.autoscaling.InstanceReusePolicy'>, False), 'MaxGroupPreparedCapacity':(<function integer>, False), 'MinSize': (<function integer>, False), 'PoolState':(<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::AutoScaling::WarmPool'

troposphere.autoscalingplans module

class troposphere.autoscalingplans.ApplicationSource(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ApplicationSource

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudFormationStackARN': (<class 'str'>, False), 'TagFilters': ([<class'troposphere.autoscalingplans.TagFilter'>], False)}

class troposphere.autoscalingplans.CustomizedLoadMetricSpecification(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

CustomizedLoadMetricSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Dimensions': ([<class 'troposphere.autoscalingplans.MetricDimension'>], False),'MetricName': (<class 'str'>, True), 'Namespace': (<class 'str'>, True),'Statistic': (<class 'str'>, True), 'Unit': (<class 'str'>, False)}

class troposphere.autoscalingplans.CustomizedScalingMetricSpecification(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

CustomizedScalingMetricSpecification

136 Chapter 7. Licensing

Page 141: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Dimensions': ([<class 'troposphere.autoscalingplans.MetricDimension'>], False),'MetricName': (<class 'str'>, True), 'Namespace': (<class 'str'>, True),'Statistic': (<function statistic_type>, True), 'Unit': (<class 'str'>, False)}

class troposphere.autoscalingplans.MetricDimension(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MetricDimension

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.autoscalingplans.PredefinedLoadMetricSpecification(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

PredefinedLoadMetricSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PredefinedLoadMetricType': (<class 'str'>, True), 'ResourceLabel': (<class'str'>, False)}

class troposphere.autoscalingplans.PredefinedScalingMetricSpecification(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

PredefinedScalingMetricSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PredefinedScalingMetricType': (<class 'str'>, True), 'ResourceLabel': (<class'str'>, False)}

class troposphere.autoscalingplans.ScalingInstruction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ScalingInstruction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CustomizedLoadMetricSpecification': (<class'troposphere.autoscalingplans.CustomizedLoadMetricSpecification'>, False),'DisableDynamicScaling': (<function boolean>, False), 'MaxCapacity': (<functioninteger>, True), 'MinCapacity': (<function integer>, True),'PredefinedLoadMetricSpecification': (<class'troposphere.autoscalingplans.PredefinedLoadMetricSpecification'>, False),'PredictiveScalingMaxCapacityBehavior': (<functionvalidate_predictivescalingmaxcapacitybehavior>, False),'PredictiveScalingMaxCapacityBuffer': (<function integer>, False),'PredictiveScalingMode': (<function validate_predictivescalingmode>, False),'ResourceId': (<class 'str'>, True), 'ScalableDimension': (<functionscalable_dimension_type>, True), 'ScalingPolicyUpdateBehavior': (<functionvalidate_scalingpolicyupdatebehavior>, False), 'ScheduledActionBufferTime':(<function integer>, False), 'ServiceNamespace': (<functionservice_namespace_type>, True), 'TargetTrackingConfigurations': ([<class'troposphere.autoscalingplans.TargetTrackingConfiguration'>], True)}

7.3. troposphere 137

Page 142: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.autoscalingplans.ScalingPlan(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ScalingPlan

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationSource': (<class 'troposphere.autoscalingplans.ApplicationSource'>,True), 'ScalingInstructions': ([<class'troposphere.autoscalingplans.ScalingInstruction'>], True)}

resource_type: Optional[str] = 'AWS::AutoScalingPlans::ScalingPlan'

class troposphere.autoscalingplans.TagFilter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TagFilter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, True), 'Values': ([<class 'str'>], False)}

class troposphere.autoscalingplans.TargetTrackingConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

TargetTrackingConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CustomizedScalingMetricSpecification': (<class'troposphere.autoscalingplans.CustomizedScalingMetricSpecification'>, False),'DisableScaleIn': (<function boolean>, False), 'EstimatedInstanceWarmup':(<function integer>, False), 'PredefinedScalingMetricSpecification': (<class'troposphere.autoscalingplans.PredefinedScalingMetricSpecification'>, False),'ScaleInCooldown': (<function integer>, False), 'ScaleOutCooldown': (<functioninteger>, False), 'TargetValue': (<function double>, True)}

troposphere.awslambda module

class troposphere.awslambda.Alias(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Alias

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'FunctionName': (<class 'str'>, True),'FunctionVersion': (<class 'str'>, True), 'Name': (<class 'str'>, True),'ProvisionedConcurrencyConfig': (<class'troposphere.awslambda.ProvisionedConcurrencyConfiguration'>, False),'RoutingConfig': (<class 'troposphere.awslambda.AliasRoutingConfiguration'>,False)}

resource_type: Optional[str] = 'AWS::Lambda::Alias'

138 Chapter 7. Licensing

Page 143: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.awslambda.AliasRoutingConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AliasRoutingConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AdditionalVersionWeights': ([<class 'troposphere.awslambda.VersionWeight'>],True)}

class troposphere.awslambda.AllowedPublishers(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AllowedPublishers

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SigningProfileVersionArns': ([<class 'str'>], True)}

class troposphere.awslambda.Code(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Code

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ImageUri': (<class 'str'>, False), 'S3Bucket': (<class 'str'>, False), 'S3Key':(<class 'str'>, False), 'S3ObjectVersion': (<class 'str'>, False), 'ZipFile':(<class 'str'>, False)}

validate()

class troposphere.awslambda.CodeSigningConfig(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

CodeSigningConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllowedPublishers': (<class 'troposphere.awslambda.AllowedPublishers'>, True),'CodeSigningPolicies': (<class 'troposphere.awslambda.CodeSigningPolicies'>,False), 'Description': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::Lambda::CodeSigningConfig'

class troposphere.awslambda.CodeSigningPolicies(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CodeSigningPolicies

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'UntrustedArtifactOnDeployment': (<class 'str'>, True)}

class troposphere.awslambda.Content(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Content

7.3. troposphere 139

Page 144: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'S3Bucket': (<class 'str'>, True), 'S3Key': (<class 'str'>, True),'S3ObjectVersion': (<class 'str'>, False)}

class troposphere.awslambda.Cors(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Cors

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllowCredentials': (<function boolean>, False), 'AllowHeaders': ([<class'str'>], False), 'AllowMethods': ([<class 'str'>], False), 'AllowOrigins':([<class 'str'>], False), 'ExposeHeaders': ([<class 'str'>], False), 'MaxAge':(<function integer>, False)}

class troposphere.awslambda.DeadLetterConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DeadLetterConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TargetArn': (<class 'str'>, False)}

class troposphere.awslambda.DestinationConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DestinationConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'OnFailure': (<class 'troposphere.awslambda.OnFailure'>, False), 'OnSuccess':(<class 'troposphere.awslambda.OnSuccess'>, False)}

class troposphere.awslambda.Endpoints(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Endpoints

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KafkaBootstrapServers': ([<class 'str'>], False)}

class troposphere.awslambda.Environment(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Environment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Variables': (<function validate_variables_name>, False)}

class troposphere.awslambda.EphemeralStorage(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EphemeralStorage

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Size': (<function integer>, True)}

140 Chapter 7. Licensing

Page 145: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.awslambda.EventInvokeConfig(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

EventInvokeConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DestinationConfig': (<class 'troposphere.awslambda.DestinationConfig'>, False),'FunctionName': (<class 'str'>, True), 'MaximumEventAgeInSeconds': (<functioninteger>, False), 'MaximumRetryAttempts': (<function integer>, False), 'Qualifier':(<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::Lambda::EventInvokeConfig'

class troposphere.awslambda.EventSourceMapping(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

EventSourceMapping

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BatchSize': (<function integer>, False), 'BisectBatchOnFunctionError':(<function boolean>, False), 'DestinationConfig': (<class'troposphere.awslambda.DestinationConfig'>, False), 'Enabled': (<function boolean>,False), 'EventSourceArn': (<class 'str'>, False), 'FilterCriteria': (<class'troposphere.awslambda.FilterCriteria'>, False), 'FunctionName': (<class 'str'>,True), 'FunctionResponseTypes': ([<class 'str'>], False),'MaximumBatchingWindowInSeconds': (<function integer>, False),'MaximumRecordAgeInSeconds': (<function integer>, False), 'MaximumRetryAttempts':(<function integer>, False), 'ParallelizationFactor': (<function integer>, False),'Queues': ([<class 'str'>], False), 'SelfManagedEventSource': (<class'troposphere.awslambda.SelfManagedEventSource'>, False),'SourceAccessConfigurations': ([<class'troposphere.awslambda.SourceAccessConfiguration'>], False), 'StartingPosition':(<class 'str'>, False), 'StartingPositionTimestamp': (<function double>, False),'Topics': ([<class 'str'>], False), 'TumblingWindowInSeconds': (<functioninteger>, False)}

resource_type: Optional[str] = 'AWS::Lambda::EventSourceMapping'

class troposphere.awslambda.FileSystemConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FileSystemConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Arn':(<class 'str'>, True), 'LocalMountPath': (<class 'str'>, True)}

class troposphere.awslambda.Filter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Filter

7.3. troposphere 141

Page 146: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Pattern': (<class 'str'>, False)}

class troposphere.awslambda.FilterCriteria(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FilterCriteria

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Filters': ([<class 'troposphere.awslambda.Filter'>], False)}

class troposphere.awslambda.Function(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Function

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Architectures': ([<class 'str'>], False), 'Code': (<class'troposphere.awslambda.Code'>, True), 'CodeSigningConfigArn': (<class 'str'>,False), 'DeadLetterConfig': (<class 'troposphere.awslambda.DeadLetterConfig'>,False), 'Description': (<class 'str'>, False), 'Environment': (<class'troposphere.awslambda.Environment'>, False), 'EphemeralStorage': (<class'troposphere.awslambda.EphemeralStorage'>, False), 'FileSystemConfigs': ([<class'troposphere.awslambda.FileSystemConfig'>], False), 'FunctionName': (<class 'str'>,False), 'Handler': (<class 'str'>, False), 'ImageConfig': (<class'troposphere.awslambda.ImageConfig'>, False), 'KmsKeyArn': (<class 'str'>, False),'Layers': ([<class 'str'>], False), 'MemorySize': (<functionvalidate_memory_size>, False), 'PackageType': (<function validate_package_type>,False), 'ReservedConcurrentExecutions': (<function integer>, False), 'Role':(<class 'str'>, True), 'Runtime': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False), 'Timeout': (<function integer>, False),'TracingConfig': (<class 'troposphere.awslambda.TracingConfig'>, False),'VpcConfig': (<class 'troposphere.awslambda.VPCConfig'>, False)}

resource_type: Optional[str] = 'AWS::Lambda::Function'

class troposphere.awslambda.ImageConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ImageConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Command': ([<class 'str'>], False), 'EntryPoint': ([<class 'str'>], False),'WorkingDirectory': (<class 'str'>, False)}

validate()

class troposphere.awslambda.LayerVersion(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

LayerVersion

142 Chapter 7. Licensing

Page 147: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CompatibleArchitectures': ([<class 'str'>], False), 'CompatibleRuntimes':([<class 'str'>], False), 'Content': (<class 'troposphere.awslambda.Content'>,True), 'Description': (<class 'str'>, False), 'LayerName': (<class 'str'>, False),'LicenseInfo': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::Lambda::LayerVersion'

class troposphere.awslambda.LayerVersionPermission(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

LayerVersionPermission

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Action': (<class 'str'>, True), 'LayerVersionArn': (<class 'str'>, True),'OrganizationId': (<class 'str'>, False), 'Principal': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::Lambda::LayerVersionPermission'

class troposphere.awslambda.OnFailure(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OnFailure

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Destination': (<class 'str'>, True)}

class troposphere.awslambda.OnSuccess(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OnSuccess

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Destination': (<class 'str'>, True)}

class troposphere.awslambda.Permission(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Permission

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Action': (<class 'str'>, True), 'EventSourceToken': (<class 'str'>, False),'FunctionName': (<class 'str'>, True), 'FunctionUrlAuthType': (<class 'str'>,False), 'Principal': (<class 'str'>, True), 'PrincipalOrgID': (<class 'str'>,False), 'SourceAccount': (<class 'str'>, False), 'SourceArn': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::Lambda::Permission'

class troposphere.awslambda.ProvisionedConcurrencyConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ProvisionedConcurrencyConfiguration

7.3. troposphere 143

Page 148: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ProvisionedConcurrentExecutions': (<function integer>, True)}

class troposphere.awslambda.SelfManagedEventSource(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SelfManagedEventSource

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Endpoints': (<class 'troposphere.awslambda.Endpoints'>, False)}

class troposphere.awslambda.SourceAccessConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SourceAccessConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Type': (<class 'str'>, False), 'URI': (<class 'str'>, False)}

class troposphere.awslambda.TracingConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TracingConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Mode': (<class 'str'>, False)}

class troposphere.awslambda.Url(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Url

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthType': (<class 'str'>, True), 'Cors': (<class 'troposphere.awslambda.Cors'>,False), 'Qualifier': (<class 'str'>, False), 'TargetFunctionArn': (<class 'str'>,True)}

resource_type: Optional[str] = 'AWS::Lambda::Url'

class troposphere.awslambda.VPCConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VPCConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SecurityGroupIds': ([<class 'str'>], False), 'SubnetIds': ([<class 'str'>],False)}

class troposphere.awslambda.Version(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Version

144 Chapter 7. Licensing

Page 149: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CodeSha256': (<class 'str'>, False), 'Description': (<class 'str'>, False),'FunctionName': (<class 'str'>, True), 'ProvisionedConcurrencyConfig': (<class'troposphere.awslambda.ProvisionedConcurrencyConfiguration'>, False)}

resource_type: Optional[str] = 'AWS::Lambda::Version'

class troposphere.awslambda.VersionWeight(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VersionWeight

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FunctionVersion': (<class 'str'>, True), 'FunctionWeight': (<function double>,True)}

troposphere.backup module

class troposphere.backup.AdvancedBackupSettingResourceType(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

AdvancedBackupSettingResourceType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BackupOptions': (<class 'dict'>, True), 'ResourceType': (<class 'str'>, True)}

class troposphere.backup.BackupPlan(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

BackupPlan

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BackupPlan': (<class 'troposphere.backup.BackupPlanResourceType'>, True),'BackupPlanTags': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::Backup::BackupPlan'

class troposphere.backup.BackupPlanResourceType(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BackupPlanResourceType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AdvancedBackupSettings': ([<class'troposphere.backup.AdvancedBackupSettingResourceType'>], False), 'BackupPlanName':(<class 'str'>, True), 'BackupPlanRule': ([<class'troposphere.backup.BackupRuleResourceType'>], True)}

class troposphere.backup.BackupRuleResourceType(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BackupRuleResourceType

7.3. troposphere 145

Page 150: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CompletionWindowMinutes': (<function double>, False), 'CopyActions': ([<class'troposphere.backup.CopyActionResourceType'>], False), 'EnableContinuousBackup':(<function boolean>, False), 'Lifecycle': (<class'troposphere.backup.LifecycleResourceType'>, False), 'RecoveryPointTags': (<class'dict'>, False), 'RuleName': (<class 'str'>, True), 'ScheduleExpression': (<class'str'>, False), 'StartWindowMinutes': (<function double>, False),'TargetBackupVault': (<class 'str'>, True)}

class troposphere.backup.BackupSelection(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

BackupSelection

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BackupPlanId': (<class 'str'>, True), 'BackupSelection': (<class'troposphere.backup.BackupSelectionResourceType'>, True)}

resource_type: Optional[str] = 'AWS::Backup::BackupSelection'

class troposphere.backup.BackupSelectionResourceType(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BackupSelectionResourceType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Conditions': (<class 'dict'>, False), 'IamRoleArn': (<class 'str'>, True),'ListOfTags': ([<class 'troposphere.backup.ConditionResourceType'>], False),'NotResources': ([<class 'str'>], False), 'Resources': ([<class 'str'>], False),'SelectionName': (<class 'str'>, True)}

validate()

class troposphere.backup.BackupVault(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

BackupVault

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessPolicy': (<function validate_json_checker>, False), 'BackupVaultName':(<function backup_vault_name>, True), 'BackupVaultTags': (<class 'dict'>, False),'EncryptionKeyArn': (<class 'str'>, False), 'LockConfiguration': (<class'troposphere.backup.LockConfigurationType'>, False), 'Notifications': (<class'troposphere.backup.NotificationObjectType'>, False)}

resource_type: Optional[str] = 'AWS::Backup::BackupVault'

class troposphere.backup.ConditionResourceType(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConditionResourceType

146 Chapter 7. Licensing

Page 151: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConditionKey': (<class 'str'>, True), 'ConditionType': (<class 'str'>, True),'ConditionValue': (<class 'str'>, True)}

class troposphere.backup.ControlInputParameter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ControlInputParameter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ParameterName': (<class 'str'>, True), 'ParameterValue': (<class 'str'>, True)}

class troposphere.backup.CopyActionResourceType(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CopyActionResourceType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DestinationBackupVaultArn': (<class 'str'>, True), 'Lifecycle': (<class'troposphere.backup.LifecycleResourceType'>, False)}

class troposphere.backup.Framework(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Framework

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FrameworkControls': ([<class 'troposphere.backup.FrameworkControl'>], True),'FrameworkDescription': (<class 'str'>, False), 'FrameworkName': (<class 'str'>,False), 'FrameworkTags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::Backup::Framework'

class troposphere.backup.FrameworkControl(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FrameworkControl

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ControlInputParameters': ([<class 'troposphere.backup.ControlInputParameter'>],False), 'ControlName': (<class 'str'>, True), 'ControlScope': (<class 'dict'>,False)}

class troposphere.backup.LifecycleResourceType(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LifecycleResourceType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeleteAfterDays': (<function double>, False), 'MoveToColdStorageAfterDays':(<function double>, False)}

class troposphere.backup.LockConfigurationType(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 147

Page 152: Release 3.1

troposphere Documentation, Release 4.0.1

LockConfigurationType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ChangeableForDays': (<function double>, False), 'MaxRetentionDays': (<functiondouble>, False), 'MinRetentionDays': (<function double>, True)}

class troposphere.backup.NotificationObjectType(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NotificationObjectType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BackupVaultEvents': ([<class 'str'>], True), 'SNSTopicArn': (<class 'str'>,True)}

class troposphere.backup.ReportPlan(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ReportPlan

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ReportDeliveryChannel': (<class 'dict'>, True), 'ReportPlanDescription': (<class'str'>, False), 'ReportPlanName': (<class 'str'>, False), 'ReportPlanTags':(<class 'troposphere.Tags'>, False), 'ReportSetting': (<class 'dict'>, True)}

resource_type: Optional[str] = 'AWS::Backup::ReportPlan'

troposphere.batch module

class troposphere.batch.AuthorizationConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AuthorizationConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessPointId': (<class 'str'>, False), 'Iam': (<class 'str'>, False)}

class troposphere.batch.ComputeEnvironment(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

ComputeEnvironment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComputeEnvironmentName': (<class 'str'>, False), 'ComputeResources': (<class'troposphere.batch.ComputeResources'>, False), 'ServiceRole': (<class 'str'>,False), 'State': (<function validate_environment_state>, False), 'Tags': (<class'dict'>, False), 'Type': (<class 'str'>, True), 'UnmanagedvCpus': (<functioninteger>, False)}

resource_type: Optional[str] = 'AWS::Batch::ComputeEnvironment'

148 Chapter 7. Licensing

Page 153: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.batch.ComputeEnvironmentOrder(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ComputeEnvironmentOrder

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComputeEnvironment': (<class 'str'>, True), 'Order': (<function integer>, True)}

class troposphere.batch.ComputeResources(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ComputeResources

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllocationStrategy': (<function validate_allocation_strategy>, False),'BidPercentage': (<function integer>, False), 'DesiredvCpus': (<function integer>,False), 'Ec2Configuration': ([<class 'troposphere.batch.Ec2ConfigurationObject'>],False), 'Ec2KeyPair': (<class 'str'>, False), 'ImageId': (<class 'str'>, False),'InstanceRole': (<class 'str'>, False), 'InstanceTypes': ([<class 'str'>], False),'LaunchTemplate': (<class 'troposphere.batch.LaunchTemplateSpecification'>, False),'MaxvCpus': (<function integer>, True), 'MinvCpus': (<function integer>, False),'PlacementGroup': (<class 'str'>, False), 'SecurityGroupIds': ([<class 'str'>],False), 'SpotIamFleetRole': (<class 'str'>, False), 'Subnets': ([<class 'str'>],True), 'Tags': (<class 'dict'>, False), 'Type': (<class 'str'>, True)}

class troposphere.batch.ContainerProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ContainerProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Command': ([<class 'str'>], False), 'Environment': ([<class'troposphere.batch.Environment'>], False), 'ExecutionRoleArn': (<class 'str'>,False), 'FargatePlatformConfiguration': (<class'troposphere.batch.FargatePlatformConfiguration'>, False), 'Image': (<class 'str'>,True), 'InstanceType': (<class 'str'>, False), 'JobRoleArn': (<class 'str'>,False), 'LinuxParameters': (<class 'troposphere.batch.LinuxParameters'>, False),'LogConfiguration': (<class 'troposphere.batch.LogConfiguration'>, False),'Memory': (<function integer>, False), 'MountPoints': ([<class'troposphere.batch.MountPoints'>], False), 'NetworkConfiguration': (<class'troposphere.batch.NetworkConfiguration'>, False), 'Privileged': (<functionboolean>, False), 'ReadonlyRootFilesystem': (<function boolean>, False),'ResourceRequirements': ([<class 'troposphere.batch.ResourceRequirement'>], False),'Secrets': ([<class 'troposphere.batch.Secret'>], False), 'Ulimits': ([<class'troposphere.batch.Ulimit'>], False), 'User': (<class 'str'>, False), 'Vcpus':(<function integer>, False), 'Volumes': ([<class 'troposphere.batch.Volumes'>],False)}

class troposphere.batch.Device(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Device

7.3. troposphere 149

Page 154: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContainerPath': (<class 'str'>, False), 'HostPath': (<class 'str'>, False),'Permissions': ([<class 'str'>], False)}

class troposphere.batch.Ec2ConfigurationObject(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Ec2ConfigurationObject

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ImageIdOverride': (<class 'str'>, False), 'ImageType': (<class 'str'>, True)}

class troposphere.batch.EfsVolumeConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EfsVolumeConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthorizationConfig': (<class 'troposphere.batch.AuthorizationConfig'>, False),'FileSystemId': (<class 'str'>, True), 'RootDirectory': (<class 'str'>, False),'TransitEncryption': (<class 'str'>, False), 'TransitEncryptionPort': (<functioninteger>, False)}

class troposphere.batch.Environment(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Environment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'Value': (<class 'str'>, False)}

class troposphere.batch.EvaluateOnExit(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EvaluateOnExit

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Action': (<class 'str'>, True), 'OnExitCode': (<class 'str'>, False),'OnReason': (<class 'str'>, False), 'OnStatusReason': (<class 'str'>, False)}

class troposphere.batch.FairsharePolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FairsharePolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComputeReservation': (<function double>, False), 'ShareDecaySeconds': (<functiondouble>, False), 'ShareDistribution': ([<class'troposphere.batch.ShareAttributes'>], False)}

class troposphere.batch.FargatePlatformConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FargatePlatformConfiguration

150 Chapter 7. Licensing

Page 155: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PlatformVersion': (<class 'str'>, False)}

class troposphere.batch.JobDefinition(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

JobDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContainerProperties': (<class 'troposphere.batch.ContainerProperties'>, False),'JobDefinitionName': (<class 'str'>, False), 'NodeProperties': (<class'troposphere.batch.NodeProperties'>, False), 'Parameters': (<class 'dict'>, False),'PlatformCapabilities': ([<class 'str'>], False), 'PropagateTags': (<functionboolean>, False), 'RetryStrategy': (<class 'troposphere.batch.RetryStrategy'>,False), 'SchedulingPriority': (<function integer>, False), 'Tags': (<class'dict'>, False), 'Timeout': (<class 'troposphere.batch.Timeout'>, False), 'Type':(<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::Batch::JobDefinition'

class troposphere.batch.JobQueue(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

JobQueue

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComputeEnvironmentOrder': ([<class 'troposphere.batch.ComputeEnvironmentOrder'>],True), 'JobQueueName': (<class 'str'>, False), 'Priority': (<function integer>,True), 'SchedulingPolicyArn': (<class 'str'>, False), 'State': (<functionvalidate_queue_state>, False), 'Tags': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::Batch::JobQueue'

class troposphere.batch.LaunchTemplateSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LaunchTemplateSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LaunchTemplateId': (<class 'str'>, False), 'LaunchTemplateName': (<class 'str'>,False), 'Version': (<class 'str'>, False)}

validate()

class troposphere.batch.LinuxParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LinuxParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Devices': ([<class 'troposphere.batch.Device'>], False), 'InitProcessEnabled':(<function boolean>, False), 'MaxSwap': (<function integer>, False),'SharedMemorySize': (<function integer>, False), 'Swappiness': (<functioninteger>, False), 'Tmpfs': ([<class 'troposphere.batch.Tmpfs'>], False)}

7.3. troposphere 151

Page 156: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.batch.LogConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LogConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LogDriver': (<class 'str'>, True), 'Options': (<class 'dict'>, False),'SecretOptions': ([<class 'troposphere.batch.Secret'>], False)}

class troposphere.batch.MountPoints(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MountPoints

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContainerPath': (<class 'str'>, False), 'ReadOnly': (<function boolean>, False),'SourceVolume': (<class 'str'>, False)}

class troposphere.batch.NetworkConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NetworkConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssignPublicIp': (<class 'str'>, False)}

class troposphere.batch.NodeProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NodeProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MainNode': (<function integer>, True), 'NodeRangeProperties': ([<class'troposphere.batch.NodeRangeProperty'>], True), 'NumNodes': (<function integer>,True)}

class troposphere.batch.NodeRangeProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NodeRangeProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Container': (<class 'troposphere.batch.ContainerProperties'>, False),'TargetNodes': (<class 'str'>, True)}

class troposphere.batch.ResourceRequirement(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ResourceRequirement

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Type': (<class 'str'>, False), 'Value': (<class 'str'>, False)}

class troposphere.batch.RetryStrategy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RetryStrategy

152 Chapter 7. Licensing

Page 157: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Attempts': (<function integer>, False), 'EvaluateOnExit': ([<class'troposphere.batch.EvaluateOnExit'>], False)}

class troposphere.batch.SchedulingPolicy(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

SchedulingPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FairsharePolicy': (<class 'troposphere.batch.FairsharePolicy'>, False), 'Name':(<class 'str'>, False), 'Tags': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::Batch::SchedulingPolicy'

class troposphere.batch.Secret(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Secret

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'ValueFrom': (<class 'str'>, True)}

class troposphere.batch.ShareAttributes(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ShareAttributes

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ShareIdentifier': (<class 'str'>, False), 'WeightFactor': (<function double>,False)}

class troposphere.batch.Timeout(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Timeout

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AttemptDurationSeconds': (<function integer>, False)}

class troposphere.batch.Tmpfs(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Tmpfs

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContainerPath': (<class 'str'>, True), 'MountOptions': ([<class 'str'>], False),'Size': (<function integer>, True)}

class troposphere.batch.Ulimit(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Ulimit

7.3. troposphere 153

Page 158: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HardLimit': (<function integer>, True), 'Name': (<class 'str'>, True),'SoftLimit': (<function integer>, True)}

class troposphere.batch.Volumes(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Volumes

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EfsVolumeConfiguration': (<class 'troposphere.batch.EfsVolumeConfiguration'>,False), 'Host': (<class 'troposphere.batch.VolumesHost'>, False), 'Name': (<class'str'>, False)}

class troposphere.batch.VolumesHost(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VolumesHost

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SourcePath': (<class 'str'>, False)}

troposphere.budgets module

class troposphere.budgets.ActionSubscriber(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ActionSubscriber

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Address': (<class 'str'>, True), 'Type': (<class 'str'>, True)}

class troposphere.budgets.ActionThreshold(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ActionThreshold

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Type': (<class 'str'>, True), 'Value': (<function double>, True)}

class troposphere.budgets.Budget(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Budget

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Budget': (<class 'troposphere.budgets.BudgetData'>, True),'NotificationsWithSubscribers': ([<class'troposphere.budgets.NotificationWithSubscribers'>], False)}

resource_type: Optional[str] = 'AWS::Budgets::Budget'

154 Chapter 7. Licensing

Page 159: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.budgets.BudgetData(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BudgetData

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BudgetLimit': (<class 'troposphere.budgets.Spend'>, False), 'BudgetName':(<class 'str'>, False), 'BudgetType': (<class 'str'>, True), 'CostFilters':(<class 'dict'>, False), 'CostTypes': (<class 'troposphere.budgets.CostTypes'>,False), 'PlannedBudgetLimits': (<class 'dict'>, False), 'TimePeriod': (<class'troposphere.budgets.TimePeriod'>, False), 'TimeUnit': (<class 'str'>, True)}

class troposphere.budgets.BudgetsAction(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

BudgetsAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ActionThreshold': (<class 'troposphere.budgets.ActionThreshold'>, True),'ActionType': (<class 'str'>, True), 'ApprovalModel': (<class 'str'>, False),'BudgetName': (<class 'str'>, True), 'Definition': (<class'troposphere.budgets.Definition'>, True), 'ExecutionRoleArn': (<class 'str'>,True), 'NotificationType': (<class 'str'>, True), 'Subscribers': ([<class'troposphere.budgets.ActionSubscriber'>], True)}

resource_type: Optional[str] = 'AWS::Budgets::BudgetsAction'

class troposphere.budgets.CostTypes(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CostTypes

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'IncludeCredit': (<function boolean>, False), 'IncludeDiscount': (<functionboolean>, False), 'IncludeOtherSubscription': (<function boolean>, False),'IncludeRecurring': (<function boolean>, False), 'IncludeRefund': (<functionboolean>, False), 'IncludeSubscription': (<function boolean>, False),'IncludeSupport': (<function boolean>, False), 'IncludeTax': (<function boolean>,False), 'IncludeUpfront': (<function boolean>, False), 'UseAmortized': (<functionboolean>, False), 'UseBlended': (<function boolean>, False)}

class troposphere.budgets.Definition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Definition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'IamActionDefinition': (<class 'troposphere.budgets.IamActionDefinition'>, False),'ScpActionDefinition': (<class 'troposphere.budgets.ScpActionDefinition'>, False),'SsmActionDefinition': (<class 'troposphere.budgets.SsmActionDefinition'>, False)}

class troposphere.budgets.IamActionDefinition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

IamActionDefinition

7.3. troposphere 155

Page 160: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Groups': ([<class 'str'>], False), 'PolicyArn': (<class 'str'>, True), 'Roles':([<class 'str'>], False), 'Users': ([<class 'str'>], False)}

class troposphere.budgets.Notification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Notification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComparisonOperator': (<class 'str'>, True), 'NotificationType': (<class 'str'>,True), 'Threshold': (<function double>, True), 'ThresholdType': (<class 'str'>,False)}

class troposphere.budgets.NotificationWithSubscribers(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NotificationWithSubscribers

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Notification': (<class 'troposphere.budgets.Notification'>, True), 'Subscribers':([<class 'troposphere.budgets.Subscriber'>], True)}

class troposphere.budgets.ScpActionDefinition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ScpActionDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PolicyId': (<class 'str'>, True), 'TargetIds': ([<class 'str'>], True)}

class troposphere.budgets.Spend(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Spend

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Amount': (<function double>, True), 'Unit': (<class 'str'>, True)}

class troposphere.budgets.SsmActionDefinition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SsmActionDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InstanceIds': ([<class 'str'>], True), 'Region': (<class 'str'>, True),'Subtype': (<class 'str'>, True)}

class troposphere.budgets.Subscriber(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Subscriber

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Address': (<class 'str'>, True), 'SubscriptionType': (<class 'str'>, True)}

156 Chapter 7. Licensing

Page 161: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.budgets.TimePeriod(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TimePeriod

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'End':(<class 'str'>, False), 'Start': (<class 'str'>, False)}

troposphere.cassandra module

class troposphere.cassandra.BillingMode(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BillingMode

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Mode': (<function validate_billingmode_mode>, True), 'ProvisionedThroughput':(<class 'troposphere.cassandra.ProvisionedThroughput'>, False)}

class troposphere.cassandra.ClusteringKeyColumn(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ClusteringKeyColumn

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Column': (<class 'troposphere.cassandra.Column'>, True), 'OrderBy': (<functionvalidate_clusteringkeycolumn_orderby>, False)}

class troposphere.cassandra.Column(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Column

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ColumnName': (<class 'str'>, True), 'ColumnType': (<class 'str'>, True)}

class troposphere.cassandra.EncryptionSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EncryptionSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EncryptionType': (<class 'str'>, True), 'KmsKeyIdentifier': (<class 'str'>,False)}

class troposphere.cassandra.Keyspace(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Keyspace

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KeyspaceName': (<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>,False)}

7.3. troposphere 157

Page 162: Release 3.1

troposphere Documentation, Release 4.0.1

resource_type: Optional[str] = 'AWS::Cassandra::Keyspace'

class troposphere.cassandra.ProvisionedThroughput(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ProvisionedThroughput

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ReadCapacityUnits': (<function integer>, True), 'WriteCapacityUnits': (<functioninteger>, True)}

class troposphere.cassandra.Table(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Table

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BillingMode': (<class 'troposphere.cassandra.BillingMode'>, False),'ClusteringKeyColumns': ([<class 'troposphere.cassandra.ClusteringKeyColumn'>],False), 'DefaultTimeToLive': (<function integer>, False),'EncryptionSpecification': (<class'troposphere.cassandra.EncryptionSpecification'>, False), 'KeyspaceName': (<class'str'>, True), 'PartitionKeyColumns': ([<class 'troposphere.cassandra.Column'>],True), 'PointInTimeRecoveryEnabled': (<function boolean>, False), 'RegularColumns':([<class 'troposphere.cassandra.Column'>], False), 'TableName': (<class 'str'>,False), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::Cassandra::Table'

troposphere.ce module

class troposphere.ce.AnomalyMonitor(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

AnomalyMonitor

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MonitorDimension': (<class 'str'>, False), 'MonitorName': (<class 'str'>, True),'MonitorSpecification': (<class 'str'>, False), 'MonitorType': (<class 'str'>,True), 'ResourceTags': ([<class 'troposphere.ce.ResourceTag'>], False)}

resource_type: Optional[str] = 'AWS::CE::AnomalyMonitor'

class troposphere.ce.AnomalySubscription(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

AnomalySubscription

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Frequency': (<class 'str'>, True), 'MonitorArnList': ([<class 'str'>], True),'ResourceTags': ([<class 'troposphere.ce.ResourceTag'>], False), 'Subscribers':([<class 'troposphere.ce.Subscriber'>], True), 'SubscriptionName': (<class 'str'>,True), 'Threshold': (<function double>, True)}

158 Chapter 7. Licensing

Page 163: Release 3.1

troposphere Documentation, Release 4.0.1

resource_type: Optional[str] = 'AWS::CE::AnomalySubscription'

class troposphere.ce.CostCategory(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

CostCategory

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DefaultValue': (<class 'str'>, False), 'Name': (<class 'str'>, True),'RuleVersion': (<class 'str'>, True), 'Rules': (<class 'str'>, True),'SplitChargeRules': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::CE::CostCategory'

class troposphere.ce.ResourceTag(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ResourceTag

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.ce.Subscriber(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Subscriber

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Address': (<class 'str'>, True), 'Status': (<class 'str'>, False), 'Type':(<class 'str'>, True)}

troposphere.certificatemanager module

class troposphere.certificatemanager.Account(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

Account

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ExpiryEventsConfiguration': (<class'troposphere.certificatemanager.ExpiryEventsConfiguration'>, True)}

resource_type: Optional[str] = 'AWS::CertificateManager::Account'

class troposphere.certificatemanager.Certificate(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Certificate

7.3. troposphere 159

Page 164: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateAuthorityArn': (<class 'str'>, False),'CertificateTransparencyLoggingPreference': (<class 'str'>, False), 'DomainName':(<class 'str'>, True), 'DomainValidationOptions': ([<class'troposphere.certificatemanager.DomainValidationOption'>], False),'SubjectAlternativeNames': ([<class 'str'>], False), 'Tags': (<functionvalidate_tags_or_list>, False), 'ValidationMethod': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::CertificateManager::Certificate'

class troposphere.certificatemanager.DomainValidationOption(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

DomainValidationOption

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DomainName': (<class 'str'>, True), 'HostedZoneId': (<class 'str'>, False),'ValidationDomain': (<class 'str'>, False)}

class troposphere.certificatemanager.ExpiryEventsConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ExpiryEventsConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DaysBeforeExpiry': (<function integer>, False)}

troposphere.chatbot module

class troposphere.chatbot.SlackChannelConfiguration(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

SlackChannelConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConfigurationName': (<class 'str'>, True), 'GuardrailPolicies': ([<class'str'>], False), 'IamRoleArn': (<class 'str'>, True), 'LoggingLevel': (<functionvalidate_logginglevel>, False), 'SlackChannelId': (<class 'str'>, True),'SlackWorkspaceId': (<class 'str'>, True), 'SnsTopicArns': ([<class 'str'>],False), 'UserRoleRequired': (<function boolean>, False)}

resource_type: Optional[str] = 'AWS::Chatbot::SlackChannelConfiguration'

160 Chapter 7. Licensing

Page 165: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.cloud9 module

class troposphere.cloud9.EnvironmentEC2(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

EnvironmentEC2

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutomaticStopTimeMinutes': (<function integer>, False), 'ConnectionType':(<class 'str'>, False), 'Description': (<class 'str'>, False), 'ImageId': (<class'str'>, False), 'InstanceType': (<class 'str'>, True), 'Name': (<class 'str'>,False), 'OwnerArn': (<class 'str'>, False), 'Repositories': ([<class'troposphere.cloud9.Repository'>], False), 'SubnetId': (<class 'str'>, False),'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::Cloud9::EnvironmentEC2'

class troposphere.cloud9.Repository(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Repository

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PathComponent': (<class 'str'>, True), 'RepositoryUrl': (<class 'str'>, True)}

troposphere.cloudformation module

class troposphere.cloudformation.AutoDeployment(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AutoDeployment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False), 'RetainStacksOnAccountRemoval':(<function boolean>, False)}

class troposphere.cloudformation.CustomResource(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

CustomResource

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ServiceToken': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::CloudFormation::CustomResource'

class troposphere.cloudformation.DeploymentTargets(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DeploymentTargets

7.3. troposphere 161

Page 166: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Accounts': ([<class 'str'>], False), 'OrganizationalUnitIds': ([<class 'str'>],False)}

class troposphere.cloudformation.HookDefaultVersion(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

HookDefaultVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TypeName': (<class 'str'>, False), 'TypeVersionArn': (<class 'str'>, False),'VersionId': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::CloudFormation::HookDefaultVersion'

class troposphere.cloudformation.HookTypeConfig(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

HookTypeConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Configuration': (<class 'str'>, True), 'ConfigurationAlias': (<class 'str'>,False), 'TypeArn': (<class 'str'>, False), 'TypeName': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::CloudFormation::HookTypeConfig'

class troposphere.cloudformation.HookVersion(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

HookVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ExecutionRoleArn': (<class 'str'>, False), 'LoggingConfig': (<class'troposphere.cloudformation.LoggingConfig'>, False), 'SchemaHandlerPackage':(<class 'str'>, True), 'TypeName': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::CloudFormation::HookVersion'

class troposphere.cloudformation.LoggingConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LoggingConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LogGroupName': (<class 'str'>, False), 'LogRoleArn': (<class 'str'>, False)}

class troposphere.cloudformation.Macro(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Macro

162 Chapter 7. Licensing

Page 167: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'FunctionName': (<class 'str'>, True),'LogGroupName': (<class 'str'>, False), 'LogRoleARN': (<class 'str'>, False),'Name': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::CloudFormation::Macro'

class troposphere.cloudformation.ModuleDefaultVersion(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ModuleDefaultVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Arn':(<class 'str'>, False), 'ModuleName': (<class 'str'>, False), 'VersionId': (<class'str'>, False)}

resource_type: Optional[str] = 'AWS::CloudFormation::ModuleDefaultVersion'

class troposphere.cloudformation.ModuleVersion(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ModuleVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ModuleName': (<class 'str'>, True), 'ModulePackage': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::CloudFormation::ModuleVersion'

class troposphere.cloudformation.OperationPreferences(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OperationPreferences

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FailureToleranceCount': (<function integer>, False),'FailureTolerancePercentage': (<function integer>, False), 'MaxConcurrentCount':(<function integer>, False), 'MaxConcurrentPercentage': (<function integer>,False), 'RegionConcurrencyType': (<class 'str'>, False), 'RegionOrder': ([<class'str'>], False)}

class troposphere.cloudformation.Parameter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Parameter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ParameterKey': (<class 'str'>, True), 'ParameterValue': (<class 'str'>, True)}

class troposphere.cloudformation.PublicTypeVersion(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

7.3. troposphere 163

Page 168: Release 3.1

troposphere Documentation, Release 4.0.1

PublicTypeVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Arn':(<class 'str'>, False), 'LogDeliveryBucket': (<class 'str'>, False),'PublicVersionNumber': (<class 'str'>, False), 'Type': (<class 'str'>, False),'TypeName': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::CloudFormation::PublicTypeVersion'

class troposphere.cloudformation.Publisher(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

Publisher

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AcceptTermsAndConditions': (<function boolean>, True), 'ConnectionArn': (<class'str'>, False)}

resource_type: Optional[str] = 'AWS::CloudFormation::Publisher'

class troposphere.cloudformation.ResourceDefaultVersion(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ResourceDefaultVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TypeName': (<class 'str'>, False), 'TypeVersionArn': (<class 'str'>, False),'VersionId': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::CloudFormation::ResourceDefaultVersion'

class troposphere.cloudformation.ResourceVersion(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ResourceVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ExecutionRoleArn': (<class 'str'>, False), 'LoggingConfig': (<class'troposphere.cloudformation.LoggingConfig'>, False), 'SchemaHandlerPackage':(<class 'str'>, True), 'TypeName': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::CloudFormation::ResourceVersion'

class troposphere.cloudformation.Stack(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Stack

164 Chapter 7. Licensing

Page 169: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'NotificationARNs': ([<class 'str'>], False), 'Parameters': (<class 'dict'>,False), 'Tags': (<class 'troposphere.Tags'>, False), 'TemplateURL': (<class 'str'>,True), 'TimeoutInMinutes': (<function integer>, False)}

resource_type: Optional[str] = 'AWS::CloudFormation::Stack'

class troposphere.cloudformation.StackInstances(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

StackInstances

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeploymentTargets': (<class 'troposphere.cloudformation.DeploymentTargets'>,True), 'ParameterOverrides': ([<class 'troposphere.cloudformation.Parameter'>],False), 'Regions': ([<class 'str'>], True)}

class troposphere.cloudformation.StackSet(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

StackSet

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AdministrationRoleARN': (<class 'str'>, False), 'AutoDeployment': (<class'troposphere.cloudformation.AutoDeployment'>, False), 'CallAs': (<class 'str'>,False), 'Capabilities': ([<class 'str'>], False), 'Description': (<class 'str'>,False), 'ExecutionRoleName': (<class 'str'>, False), 'ManagedExecution': (<class'dict'>, False), 'OperationPreferences': (<class'troposphere.cloudformation.OperationPreferences'>, False), 'Parameters': ([<class'troposphere.cloudformation.Parameter'>], False), 'PermissionModel': (<class'str'>, True), 'StackInstancesGroup': ([<class'troposphere.cloudformation.StackInstances'>], False), 'StackSetName': (<class'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False), 'TemplateBody':(<class 'str'>, False), 'TemplateURL': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::CloudFormation::StackSet'

class troposphere.cloudformation.TypeActivation(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

TypeActivation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoUpdate': (<function boolean>, False), 'ExecutionRoleArn': (<class 'str'>,False), 'LoggingConfig': (<class 'troposphere.cloudformation.LoggingConfig'>,False), 'MajorVersion': (<class 'str'>, False), 'PublicTypeArn': (<class 'str'>,False), 'PublisherId': (<class 'str'>, False), 'Type': (<class 'str'>, False),'TypeName': (<class 'str'>, False), 'TypeNameAlias': (<class 'str'>, False),'VersionBump': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::CloudFormation::TypeActivation'

7.3. troposphere 165

Page 170: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.cloudformation.WaitCondition(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

WaitCondition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Count': (<function integer>, False), 'Handle': (<class 'str'>, False),'Timeout': (<function validate_int_to_str>, False)}

resource_type: Optional[str] = 'AWS::CloudFormation::WaitCondition'

validate()

class troposphere.cloudformation.WaitConditionHandle(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

WaitConditionHandle

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {}

resource_type: Optional[str] = 'AWS::CloudFormation::WaitConditionHandle'

troposphere.cloudfront module

class troposphere.cloudfront.AccessControlAllowHeaders(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AccessControlAllowHeaders

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Items': ([<class 'str'>], True)}

class troposphere.cloudfront.AccessControlAllowMethods(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AccessControlAllowMethods

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Items': (<function cloudfront_access_control_allow_methods>, True)}

class troposphere.cloudfront.AccessControlAllowOrigins(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AccessControlAllowOrigins

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Items': ([<class 'str'>], True)}

class troposphere.cloudfront.AccessControlExposeHeaders(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

AccessControlExposeHeaders

166 Chapter 7. Licensing

Page 171: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Items': ([<class 'str'>], True)}

class troposphere.cloudfront.CacheBehavior(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CacheBehavior

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllowedMethods': ([<class 'str'>], False), 'CachePolicyId': (<class 'str'>,False), 'CachedMethods': ([<class 'str'>], False), 'Compress': (<functionboolean>, False), 'DefaultTTL': (<function double>, False),'FieldLevelEncryptionId': (<class 'str'>, False), 'ForwardedValues': (<class'troposphere.cloudfront.ForwardedValues'>, False), 'FunctionAssociations': ([<class'troposphere.cloudfront.FunctionAssociation'>], False),'LambdaFunctionAssociations': ([<class'troposphere.cloudfront.LambdaFunctionAssociation'>], False), 'MaxTTL': (<functiondouble>, False), 'MinTTL': (<function double>, False), 'OriginRequestPolicyId':(<class 'str'>, False), 'PathPattern': (<class 'str'>, True),'RealtimeLogConfigArn': (<class 'str'>, False), 'ResponseHeadersPolicyId': (<class'str'>, False), 'SmoothStreaming': (<function boolean>, False), 'TargetOriginId':(<class 'str'>, True), 'TrustedKeyGroups': ([<class 'str'>], False),'TrustedSigners': ([<class 'str'>], False), 'ViewerProtocolPolicy': (<functioncloudfront_viewer_protocol_policy>, True)}

class troposphere.cloudfront.CacheCookiesConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CacheCookiesConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CookieBehavior': (<function cloudfront_cache_cookie_behavior>, True), 'Cookies':([<class 'str'>], False)}

class troposphere.cloudfront.CacheHeadersConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CacheHeadersConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HeaderBehavior': (<function cloudfront_cache_header_behavior>, True), 'Headers':([<class 'str'>], False)}

class troposphere.cloudfront.CachePolicy(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

CachePolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CachePolicyConfig': (<class 'troposphere.cloudfront.CachePolicyConfig'>, True)}

resource_type: Optional[str] = 'AWS::CloudFront::CachePolicy'

class troposphere.cloudfront.CachePolicyConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 167

Page 172: Release 3.1

troposphere Documentation, Release 4.0.1

CachePolicyConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Comment': (<class 'str'>, False), 'DefaultTTL': (<function double>, True),'MaxTTL': (<function double>, True), 'MinTTL': (<function double>, True), 'Name':(<class 'str'>, True), 'ParametersInCacheKeyAndForwardedToOrigin': (<class'troposphere.cloudfront.ParametersInCacheKeyAndForwardedToOrigin'>, True)}

class troposphere.cloudfront.CacheQueryStringsConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CacheQueryStringsConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'QueryStringBehavior': (<function cloudfront_cache_query_string_behavior>, True),'QueryStrings': ([<class 'str'>], False)}

class troposphere.cloudfront.CloudFrontOriginAccessIdentity(title: Optional[str], template:Optional[troposphere.Template] =None, validation: bool = True,**kwargs: Any)

Bases: troposphere.AWSObject

CloudFrontOriginAccessIdentity

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudFrontOriginAccessIdentityConfig': (<class'troposphere.cloudfront.CloudFrontOriginAccessIdentityConfig'>, True)}

resource_type: Optional[str] = 'AWS::CloudFront::CloudFrontOriginAccessIdentity'

class troposphere.cloudfront.CloudFrontOriginAccessIdentityConfig(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

CloudFrontOriginAccessIdentityConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Comment': (<class 'str'>, True)}

class troposphere.cloudfront.ContentSecurityPolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ContentSecurityPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContentSecurityPolicy': (<class 'str'>, True), 'Override': (<function boolean>,True)}

class troposphere.cloudfront.ContentTypeOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ContentTypeOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Override': (<function boolean>, True)}

168 Chapter 7. Licensing

Page 173: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.cloudfront.Cookies(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Cookies

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Forward': (<function cloudfront_forward_type>, True), 'WhitelistedNames':([<class 'str'>], False)}

class troposphere.cloudfront.CorsConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CorsConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessControlAllowCredentials': (<function boolean>, True),'AccessControlAllowHeaders': (<class'troposphere.cloudfront.AccessControlAllowHeaders'>, True),'AccessControlAllowMethods': (<class'troposphere.cloudfront.AccessControlAllowMethods'>, True),'AccessControlAllowOrigins': (<class'troposphere.cloudfront.AccessControlAllowOrigins'>, True),'AccessControlExposeHeaders': (<class'troposphere.cloudfront.AccessControlExposeHeaders'>, False),'AccessControlMaxAgeSec': (<function integer>, False), 'OriginOverride':(<function boolean>, True)}

class troposphere.cloudfront.CustomErrorResponse(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CustomErrorResponse

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ErrorCachingMinTTL': (<function double>, False), 'ErrorCode': (<functioninteger>, True), 'ResponseCode': (<function integer>, False), 'ResponsePagePath':(<class 'str'>, False)}

class troposphere.cloudfront.CustomHeader(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CustomHeader

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Header': (<class 'str'>, True), 'Override': (<function boolean>, True), 'Value':(<class 'str'>, True)}

class troposphere.cloudfront.CustomHeadersConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CustomHeadersConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Items': ([<class 'troposphere.cloudfront.CustomHeader'>], True)}

class troposphere.cloudfront.CustomOriginConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 169

Page 174: Release 3.1

troposphere Documentation, Release 4.0.1

CustomOriginConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HTTPPort': (<function validate_network_port>, False), 'HTTPSPort': (<functionvalidate_network_port>, False), 'OriginKeepaliveTimeout': (<function integer>,False), 'OriginProtocolPolicy': (<class 'str'>, True), 'OriginReadTimeout':(<function integer>, False), 'OriginSSLProtocols': ([<class 'str'>], False)}

class troposphere.cloudfront.DefaultCacheBehavior(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DefaultCacheBehavior

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllowedMethods': ([<class 'str'>], False), 'CachePolicyId': (<class 'str'>,False), 'CachedMethods': ([<class 'str'>], False), 'Compress': (<functionboolean>, False), 'DefaultTTL': (<function double>, False),'FieldLevelEncryptionId': (<class 'str'>, False), 'ForwardedValues': (<class'troposphere.cloudfront.ForwardedValues'>, False), 'FunctionAssociations': ([<class'troposphere.cloudfront.FunctionAssociation'>], False),'LambdaFunctionAssociations': ([<class'troposphere.cloudfront.LambdaFunctionAssociation'>], False), 'MaxTTL': (<functiondouble>, False), 'MinTTL': (<function double>, False), 'OriginRequestPolicyId':(<class 'str'>, False), 'RealtimeLogConfigArn': (<class 'str'>, False),'ResponseHeadersPolicyId': (<class 'str'>, False), 'SmoothStreaming': (<functionboolean>, False), 'TargetOriginId': (<class 'str'>, True), 'TrustedKeyGroups':([<class 'str'>], False), 'TrustedSigners': ([<class 'str'>], False),'ViewerProtocolPolicy': (<function cloudfront_viewer_protocol_policy>, True)}

class troposphere.cloudfront.Distribution(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

Distribution

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DistributionConfig': (<class 'troposphere.cloudfront.DistributionConfig'>, True),'Tags': (<function validate_tags_or_list>, False)}

resource_type: Optional[str] = 'AWS::CloudFront::Distribution'

class troposphere.cloudfront.DistributionConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DistributionConfig

170 Chapter 7. Licensing

Page 175: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Aliases': ([<class 'str'>], False), 'CNAMEs': ([<class 'str'>], False),'CacheBehaviors': ([<class 'troposphere.cloudfront.CacheBehavior'>], False),'Comment': (<class 'str'>, False), 'CustomErrorResponses': ([<class'troposphere.cloudfront.CustomErrorResponse'>], False), 'CustomOrigin': (<class'troposphere.cloudfront.LegacyCustomOrigin'>, False), 'DefaultCacheBehavior':(<class 'troposphere.cloudfront.DefaultCacheBehavior'>, False), 'DefaultRootObject':(<class 'str'>, False), 'Enabled': (<function boolean>, True), 'HttpVersion':(<class 'str'>, False), 'IPV6Enabled': (<function boolean>, False), 'Logging':(<class 'troposphere.cloudfront.Logging'>, False), 'OriginGroups': (<class'troposphere.cloudfront.OriginGroups'>, False), 'Origins': ([<class'troposphere.cloudfront.Origin'>], False), 'PriceClass': (<functionpriceclass_type>, False), 'Restrictions': (<class'troposphere.cloudfront.Restrictions'>, False), 'S3Origin': (<class'troposphere.cloudfront.LegacyS3Origin'>, False), 'ViewerCertificate': (<class'troposphere.cloudfront.ViewerCertificate'>, False), 'WebACLId': (<class 'str'>,False)}

class troposphere.cloudfront.EndPoint(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EndPoint

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KinesisStreamConfig': (<class 'troposphere.cloudfront.KinesisStreamConfig'>,True), 'StreamType': (<class 'str'>, True)}

class troposphere.cloudfront.ForwardedValues(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ForwardedValues

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Cookies': (<class 'troposphere.cloudfront.Cookies'>, False), 'Headers': ([<class'str'>], False), 'QueryString': (<function boolean>, True), 'QueryStringCacheKeys':([<class 'str'>], False)}

class troposphere.cloudfront.FrameOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FrameOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FrameOption': (<function cloudfront_frame_option>, True), 'Override': (<functionboolean>, True)}

class troposphere.cloudfront.Function(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Function

7.3. troposphere 171

Page 176: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoPublish': (<function boolean>, False), 'FunctionCode': (<class 'str'>,False), 'FunctionConfig': (<class 'troposphere.cloudfront.FunctionConfig'>, False),'FunctionMetadata': (<class 'troposphere.cloudfront.FunctionMetadata'>, False),'Name': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::CloudFront::Function'

class troposphere.cloudfront.FunctionAssociation(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FunctionAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EventType': (<class 'str'>, False), 'FunctionARN': (<class 'str'>, False)}

class troposphere.cloudfront.FunctionConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FunctionConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Comment': (<class 'str'>, True), 'Runtime': (<class 'str'>, True)}

class troposphere.cloudfront.FunctionMetadata(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FunctionMetadata

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FunctionARN': (<class 'str'>, False)}

class troposphere.cloudfront.GeoRestriction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GeoRestriction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Locations': ([<class 'str'>], False), 'RestrictionType': (<functioncloudfront_restriction_type>, True)}

class troposphere.cloudfront.KeyGroup(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

KeyGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KeyGroupConfig': (<class 'troposphere.cloudfront.KeyGroupConfig'>, True)}

resource_type: Optional[str] = 'AWS::CloudFront::KeyGroup'

class troposphere.cloudfront.KeyGroupConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KeyGroupConfig

172 Chapter 7. Licensing

Page 177: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Comment': (<class 'str'>, False), 'Items': ([<class 'str'>], True), 'Name':(<class 'str'>, True)}

class troposphere.cloudfront.KinesisStreamConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KinesisStreamConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RoleArn': (<class 'str'>, True), 'StreamArn': (<class 'str'>, True)}

class troposphere.cloudfront.LambdaFunctionAssociation(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LambdaFunctionAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EventType': (<function cloudfront_event_type>, False), 'IncludeBody': (<functionboolean>, False), 'LambdaFunctionARN': (<class 'str'>, False)}

class troposphere.cloudfront.LegacyCustomOrigin(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LegacyCustomOrigin

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DNSName': (<class 'str'>, True), 'HTTPPort': (<function integer>, False),'HTTPSPort': (<function integer>, False), 'OriginProtocolPolicy': (<class 'str'>,True), 'OriginSSLProtocols': ([<class 'str'>], True)}

class troposphere.cloudfront.LegacyS3Origin(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LegacyS3Origin

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DNSName': (<class 'str'>, True), 'OriginAccessIdentity': (<class 'str'>, False)}

class troposphere.cloudfront.Logging(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Logging

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Bucket': (<class 'str'>, True), 'IncludeCookies': (<function boolean>, False),'Prefix': (<class 'str'>, False)}

class troposphere.cloudfront.Origin(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Origin

7.3. troposphere 173

Page 178: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectionAttempts': (<function integer>, False), 'ConnectionTimeout':(<function integer>, False), 'CustomOriginConfig': (<class'troposphere.cloudfront.CustomOriginConfig'>, False), 'DomainName': (<class 'str'>,True), 'Id': (<class 'str'>, True), 'OriginCustomHeaders': ([<class'troposphere.cloudfront.OriginCustomHeader'>], False), 'OriginPath': (<class'str'>, False), 'OriginShield': (<class 'troposphere.cloudfront.OriginShield'>,False), 'S3OriginConfig': (<class 'troposphere.cloudfront.S3OriginConfig'>, False)}

class troposphere.cloudfront.OriginCustomHeader(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OriginCustomHeader

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HeaderName': (<class 'str'>, True), 'HeaderValue': (<class 'str'>, True)}

class troposphere.cloudfront.OriginGroup(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OriginGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FailoverCriteria': (<class 'troposphere.cloudfront.OriginGroupFailoverCriteria'>,True), 'Id': (<class 'str'>, True), 'Members': (<class'troposphere.cloudfront.OriginGroupMembers'>, True)}

class troposphere.cloudfront.OriginGroupFailoverCriteria(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

OriginGroupFailoverCriteria

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'StatusCodes': (<class 'troposphere.cloudfront.StatusCodes'>, True)}

class troposphere.cloudfront.OriginGroupMember(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OriginGroupMember

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'OriginId': (<class 'str'>, True)}

class troposphere.cloudfront.OriginGroupMembers(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OriginGroupMembers

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Items': ([<class 'troposphere.cloudfront.OriginGroupMember'>], True), 'Quantity':(<function integer>, True)}

class troposphere.cloudfront.OriginGroups(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

174 Chapter 7. Licensing

Page 179: Release 3.1

troposphere Documentation, Release 4.0.1

OriginGroups

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Items': ([<class 'troposphere.cloudfront.OriginGroup'>], False), 'Quantity':(<function integer>, True)}

class troposphere.cloudfront.OriginRequestCookiesConfig(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

OriginRequestCookiesConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CookieBehavior': (<function cloudfront_origin_request_cookie_behavior>, True),'Cookies': ([<class 'str'>], False)}

class troposphere.cloudfront.OriginRequestHeadersConfig(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

OriginRequestHeadersConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HeaderBehavior': (<function cloudfront_origin_request_header_behavior>, True),'Headers': ([<class 'str'>], False)}

class troposphere.cloudfront.OriginRequestPolicy(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

OriginRequestPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'OriginRequestPolicyConfig': (<class'troposphere.cloudfront.OriginRequestPolicyConfig'>, True)}

resource_type: Optional[str] = 'AWS::CloudFront::OriginRequestPolicy'

class troposphere.cloudfront.OriginRequestPolicyConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OriginRequestPolicyConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Comment': (<class 'str'>, False), 'CookiesConfig': (<class'troposphere.cloudfront.OriginRequestCookiesConfig'>, True), 'HeadersConfig':(<class 'troposphere.cloudfront.OriginRequestHeadersConfig'>, True), 'Name':(<class 'str'>, True), 'QueryStringsConfig': (<class'troposphere.cloudfront.OriginRequestQueryStringsConfig'>, True)}

class troposphere.cloudfront.OriginRequestQueryStringsConfig(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

OriginRequestQueryStringsConfig

7.3. troposphere 175

Page 180: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'QueryStringBehavior': (<functioncloudfront_origin_request_query_string_behavior>, True), 'QueryStrings': ([<class'str'>], False)}

class troposphere.cloudfront.OriginShield(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OriginShield

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False), 'OriginShieldRegion': (<class 'str'>,False)}

class troposphere.cloudfront.ParametersInCacheKeyAndForwardedToOrigin(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

ParametersInCacheKeyAndForwardedToOrigin

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CookiesConfig': (<class 'troposphere.cloudfront.CacheCookiesConfig'>, True),'EnableAcceptEncodingBrotli': (<function boolean>, False),'EnableAcceptEncodingGzip': (<function boolean>, True), 'HeadersConfig': (<class'troposphere.cloudfront.CacheHeadersConfig'>, True), 'QueryStringsConfig': (<class'troposphere.cloudfront.CacheQueryStringsConfig'>, True)}

class troposphere.cloudfront.PublicKey(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

PublicKey

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PublicKeyConfig': (<class 'troposphere.cloudfront.PublicKeyConfig'>, True)}

resource_type: Optional[str] = 'AWS::CloudFront::PublicKey'

class troposphere.cloudfront.PublicKeyConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PublicKeyConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CallerReference': (<class 'str'>, True), 'Comment': (<class 'str'>, False),'EncodedKey': (<class 'str'>, True), 'Name': (<class 'str'>, True)}

class troposphere.cloudfront.RealtimeLogConfig(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

RealtimeLogConfig

176 Chapter 7. Licensing

Page 181: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EndPoints': ([<class 'troposphere.cloudfront.EndPoint'>], True), 'Fields':([<class 'str'>], True), 'Name': (<class 'str'>, True), 'SamplingRate': (<functiondouble>, True)}

resource_type: Optional[str] = 'AWS::CloudFront::RealtimeLogConfig'

class troposphere.cloudfront.ReferrerPolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ReferrerPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Override': (<function boolean>, True), 'ReferrerPolicy': (<functioncloudfront_referrer_policy>, True)}

class troposphere.cloudfront.ResponseHeadersPolicy(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ResponseHeadersPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ResponseHeadersPolicyConfig': (<class'troposphere.cloudfront.ResponseHeadersPolicyConfig'>, True)}

resource_type: Optional[str] = 'AWS::CloudFront::ResponseHeadersPolicy'

class troposphere.cloudfront.ResponseHeadersPolicyConfig(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

ResponseHeadersPolicyConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Comment': (<class 'str'>, False), 'CorsConfig': (<class'troposphere.cloudfront.CorsConfig'>, False), 'CustomHeadersConfig': (<class'troposphere.cloudfront.CustomHeadersConfig'>, False), 'Name': (<class 'str'>,True), 'SecurityHeadersConfig': (<class'troposphere.cloudfront.SecurityHeadersConfig'>, False)}

class troposphere.cloudfront.Restrictions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Restrictions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GeoRestriction': (<class 'troposphere.cloudfront.GeoRestriction'>, True)}

class troposphere.cloudfront.S3Origin(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3Origin

7.3. troposphere 177

Page 182: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DomainName': (<class 'str'>, True), 'OriginAccessIdentity': (<class 'str'>,False)}

class troposphere.cloudfront.S3OriginConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3OriginConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'OriginAccessIdentity': (<class 'str'>, False)}

class troposphere.cloudfront.SecurityHeadersConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SecurityHeadersConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContentSecurityPolicy': (<class 'troposphere.cloudfront.ContentSecurityPolicy'>,False), 'ContentTypeOptions': (<class 'troposphere.cloudfront.ContentTypeOptions'>,False), 'FrameOptions': (<class 'troposphere.cloudfront.FrameOptions'>, False),'ReferrerPolicy': (<class 'troposphere.cloudfront.ReferrerPolicy'>, False),'StrictTransportSecurity': (<class'troposphere.cloudfront.StrictTransportSecurity'>, False), 'XSSProtection': (<class'troposphere.cloudfront.XSSProtection'>, False)}

class troposphere.cloudfront.StatusCodes(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

StatusCodes

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Items': ([<function integer>], True), 'Quantity': (<function integer>, True)}

class troposphere.cloudfront.StreamingDistribution(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

StreamingDistribution

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'StreamingDistributionConfig': (<class'troposphere.cloudfront.StreamingDistributionConfig'>, True), 'Tags': (<functionvalidate_tags_or_list>, False)}

resource_type: Optional[str] = 'AWS::CloudFront::StreamingDistribution'

class troposphere.cloudfront.StreamingDistributionConfig(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

StreamingDistributionConfig

178 Chapter 7. Licensing

Page 183: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Aliases': ([<class 'str'>], False), 'Comment': (<class 'str'>, True), 'Enabled':(<function boolean>, True), 'Logging': (<class'troposphere.cloudfront.StreamingDistributioniLogging'>, False), 'PriceClass':(<function priceclass_type>, False), 'S3Origin': (<class'troposphere.cloudfront.S3Origin'>, True), 'TrustedSigners': (<class'troposphere.cloudfront.TrustedSigners'>, True)}

class troposphere.cloudfront.StreamingDistributioniLogging(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

StreamingDistributioniLogging

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Bucket': (<class 'str'>, True), 'Enabled': (<function boolean>, True), 'Prefix':(<class 'str'>, True)}

class troposphere.cloudfront.StrictTransportSecurity(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

StrictTransportSecurity

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessControlMaxAgeSec': (<function integer>, True), 'IncludeSubdomains':(<function boolean>, False), 'Override': (<function boolean>, True), 'Preload':(<function boolean>, False)}

class troposphere.cloudfront.TrustedSigners(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TrustedSigners

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AwsAccountNumbers': ([<class 'str'>], False), 'Enabled': (<function boolean>,True)}

class troposphere.cloudfront.ViewerCertificate(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ViewerCertificate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AcmCertificateArn': (<class 'str'>, False), 'CloudFrontDefaultCertificate':(<function boolean>, False), 'IamCertificateId': (<class 'str'>, False),'MinimumProtocolVersion': (<class 'str'>, False), 'SslSupportMethod': (<class'str'>, False)}

class troposphere.cloudfront.XSSProtection(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

XSSProtection

7.3. troposphere 179

Page 184: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ModeBlock': (<function boolean>, False), 'Override': (<function boolean>, True),'Protection': (<function boolean>, True), 'ReportUri': (<class 'str'>, False)}

troposphere.cloudtrail module

class troposphere.cloudtrail.DataResource(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DataResource

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Type': (<class 'str'>, True), 'Values': ([<class 'str'>], False)}

class troposphere.cloudtrail.EventSelector(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EventSelector

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DataResources': ([<class 'troposphere.cloudtrail.DataResource'>], False),'ExcludeManagementEventSources': ([<class 'str'>], False),'IncludeManagementEvents': (<function boolean>, False), 'ReadWriteType': (<class'str'>, False)}

class troposphere.cloudtrail.InsightSelector(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InsightSelector

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InsightType': (<class 'str'>, False)}

class troposphere.cloudtrail.Trail(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Trail

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudWatchLogsLogGroupArn': (<class 'str'>, False), 'CloudWatchLogsRoleArn':(<class 'str'>, False), 'EnableLogFileValidation': (<function boolean>, False),'EventSelectors': ([<class 'troposphere.cloudtrail.EventSelector'>], False),'IncludeGlobalServiceEvents': (<function boolean>, False), 'InsightSelectors':([<class 'troposphere.cloudtrail.InsightSelector'>], False), 'IsLogging':(<function boolean>, True), 'IsMultiRegionTrail': (<function boolean>, False),'IsOrganizationTrail': (<function boolean>, False), 'KMSKeyId': (<class 'str'>,False), 'S3BucketName': (<class 'str'>, True), 'S3KeyPrefix': (<class 'str'>,False), 'SnsTopicName': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False), 'TrailName': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::CloudTrail::Trail'

180 Chapter 7. Licensing

Page 185: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.cloudwatch module

class troposphere.cloudwatch.Alarm(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Alarm

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ActionsEnabled': (<function boolean>, False), 'AlarmActions': ([<class 'str'>],False), 'AlarmDescription': (<class 'str'>, False), 'AlarmName': (<class 'str'>,False), 'ComparisonOperator': (<class 'str'>, True), 'DatapointsToAlarm':(<function integer>, False), 'Dimensions': ([<class'troposphere.cloudwatch.MetricDimension'>], False),'EvaluateLowSampleCountPercentile': (<class 'str'>, False), 'EvaluationPeriods':(<function integer>, True), 'ExtendedStatistic': (<class 'str'>, False),'InsufficientDataActions': ([<class 'str'>], False), 'MetricName': (<class 'str'>,False), 'Metrics': ([<class 'troposphere.cloudwatch.MetricDataQuery'>], False),'Namespace': (<class 'str'>, False), 'OKActions': ([<class 'str'>], False),'Period': (<function integer>, False), 'Statistic': (<class 'str'>, False),'Threshold': (<function double>, False), 'ThresholdMetricId': (<class 'str'>,False), 'TreatMissingData': (<function validate_treat_missing_data>, False),'Unit': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::CloudWatch::Alarm'

validate()

class troposphere.cloudwatch.AnomalyDetector(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

AnomalyDetector

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Configuration': (<class 'troposphere.cloudwatch.Configuration'>, False),'Dimensions': ([<class 'troposphere.cloudwatch.MetricDimension'>], False),'MetricMathAnomalyDetector': (<class'troposphere.cloudwatch.MetricMathAnomalyDetector'>, False), 'MetricName': (<class'str'>, False), 'Namespace': (<class 'str'>, False), 'SingleMetricAnomalyDetector':(<class 'troposphere.cloudwatch.SingleMetricAnomalyDetector'>, False), 'Stat':(<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::CloudWatch::AnomalyDetector'

class troposphere.cloudwatch.CompositeAlarm(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

CompositeAlarm

7.3. troposphere 181

Page 186: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ActionsEnabled': (<function boolean>, False), 'AlarmActions': ([<class 'str'>],False), 'AlarmDescription': (<class 'str'>, False), 'AlarmName': (<class 'str'>,True), 'AlarmRule': (<class 'str'>, True), 'InsufficientDataActions': ([<class'str'>], False), 'OKActions': ([<class 'str'>], False)}

resource_type: Optional[str] = 'AWS::CloudWatch::CompositeAlarm'

class troposphere.cloudwatch.Configuration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Configuration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ExcludedTimeRanges': ([<class 'troposphere.cloudwatch.Range'>], False),'MetricTimeZone': (<class 'str'>, False)}

class troposphere.cloudwatch.Dashboard(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Dashboard

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DashboardBody': (<function dict_or_string>, True), 'DashboardName': (<class'str'>, False)}

resource_type: Optional[str] = 'AWS::CloudWatch::Dashboard'

validate()

class troposphere.cloudwatch.InsightRule(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

InsightRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RuleBody': (<class 'str'>, True), 'RuleName': (<class 'str'>, True),'RuleState': (<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::CloudWatch::InsightRule'

class troposphere.cloudwatch.Metric(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Metric

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Dimensions': ([<class 'troposphere.cloudwatch.MetricDimension'>], False),'MetricName': (<class 'str'>, True), 'Namespace': (<class 'str'>, True)}

class troposphere.cloudwatch.MetricDataQuery(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MetricDataQuery

182 Chapter 7. Licensing

Page 187: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccountId': (<class 'str'>, False), 'Expression': (<class 'str'>, False), 'Id':(<class 'str'>, True), 'Label': (<class 'str'>, False), 'MetricStat': (<class'troposphere.cloudwatch.MetricStat'>, False), 'Period': (<function integer>,False), 'ReturnData': (<function boolean>, False)}

class troposphere.cloudwatch.MetricDimension(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MetricDimension

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.cloudwatch.MetricMathAnomalyDetector(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MetricMathAnomalyDetector

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MetricDataQueries': ([<class 'troposphere.cloudwatch.MetricDataQuery'>], False)}

class troposphere.cloudwatch.MetricStat(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MetricStat

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Metric': (<class 'troposphere.cloudwatch.Metric'>, True), 'Period': (<functioninteger>, True), 'Stat': (<class 'str'>, True), 'Unit': (<function validate_unit>,False)}

class troposphere.cloudwatch.MetricStream(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

MetricStream

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ExcludeFilters': ([<class 'troposphere.cloudwatch.MetricStreamFilter'>], False),'FirehoseArn': (<class 'str'>, True), 'IncludeFilters': ([<class'troposphere.cloudwatch.MetricStreamFilter'>], False), 'Name': (<class 'str'>,False), 'OutputFormat': (<class 'str'>, True), 'RoleArn': (<class 'str'>, True),'StatisticsConfigurations': ([<class'troposphere.cloudwatch.MetricStreamStatisticsConfiguration'>], False), 'Tags':(<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::CloudWatch::MetricStream'

class troposphere.cloudwatch.MetricStreamFilter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MetricStreamFilter

7.3. troposphere 183

Page 188: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Namespace': (<class 'str'>, True)}

class troposphere.cloudwatch.MetricStreamStatisticsConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

MetricStreamStatisticsConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AdditionalStatistics': ([<class 'str'>], True), 'IncludeMetrics': ([<class'troposphere.cloudwatch.MetricStreamStatisticsMetric'>], True)}

class troposphere.cloudwatch.MetricStreamStatisticsMetric(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

MetricStreamStatisticsMetric

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MetricName': (<class 'str'>, True), 'Namespace': (<class 'str'>, True)}

class troposphere.cloudwatch.Range(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Range

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EndTime': (<class 'str'>, True), 'StartTime': (<class 'str'>, True)}

class troposphere.cloudwatch.SingleMetricAnomalyDetector(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

SingleMetricAnomalyDetector

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Dimensions': ([<class 'troposphere.cloudwatch.MetricDimension'>], False),'MetricName': (<class 'str'>, False), 'Namespace': (<class 'str'>, False), 'Stat':(<class 'str'>, False)}

troposphere.codeartifact module

class troposphere.codeartifact.Domain(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Domain

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DomainName': (<class 'str'>, True), 'EncryptionKey': (<class 'str'>, False),'PermissionsPolicyDocument': (<class 'dict'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::CodeArtifact::Domain'

184 Chapter 7. Licensing

Page 189: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.codeartifact.Repository(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

Repository

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'DomainName': (<class 'str'>, True),'DomainOwner': (<class 'str'>, False), 'ExternalConnections': ([<class 'str'>],False), 'PermissionsPolicyDocument': (<class 'dict'>, False), 'RepositoryName':(<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False), 'Upstreams':([<class 'str'>], False)}

resource_type: Optional[str] = 'AWS::CodeArtifact::Repository'

troposphere.codebuild module

class troposphere.codebuild.Artifacts(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Artifacts

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ArtifactIdentifier': (<class 'str'>, False), 'EncryptionDisabled': (<functionboolean>, False), 'Location': (<class 'str'>, False), 'Name': (<class 'str'>,False), 'NamespaceType': (<class 'str'>, False), 'OverrideArtifactName':(<function boolean>, False), 'Packaging': (<class 'str'>, False), 'Path': (<class'str'>, False), 'Type': (<class 'str'>, True)}

validate()

class troposphere.codebuild.BatchRestrictions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BatchRestrictions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComputeTypesAllowed': ([<class 'str'>], False), 'MaximumBuildsAllowed':(<function integer>, False)}

class troposphere.codebuild.BuildStatusConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BuildStatusConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Context': (<class 'str'>, False), 'TargetUrl': (<class 'str'>, False)}

class troposphere.codebuild.CloudWatchLogs(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CloudWatchLogs

7.3. troposphere 185

Page 190: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GroupName': (<class 'str'>, False), 'Status': (<function validate_status>,True), 'StreamName': (<class 'str'>, False)}

class troposphere.codebuild.Environment(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Environment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Certificate': (<class 'str'>, False), 'ComputeType': (<class 'str'>, True),'EnvironmentVariables': (<function validate_environmentvariable_or_list>, False),'Image': (<class 'str'>, True), 'ImagePullCredentialsType': (<functionvalidate_image_pull_credentials>, False), 'PrivilegedMode': (<function boolean>,False), 'RegistryCredential': (<class 'troposphere.codebuild.RegistryCredential'>,False), 'Type': (<class 'str'>, True)}

validate()

class troposphere.codebuild.EnvironmentVariable(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EnvironmentVariable

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'Type': (<class 'str'>, False), 'Value': (<class'str'>, True)}

validate()

class troposphere.codebuild.GitSubmodulesConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GitSubmodulesConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FetchSubmodules': (<function boolean>, True)}

class troposphere.codebuild.LogsConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LogsConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudWatchLogs': (<class 'troposphere.codebuild.CloudWatchLogs'>, False),'S3Logs': (<class 'troposphere.codebuild.S3Logs'>, False)}

class troposphere.codebuild.Project(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Project

186 Chapter 7. Licensing

Page 191: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Artifacts': (<class 'troposphere.codebuild.Artifacts'>, True), 'BadgeEnabled':(<function boolean>, False), 'BuildBatchConfig': (<class'troposphere.codebuild.ProjectBuildBatchConfig'>, False), 'Cache': (<class'troposphere.codebuild.ProjectCache'>, False), 'ConcurrentBuildLimit': (<functioninteger>, False), 'Description': (<class 'str'>, False), 'EncryptionKey': (<class'str'>, False), 'Environment': (<class 'troposphere.codebuild.Environment'>, True),'FileSystemLocations': ([<class'troposphere.codebuild.ProjectFileSystemLocation'>], False), 'LogsConfig': (<class'troposphere.codebuild.LogsConfig'>, False), 'Name': (<class 'str'>, False),'QueuedTimeoutInMinutes': (<function integer>, False), 'ResourceAccessRole':(<class 'str'>, False), 'SecondaryArtifacts': ([<class'troposphere.codebuild.Artifacts'>], False), 'SecondarySourceVersions': ([<class'troposphere.codebuild.ProjectSourceVersion'>], False), 'SecondarySources':([<class 'troposphere.codebuild.Source'>], False), 'ServiceRole': (<class 'str'>,True), 'Source': (<class 'troposphere.codebuild.Source'>, True), 'SourceVersion':(<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>, False),'TimeoutInMinutes': (<function integer>, False), 'Triggers': (<class'troposphere.codebuild.ProjectTriggers'>, False), 'Visibility': (<class 'str'>,False), 'VpcConfig': (<class 'troposphere.codebuild.VpcConfig'>, False)}

resource_type: Optional[str] = 'AWS::CodeBuild::Project'

class troposphere.codebuild.ProjectBuildBatchConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ProjectBuildBatchConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BatchReportMode': (<class 'str'>, False), 'CombineArtifacts': (<functionboolean>, False), 'Restrictions': (<class'troposphere.codebuild.BatchRestrictions'>, False), 'ServiceRole': (<class 'str'>,False), 'TimeoutInMins': (<function integer>, False)}

class troposphere.codebuild.ProjectCache(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ProjectCache

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Location': (<class 'str'>, False), 'Modes': ([<class 'str'>], False), 'Type':(<class 'str'>, True)}

validate()

class troposphere.codebuild.ProjectFileSystemLocation(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ProjectFileSystemLocation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Identifier': (<class 'str'>, True), 'Location': (<class 'str'>, True),'MountOptions': (<class 'str'>, False), 'MountPoint': (<class 'str'>, True),'Type': (<function validate_projectfilesystemlocation_type>, True)}

7.3. troposphere 187

Page 192: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.codebuild.ProjectSourceVersion(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ProjectSourceVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SourceIdentifier': (<class 'str'>, True), 'SourceVersion': (<class 'str'>,False)}

class troposphere.codebuild.ProjectTriggers(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ProjectTriggers

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BuildType': (<class 'str'>, False), 'FilterGroups': (<class 'list'>, False),'Webhook': (<function boolean>, False)}

validate()

class troposphere.codebuild.RegistryCredential(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RegistryCredential

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Credential': (<class 'str'>, True), 'CredentialProvider': (<functionvalidate_credentials_provider>, True)}

class troposphere.codebuild.ReportExportConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ReportExportConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ExportConfigType': (<class 'str'>, True), 'S3Destination': (<class'troposphere.codebuild.S3ReportExportConfig'>, False)}

class troposphere.codebuild.ReportGroup(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ReportGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeleteReports': (<function boolean>, False), 'ExportConfig': (<class'troposphere.codebuild.ReportExportConfig'>, True), 'Name': (<class 'str'>, False),'Tags': (<class 'troposphere.Tags'>, False), 'Type': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::CodeBuild::ReportGroup'

class troposphere.codebuild.S3Logs(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3Logs

188 Chapter 7. Licensing

Page 193: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EncryptionDisabled': (<function boolean>, False), 'Location': (<class 'str'>,False), 'Status': (<function validate_status>, True)}

class troposphere.codebuild.S3ReportExportConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3ReportExportConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Bucket': (<class 'str'>, True), 'BucketOwner': (<class 'str'>, False),'EncryptionDisabled': (<function boolean>, False), 'EncryptionKey': (<class'str'>, False), 'Packaging': (<class 'str'>, False), 'Path': (<class 'str'>,False)}

class troposphere.codebuild.Source(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Source

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Auth': (<class 'troposphere.codebuild.SourceAuth'>, False), 'BuildSpec': (<class'str'>, False), 'BuildStatusConfig': (<class'troposphere.codebuild.BuildStatusConfig'>, False), 'GitCloneDepth': (<functioninteger>, False), 'GitSubmodulesConfig': (<class'troposphere.codebuild.GitSubmodulesConfig'>, False), 'InsecureSsl': (<functionboolean>, False), 'Location': (<class 'str'>, False), 'ReportBuildStatus':(<function boolean>, False), 'SourceIdentifier': (<class 'str'>, False), 'Type':(<class 'str'>, True)}

validate()

class troposphere.codebuild.SourceAuth(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SourceAuth

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Resource': (<class 'str'>, False), 'Type': (<class 'str'>, True)}

validate()

class troposphere.codebuild.SourceCredential(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

SourceCredential

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthType': (<class 'str'>, True), 'ServerType': (<class 'str'>, True), 'Token':(<class 'str'>, True), 'Username': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::CodeBuild::SourceCredential'

7.3. troposphere 189

Page 194: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.codebuild.VpcConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VpcConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SecurityGroupIds': ([<class 'str'>], False), 'Subnets': ([<class 'str'>],False), 'VpcId': (<class 'str'>, False)}

class troposphere.codebuild.WebhookFilter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

WebhookFilter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ExcludeMatchedPattern': (<function boolean>, False), 'Pattern': (<class 'str'>,True), 'Type': (<function validate_webhookfilter_type>, True)}

troposphere.codecommit module

class troposphere.codecommit.Code(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Code

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BranchName': (<class 'str'>, False), 'S3': (<class 'troposphere.codecommit.S3'>,True)}

class troposphere.codecommit.Repository(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Repository

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Code': (<class 'troposphere.codecommit.Code'>, False), 'RepositoryDescription':(<class 'str'>, False), 'RepositoryName': (<class 'str'>, True), 'Tags': (<class'troposphere.Tags'>, False), 'Triggers': ([<class'troposphere.codecommit.Trigger'>], False)}

resource_type: Optional[str] = 'AWS::CodeCommit::Repository'

class troposphere.codecommit.S3(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Bucket': (<class 'str'>, True), 'Key': (<class 'str'>, True), 'ObjectVersion':(<class 'str'>, False)}

class troposphere.codecommit.Trigger(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Trigger

190 Chapter 7. Licensing

Page 195: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Branches': ([<class 'str'>], False), 'CustomData': (<class 'str'>, False),'DestinationArn': (<class 'str'>, True), 'Events': ([<class 'str'>], True),'Name': (<class 'str'>, True)}

validate()

troposphere.codedeploy module

class troposphere.codedeploy.Alarm(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Alarm

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False)}

class troposphere.codedeploy.AlarmConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AlarmConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Alarms': ([<class 'troposphere.codedeploy.Alarm'>], False), 'Enabled':(<function boolean>, False), 'IgnorePollAlarmFailure': (<function boolean>, False)}

class troposphere.codedeploy.Application(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Application

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationName': (<class 'str'>, False), 'ComputePlatform': (<class 'str'>,False), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::CodeDeploy::Application'

class troposphere.codedeploy.AutoRollbackConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AutoRollbackConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False), 'Events': ([<class 'str'>], False)}

class troposphere.codedeploy.BlueGreenDeploymentConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

BlueGreenDeploymentConfiguration

7.3. troposphere 191

Page 196: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeploymentReadyOption': (<class 'troposphere.codedeploy.DeploymentReadyOption'>,False), 'GreenFleetProvisioningOption': (<class'troposphere.codedeploy.GreenFleetProvisioningOption'>, False),'TerminateBlueInstancesOnDeploymentSuccess': (<class'troposphere.codedeploy.BlueInstanceTerminationOption'>, False)}

class troposphere.codedeploy.BlueInstanceTerminationOption(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

BlueInstanceTerminationOption

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Action': (<class 'str'>, False), 'TerminationWaitTimeInMinutes': (<functioninteger>, False)}

class troposphere.codedeploy.Deployment(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Deployment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'IgnoreApplicationStopFailures':(<function boolean>, False), 'Revision': (<class'troposphere.codedeploy.Revision'>, True)}

class troposphere.codedeploy.DeploymentConfig(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DeploymentConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComputePlatform': (<class 'str'>, False), 'DeploymentConfigName': (<class'str'>, False), 'MinimumHealthyHosts': (<class'troposphere.codedeploy.MinimumHealthyHosts'>, False), 'TrafficRoutingConfig':(<class 'troposphere.codedeploy.TrafficRoutingConfig'>, False)}

resource_type: Optional[str] = 'AWS::CodeDeploy::DeploymentConfig'

class troposphere.codedeploy.DeploymentGroup(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

DeploymentGroup

192 Chapter 7. Licensing

Page 197: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AlarmConfiguration': (<class 'troposphere.codedeploy.AlarmConfiguration'>,False), 'ApplicationName': (<class 'str'>, True), 'AutoRollbackConfiguration':(<class 'troposphere.codedeploy.AutoRollbackConfiguration'>, False),'AutoScalingGroups': ([<class 'str'>], False), 'BlueGreenDeploymentConfiguration':(<class 'troposphere.codedeploy.BlueGreenDeploymentConfiguration'>, False),'Deployment': (<class 'troposphere.codedeploy.Deployment'>, False),'DeploymentConfigName': (<class 'str'>, False), 'DeploymentGroupName': (<class'str'>, False), 'DeploymentStyle': (<class'troposphere.codedeploy.DeploymentStyle'>, False), 'ECSServices': ([<class'troposphere.codedeploy.ECSService'>], False), 'Ec2TagFilters': ([<class'troposphere.codedeploy.Ec2TagFilters'>], False), 'Ec2TagSet': (<class'troposphere.codedeploy.Ec2TagSet'>, False), 'LoadBalancerInfo': (<class'troposphere.codedeploy.LoadBalancerInfo'>, False), 'OnPremisesInstanceTagFilters':([<class 'troposphere.codedeploy.OnPremisesInstanceTagFilters'>], False),'OnPremisesTagSet': (<class 'troposphere.codedeploy.OnPremisesTagSet'>, False),'OutdatedInstancesStrategy': (<class 'str'>, False), 'ServiceRoleArn': (<class'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False),'TriggerConfigurations': ([<class 'troposphere.codedeploy.TriggerConfig'>], False)}

resource_type: Optional[str] = 'AWS::CodeDeploy::DeploymentGroup'

validate()

class troposphere.codedeploy.DeploymentReadyOption(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DeploymentReadyOption

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ActionOnTimeout': (<class 'str'>, False), 'WaitTimeInMinutes': (<functioninteger>, False)}

class troposphere.codedeploy.DeploymentStyle(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DeploymentStyle

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeploymentOption': (<function deployment_option_validator>, False),'DeploymentType': (<function deployment_type_validator>, False)}

class troposphere.codedeploy.ECSService(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ECSService

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClusterName': (<class 'str'>, True), 'ServiceName': (<class 'str'>, True)}

class troposphere.codedeploy.Ec2TagFilters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Ec2TagFilters

7.3. troposphere 193

Page 198: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, False), 'Type': (<class 'str'>, False), 'Value': (<class 'str'>,False)}

class troposphere.codedeploy.Ec2TagSet(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Ec2TagSet

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Ec2TagSetList': ([<class 'troposphere.codedeploy.Ec2TagSetListObject'>], False)}

class troposphere.codedeploy.Ec2TagSetListObject(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Ec2TagSetListObject

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Ec2TagGroup': ([<class 'troposphere.codedeploy.Ec2TagFilters'>], False)}

class troposphere.codedeploy.ElbInfoList(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ElbInfoList

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False)}

class troposphere.codedeploy.GitHubLocation(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GitHubLocation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CommitId': (<class 'str'>, True), 'Repository': (<class 'str'>, True)}

class troposphere.codedeploy.GreenFleetProvisioningOption(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

GreenFleetProvisioningOption

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Action': (<class 'str'>, False)}

class troposphere.codedeploy.LoadBalancerInfo(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LoadBalancerInfo

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ElbInfoList': ([<class 'troposphere.codedeploy.ElbInfoList'>], False),'TargetGroupInfoList': ([<class 'troposphere.codedeploy.TargetGroupInfo'>], False),'TargetGroupPairInfoList': ([<class 'troposphere.codedeploy.TargetGroupPairInfo'>],False)}

194 Chapter 7. Licensing

Page 199: Release 3.1

troposphere Documentation, Release 4.0.1

validate()

class troposphere.codedeploy.MinimumHealthyHosts(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MinimumHealthyHosts

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Type': (<class 'str'>, True), 'Value': (<function integer>, True)}

class troposphere.codedeploy.OnPremisesInstanceTagFilters(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

OnPremisesInstanceTagFilters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, False), 'Type': (<class 'str'>, False), 'Value': (<class 'str'>,False)}

class troposphere.codedeploy.OnPremisesTagSet(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OnPremisesTagSet

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'OnPremisesTagSetList': ([<class'troposphere.codedeploy.OnPremisesTagSetListObject'>], False)}

class troposphere.codedeploy.OnPremisesTagSetListObject(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

OnPremisesTagSetListObject

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'OnPremisesTagGroup': ([<class 'troposphere.codedeploy.TagFilter'>], False)}

class troposphere.codedeploy.Revision(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Revision

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GitHubLocation': (<class 'troposphere.codedeploy.GitHubLocation'>, False),'RevisionType': (<class 'str'>, False), 'S3Location': (<class'troposphere.codedeploy.S3Location'>, False)}

class troposphere.codedeploy.S3Location(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3Location

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Bucket': (<class 'str'>, True), 'BundleType': (<class 'str'>, False), 'ETag':(<class 'str'>, False), 'Key': (<class 'str'>, True), 'Version': (<class 'str'>,False)}

7.3. troposphere 195

Page 200: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.codedeploy.TagFilter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TagFilter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, False), 'Type': (<class 'str'>, False), 'Value': (<class 'str'>,False)}

class troposphere.codedeploy.TargetGroupInfo(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TargetGroupInfo

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False)}

class troposphere.codedeploy.TargetGroupPairInfo(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TargetGroupPairInfo

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ProdTrafficRoute': (<class 'troposphere.codedeploy.TrafficRoute'>, False),'TargetGroups': ([<class 'troposphere.codedeploy.TargetGroupInfo'>], False),'TestTrafficRoute': (<class 'troposphere.codedeploy.TrafficRoute'>, False)}

class troposphere.codedeploy.TimeBasedCanary(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TimeBasedCanary

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CanaryInterval': (<function integer>, True), 'CanaryPercentage': (<functioninteger>, True)}

class troposphere.codedeploy.TimeBasedLinear(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TimeBasedLinear

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LinearInterval': (<function integer>, True), 'LinearPercentage': (<functioninteger>, True)}

class troposphere.codedeploy.TrafficRoute(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TrafficRoute

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ListenerArns': ([<class 'str'>], False)}

class troposphere.codedeploy.TrafficRoutingConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TrafficRoutingConfig

196 Chapter 7. Licensing

Page 201: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TimeBasedCanary': (<class 'troposphere.codedeploy.TimeBasedCanary'>, False),'TimeBasedLinear': (<class 'troposphere.codedeploy.TimeBasedLinear'>, False),'Type': (<class 'str'>, True)}

class troposphere.codedeploy.TriggerConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TriggerConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TriggerEvents': ([<class 'str'>], False), 'TriggerName': (<class 'str'>, False),'TriggerTargetArn': (<class 'str'>, False)}

troposphere.codeguruprofiler module

class troposphere.codeguruprofiler.Channel(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Channel

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'channelId': (<class 'str'>, False), 'channelUri': (<class 'str'>, True)}

class troposphere.codeguruprofiler.ProfilingGroup(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ProfilingGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AgentPermissions': (<class 'dict'>, False),'AnomalyDetectionNotificationConfiguration': ([<class'troposphere.codeguruprofiler.Channel'>], False), 'ComputePlatform': (<class'str'>, False), 'ProfilingGroupName': (<class 'str'>, True), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::CodeGuruProfiler::ProfilingGroup'

troposphere.codegurureviewer module

class troposphere.codegurureviewer.RepositoryAssociation(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

RepositoryAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketName': (<class 'str'>, False), 'ConnectionArn': (<class 'str'>, False),'Name': (<class 'str'>, True), 'Owner': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False), 'Type': (<class 'str'>, True)}

7.3. troposphere 197

Page 202: Release 3.1

troposphere Documentation, Release 4.0.1

resource_type: Optional[str] = 'AWS::CodeGuruReviewer::RepositoryAssociation'

troposphere.codepipeline module

class troposphere.codepipeline.ActionTypeId(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ActionTypeId

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Category': (<class 'str'>, True), 'Owner': (<class 'str'>, True), 'Provider':(<class 'str'>, True), 'Version': (<class 'str'>, True)}

class troposphere.codepipeline.Actions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Actions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ActionTypeId': (<class 'troposphere.codepipeline.ActionTypeId'>, True),'Configuration': (<class 'dict'>, False), 'InputArtifacts': ([<class'troposphere.codepipeline.InputArtifacts'>], False), 'Name': (<class 'str'>, True),'Namespace': (<class 'str'>, False), 'OutputArtifacts': ([<class'troposphere.codepipeline.OutputArtifacts'>], False), 'Region': (<class 'str'>,False), 'RoleArn': (<class 'str'>, False), 'RunOrder': (<function integer>,False)}

class troposphere.codepipeline.ArtifactDetails(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ArtifactDetails

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaximumCount': (<function integer>, True), 'MinimumCount': (<function integer>,True)}

class troposphere.codepipeline.ArtifactStore(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ArtifactStore

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EncryptionKey': (<class 'troposphere.codepipeline.EncryptionKey'>, False),'Location': (<class 'str'>, True), 'Type': (<class 'str'>, True)}

class troposphere.codepipeline.ArtifactStoreMap(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ArtifactStoreMap

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ArtifactStore': (<class 'troposphere.codepipeline.ArtifactStore'>, True),'Region': (<class 'str'>, True)}

198 Chapter 7. Licensing

Page 203: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.codepipeline.Blockers(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Blockers

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'Type': (<class 'str'>, True)}

class troposphere.codepipeline.ConfigurationProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConfigurationProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'Key': (<function boolean>, True), 'Name':(<class 'str'>, True), 'Queryable': (<function boolean>, False), 'Required':(<function boolean>, True), 'Secret': (<function boolean>, True), 'Type': (<class'str'>, False)}

class troposphere.codepipeline.CustomActionType(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

CustomActionType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Category': (<class 'str'>, True), 'ConfigurationProperties': ([<class'troposphere.codepipeline.ConfigurationProperties'>], False),'InputArtifactDetails': (<class 'troposphere.codepipeline.ArtifactDetails'>, True),'OutputArtifactDetails': (<class 'troposphere.codepipeline.ArtifactDetails'>,True), 'Provider': (<class 'str'>, True), 'Settings': (<class'troposphere.codepipeline.Settings'>, False), 'Tags': (<class 'troposphere.Tags'>,False), 'Version': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::CodePipeline::CustomActionType'

class troposphere.codepipeline.DisableInboundStageTransitions(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

DisableInboundStageTransitions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Reason': (<class 'str'>, True), 'StageName': (<class 'str'>, True)}

class troposphere.codepipeline.EncryptionKey(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EncryptionKey

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Id':(<class 'str'>, True), 'Type': (<class 'str'>, True)}

class troposphere.codepipeline.InputArtifacts(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 199

Page 204: Release 3.1

troposphere Documentation, Release 4.0.1

InputArtifacts

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True)}

class troposphere.codepipeline.OutputArtifacts(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OutputArtifacts

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True)}

class troposphere.codepipeline.Pipeline(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Pipeline

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ArtifactStore': (<class 'troposphere.codepipeline.ArtifactStore'>, False),'ArtifactStores': ([<class 'troposphere.codepipeline.ArtifactStoreMap'>], False),'DisableInboundStageTransitions': ([<class'troposphere.codepipeline.DisableInboundStageTransitions'>], False), 'Name':(<class 'str'>, False), 'RestartExecutionOnUpdate': (<function boolean>, False),'RoleArn': (<class 'str'>, True), 'Stages': ([<class'troposphere.codepipeline.Stages'>], True), 'Tags': (<class 'troposphere.Tags'>,False)}

resource_type: Optional[str] = 'AWS::CodePipeline::Pipeline'

class troposphere.codepipeline.Settings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Settings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EntityUrlTemplate': (<class 'str'>, False), 'ExecutionUrlTemplate': (<class'str'>, False), 'RevisionUrlTemplate': (<class 'str'>, False),'ThirdPartyConfigurationUrl': (<class 'str'>, False)}

class troposphere.codepipeline.Stages(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Stages

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Actions': ([<class 'troposphere.codepipeline.Actions'>], True), 'Blockers':([<class 'troposphere.codepipeline.Blockers'>], False), 'Name': (<class 'str'>,True)}

class troposphere.codepipeline.Webhook(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Webhook

200 Chapter 7. Licensing

Page 205: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Authentication': (<class 'str'>, True), 'AuthenticationConfiguration': (<class'troposphere.codepipeline.WebhookAuthConfiguration'>, True), 'Filters': ([<class'troposphere.codepipeline.WebhookFilterRule'>], True), 'Name': (<class 'str'>,False), 'RegisterWithThirdParty': (<function boolean>, False), 'TargetAction':(<class 'str'>, True), 'TargetPipeline': (<class 'str'>, True),'TargetPipelineVersion': (<function integer>, True)}

resource_type: Optional[str] = 'AWS::CodePipeline::Webhook'

class troposphere.codepipeline.WebhookAuthConfiguration(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

WebhookAuthConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllowedIPRange': (<class 'str'>, False), 'SecretToken': (<class 'str'>, False)}

class troposphere.codepipeline.WebhookFilterRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

WebhookFilterRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'JsonPath': (<class 'str'>, True), 'MatchEquals': (<class 'str'>, False)}

troposphere.codestar module

class troposphere.codestar.Code(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Code

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'S3':(<class 'troposphere.codestar.S3'>, True)}

class troposphere.codestar.GitHubRepository(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

GitHubRepository

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Code': (<class 'troposphere.codestar.Code'>, False), 'ConnectionArn': (<class'str'>, False), 'EnableIssues': (<function boolean>, False), 'IsPrivate':(<function boolean>, False), 'RepositoryAccessToken': (<class 'str'>, False),'RepositoryDescription': (<class 'str'>, False), 'RepositoryName': (<class 'str'>,True), 'RepositoryOwner': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::CodeStar::GitHubRepository'

class troposphere.codestar.S3(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 201

Page 206: Release 3.1

troposphere Documentation, Release 4.0.1

S3

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Bucket': (<class 'str'>, True), 'Key': (<class 'str'>, True), 'ObjectVersion':(<class 'str'>, False)}

troposphere.codestarconnections module

class troposphere.codestarconnections.Connection(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Connection

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectionName': (<class 'str'>, True), 'HostArn': (<class 'str'>, False),'ProviderType': (<function validate_connection_providertype>, False), 'Tags':(<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::CodeStarConnections::Connection'

troposphere.codestarnotifications module

class troposphere.codestarnotifications.NotificationRule(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

NotificationRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CreatedBy': (<class 'str'>, False), 'DetailType': (<class 'str'>, True),'EventTypeId': (<class 'str'>, False), 'EventTypeIds': ([<class 'str'>], True),'Name': (<class 'str'>, True), 'Resource': (<class 'str'>, True), 'Status':(<class 'str'>, False), 'Tags': (<class 'dict'>, False), 'TargetAddress': (<class'str'>, False), 'Targets': ([<class 'troposphere.codestarnotifications.Target'>],True)}

resource_type: Optional[str] = 'AWS::CodeStarNotifications::NotificationRule'

class troposphere.codestarnotifications.Target(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Target

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TargetAddress': (<class 'str'>, True), 'TargetType': (<class 'str'>, True)}

202 Chapter 7. Licensing

Page 207: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.cognito module

class troposphere.cognito.AccountRecoverySetting(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AccountRecoverySetting

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RecoveryMechanisms': ([<class 'troposphere.cognito.RecoveryOption'>], False)}

class troposphere.cognito.AccountTakeoverActionType(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AccountTakeoverActionType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EventAction': (<class 'str'>, True), 'Notify': (<function boolean>, True)}

class troposphere.cognito.AccountTakeoverActionsType(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AccountTakeoverActionsType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HighAction': (<class 'troposphere.cognito.AccountTakeoverActionType'>, False),'LowAction': (<class 'troposphere.cognito.AccountTakeoverActionType'>, False),'MediumAction': (<class 'troposphere.cognito.AccountTakeoverActionType'>, False)}

class troposphere.cognito.AccountTakeoverRiskConfigurationType(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

AccountTakeoverRiskConfigurationType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Actions': (<class 'troposphere.cognito.AccountTakeoverActionsType'>, True),'NotifyConfiguration': (<class 'troposphere.cognito.NotifyConfigurationType'>,False)}

class troposphere.cognito.AdminCreateUserConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AdminCreateUserConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllowAdminCreateUserOnly': (<function boolean>, False), 'InviteMessageTemplate':(<class 'troposphere.cognito.InviteMessageTemplate'>, False),'UnusedAccountValidityDays': (<function integer>, False)}

class troposphere.cognito.AnalyticsConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AnalyticsConfiguration

7.3. troposphere 203

Page 208: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationArn': (<class 'str'>, False), 'ApplicationId': (<class 'str'>,False), 'ExternalId': (<class 'str'>, False), 'RoleArn': (<class 'str'>, False),'UserDataShared': (<function boolean>, False)}

class troposphere.cognito.AttributeType(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AttributeType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'Value': (<class 'str'>, False)}

class troposphere.cognito.CognitoIdentityProvider(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CognitoIdentityProvider

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClientId': (<class 'str'>, False), 'ProviderName': (<class 'str'>, False),'ServerSideTokenCheck': (<function boolean>, False)}

class troposphere.cognito.CognitoStreams(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CognitoStreams

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RoleArn': (<class 'str'>, False), 'StreamName': (<class 'str'>, False),'StreamingStatus': (<class 'str'>, False)}

class troposphere.cognito.CompromisedCredentialsActionsType(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

CompromisedCredentialsActionsType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EventAction': (<class 'str'>, True)}

class troposphere.cognito.CompromisedCredentialsRiskConfigurationType(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

CompromisedCredentialsRiskConfigurationType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Actions': (<class 'troposphere.cognito.CompromisedCredentialsActionsType'>,True), 'EventFilter': ([<class 'str'>], False)}

class troposphere.cognito.CustomDomainConfigType(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CustomDomainConfigType

204 Chapter 7. Licensing

Page 209: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateArn': (<class 'str'>, False)}

class troposphere.cognito.CustomEmailSender(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CustomEmailSender

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LambdaArn': (<class 'str'>, False), 'LambdaVersion': (<class 'str'>, False)}

class troposphere.cognito.CustomSMSSender(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CustomSMSSender

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LambdaArn': (<class 'str'>, False), 'LambdaVersion': (<class 'str'>, False)}

class troposphere.cognito.DeviceConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DeviceConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ChallengeRequiredOnNewDevice': (<function boolean>, False),'DeviceOnlyRememberedOnUserPrompt': (<function boolean>, False)}

class troposphere.cognito.EmailConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EmailConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConfigurationSet': (<class 'str'>, False), 'EmailSendingAccount': (<class'str'>, False), 'From': (<class 'str'>, False), 'ReplyToEmailAddress': (<class'str'>, False), 'SourceArn': (<class 'str'>, False)}

class troposphere.cognito.IdentityPool(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

IdentityPool

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllowClassicFlow': (<function boolean>, False), 'AllowUnauthenticatedIdentities':(<function boolean>, True), 'CognitoEvents': (<class 'dict'>, False),'CognitoIdentityProviders': ([<class'troposphere.cognito.CognitoIdentityProvider'>], False), 'CognitoStreams': (<class'troposphere.cognito.CognitoStreams'>, False), 'DeveloperProviderName': (<class'str'>, False), 'IdentityPoolName': (<class 'str'>, False),'OpenIdConnectProviderARNs': ([<class 'str'>], False), 'PushSync': (<class'troposphere.cognito.PushSync'>, False), 'SamlProviderARNs': ([<class 'str'>],False), 'SupportedLoginProviders': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::Cognito::IdentityPool'

7.3. troposphere 205

Page 210: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.cognito.IdentityPoolRoleAttachment(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

IdentityPoolRoleAttachment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'IdentityPoolId': (<class 'str'>, True), 'RoleMappings': (<class 'dict'>, False),'Roles': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::Cognito::IdentityPoolRoleAttachment'

class troposphere.cognito.InviteMessageTemplate(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InviteMessageTemplate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EmailMessage': (<class 'str'>, False), 'EmailSubject': (<class 'str'>, False),'SMSMessage': (<class 'str'>, False)}

class troposphere.cognito.LambdaConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LambdaConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CreateAuthChallenge': (<class 'str'>, False), 'CustomEmailSender': (<class'troposphere.cognito.CustomEmailSender'>, False), 'CustomMessage': (<class 'str'>,False), 'CustomSMSSender': (<class 'troposphere.cognito.CustomSMSSender'>, False),'DefineAuthChallenge': (<class 'str'>, False), 'KMSKeyID': (<class 'str'>, False),'PostAuthentication': (<class 'str'>, False), 'PostConfirmation': (<class 'str'>,False), 'PreAuthentication': (<class 'str'>, False), 'PreSignUp': (<class 'str'>,False), 'PreTokenGeneration': (<class 'str'>, False), 'UserMigration': (<class'str'>, False), 'VerifyAuthChallengeResponse': (<class 'str'>, False)}

class troposphere.cognito.MappingRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MappingRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Claim': (<class 'str'>, True), 'MatchType': (<class 'str'>, True), 'RoleARN':(<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.cognito.NotifyConfigurationType(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NotifyConfigurationType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BlockEmail': (<class 'troposphere.cognito.NotifyEmailType'>, False), 'From':(<class 'str'>, False), 'MfaEmail': (<class 'troposphere.cognito.NotifyEmailType'>,False), 'NoActionEmail': (<class 'troposphere.cognito.NotifyEmailType'>, False),'ReplyTo': (<class 'str'>, False), 'SourceArn': (<class 'str'>, True)}

206 Chapter 7. Licensing

Page 211: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.cognito.NotifyEmailType(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NotifyEmailType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HtmlBody': (<class 'str'>, False), 'Subject': (<class 'str'>, True), 'TextBody':(<class 'str'>, False)}

class troposphere.cognito.NumberAttributeConstraints(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NumberAttributeConstraints

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxValue': (<class 'str'>, False), 'MinValue': (<class 'str'>, False)}

class troposphere.cognito.PasswordPolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PasswordPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MinimumLength': (<function integer>, False), 'RequireLowercase': (<functionboolean>, False), 'RequireNumbers': (<function boolean>, False), 'RequireSymbols':(<function boolean>, False), 'RequireUppercase': (<function boolean>, False),'TemporaryPasswordValidityDays': (<function integer>, False)}

class troposphere.cognito.Policies(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Policies

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PasswordPolicy': (<class 'troposphere.cognito.PasswordPolicy'>, False)}

class troposphere.cognito.PushSync(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PushSync

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationArns': ([<class 'str'>], False), 'RoleArn': (<class 'str'>, False)}

class troposphere.cognito.RecoveryOption(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RecoveryOption

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<function validate_recoveryoption_name>, False), 'Priority': (<functioninteger>, False)}

class troposphere.cognito.ResourceServerScopeType(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ResourceServerScopeType

7.3. troposphere 207

Page 212: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ScopeDescription': (<class 'str'>, True), 'ScopeName': (<class 'str'>, True)}

class troposphere.cognito.RiskExceptionConfigurationType(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

RiskExceptionConfigurationType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BlockedIPRangeList': ([<class 'str'>], False), 'SkippedIPRangeList': ([<class'str'>], False)}

class troposphere.cognito.RoleMapping(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RoleMapping

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AmbiguousRoleResolution': (<class 'str'>, False), 'IdentityProvider': (<class'str'>, False), 'RulesConfiguration': (<class'troposphere.cognito.RulesConfiguration'>, False), 'Type': (<class 'str'>, True)}

class troposphere.cognito.RulesConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RulesConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Rules': ([<class 'troposphere.cognito.MappingRule'>], True)}

class troposphere.cognito.SchemaAttribute(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SchemaAttribute

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AttributeDataType': (<class 'str'>, False), 'DeveloperOnlyAttribute': (<functionboolean>, False), 'Mutable': (<function boolean>, False), 'Name': (<class 'str'>,False), 'NumberAttributeConstraints': (<class'troposphere.cognito.NumberAttributeConstraints'>, False), 'Required': (<functionboolean>, False), 'StringAttributeConstraints': (<class'troposphere.cognito.StringAttributeConstraints'>, False)}

class troposphere.cognito.SmsConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SmsConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ExternalId': (<class 'str'>, False), 'SnsCallerArn': (<class 'str'>, False),'SnsRegion': (<class 'str'>, False)}

class troposphere.cognito.StringAttributeConstraints(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

208 Chapter 7. Licensing

Page 213: Release 3.1

troposphere Documentation, Release 4.0.1

StringAttributeConstraints

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxLength': (<class 'str'>, False), 'MinLength': (<class 'str'>, False)}

class troposphere.cognito.TokenValidityUnits(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TokenValidityUnits

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessToken': (<class 'str'>, False), 'IdToken': (<class 'str'>, False),'RefreshToken': (<class 'str'>, False)}

class troposphere.cognito.UserPool(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

UserPool

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccountRecoverySetting': (<class 'troposphere.cognito.AccountRecoverySetting'>,False), 'AdminCreateUserConfig': (<class'troposphere.cognito.AdminCreateUserConfig'>, False), 'AliasAttributes': ([<class'str'>], False), 'AutoVerifiedAttributes': ([<class 'str'>], False),'DeviceConfiguration': (<class 'troposphere.cognito.DeviceConfiguration'>, False),'EmailConfiguration': (<class 'troposphere.cognito.EmailConfiguration'>, False),'EmailVerificationMessage': (<class 'str'>, False), 'EmailVerificationSubject':(<class 'str'>, False), 'EnabledMfas': ([<class 'str'>], False), 'LambdaConfig':(<class 'troposphere.cognito.LambdaConfig'>, False), 'MfaConfiguration': (<class'str'>, False), 'Policies': (<class 'troposphere.cognito.Policies'>, False),'Schema': ([<class 'troposphere.cognito.SchemaAttribute'>], False),'SmsAuthenticationMessage': (<class 'str'>, False), 'SmsConfiguration': (<class'troposphere.cognito.SmsConfiguration'>, False), 'SmsVerificationMessage': (<class'str'>, False), 'UserPoolAddOns': (<class 'troposphere.cognito.UserPoolAddOns'>,False), 'UserPoolName': (<class 'str'>, False), 'UserPoolTags': (<class 'dict'>,False), 'UsernameAttributes': ([<class 'str'>], False), 'UsernameConfiguration':(<class 'troposphere.cognito.UsernameConfiguration'>, False),'VerificationMessageTemplate': (<class'troposphere.cognito.VerificationMessageTemplate'>, False)}

resource_type: Optional[str] = 'AWS::Cognito::UserPool'

class troposphere.cognito.UserPoolAddOns(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

UserPoolAddOns

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AdvancedSecurityMode': (<class 'str'>, False)}

class troposphere.cognito.UserPoolClient(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

UserPoolClient

7.3. troposphere 209

Page 214: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessTokenValidity': (<function integer>, False), 'AllowedOAuthFlows': ([<class'str'>], False), 'AllowedOAuthFlowsUserPoolClient': (<function boolean>, False),'AllowedOAuthScopes': ([<class 'str'>], False), 'AnalyticsConfiguration': (<class'troposphere.cognito.AnalyticsConfiguration'>, False), 'CallbackURLs': ([<class'str'>], False), 'ClientName': (<class 'str'>, False), 'DefaultRedirectURI':(<class 'str'>, False), 'EnableTokenRevocation': (<function boolean>, False),'ExplicitAuthFlows': ([<class 'str'>], False), 'GenerateSecret': (<functionboolean>, False), 'IdTokenValidity': (<function integer>, False), 'LogoutURLs':([<class 'str'>], False), 'PreventUserExistenceErrors': (<class 'str'>, False),'ReadAttributes': ([<class 'str'>], False), 'RefreshTokenValidity': (<functioninteger>, False), 'SupportedIdentityProviders': ([<class 'str'>], False),'TokenValidityUnits': (<class 'troposphere.cognito.TokenValidityUnits'>, False),'UserPoolId': (<class 'str'>, True), 'WriteAttributes': ([<class 'str'>], False)}

resource_type: Optional[str] = 'AWS::Cognito::UserPoolClient'

class troposphere.cognito.UserPoolDomain(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

UserPoolDomain

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CustomDomainConfig': (<class 'troposphere.cognito.CustomDomainConfigType'>,False), 'Domain': (<class 'str'>, True), 'UserPoolId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::Cognito::UserPoolDomain'

class troposphere.cognito.UserPoolGroup(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

UserPoolGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'GroupName': (<class 'str'>, False),'Precedence': (<function double>, False), 'RoleArn': (<class 'str'>, False),'UserPoolId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::Cognito::UserPoolGroup'

class troposphere.cognito.UserPoolIdentityProvider(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

UserPoolIdentityProvider

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AttributeMapping': (<class 'dict'>, False), 'IdpIdentifiers': ([<class 'str'>],False), 'ProviderDetails': (<class 'dict'>, False), 'ProviderName': (<class'str'>, True), 'ProviderType': (<class 'str'>, True), 'UserPoolId': (<class'str'>, True)}

resource_type: Optional[str] = 'AWS::Cognito::UserPoolIdentityProvider'

210 Chapter 7. Licensing

Page 215: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.cognito.UserPoolResourceServer(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

UserPoolResourceServer

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Identifier': (<class 'str'>, True), 'Name': (<class 'str'>, True), 'Scopes':([<class 'troposphere.cognito.ResourceServerScopeType'>], False), 'UserPoolId':(<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::Cognito::UserPoolResourceServer'

class troposphere.cognito.UserPoolRiskConfigurationAttachment(title: Optional[str], template:Optional[troposphere.Template] =None, validation: bool = True,**kwargs: Any)

Bases: troposphere.AWSObject

UserPoolRiskConfigurationAttachment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccountTakeoverRiskConfiguration': (<class'troposphere.cognito.AccountTakeoverRiskConfigurationType'>, False), 'ClientId':(<class 'str'>, True), 'CompromisedCredentialsRiskConfiguration': (<class'troposphere.cognito.CompromisedCredentialsRiskConfigurationType'>, False),'RiskExceptionConfiguration': (<class'troposphere.cognito.RiskExceptionConfigurationType'>, False), 'UserPoolId':(<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::Cognito::UserPoolRiskConfigurationAttachment'

class troposphere.cognito.UserPoolUICustomizationAttachment(title: Optional[str], template:Optional[troposphere.Template] =None, validation: bool = True,**kwargs: Any)

Bases: troposphere.AWSObject

UserPoolUICustomizationAttachment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'CSS':(<class 'str'>, False), 'ClientId': (<class 'str'>, True), 'UserPoolId': (<class'str'>, True)}

resource_type: Optional[str] = 'AWS::Cognito::UserPoolUICustomizationAttachment'

class troposphere.cognito.UserPoolUser(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

UserPoolUser

7.3. troposphere 211

Page 216: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClientMetadata': (<class 'dict'>, False), 'DesiredDeliveryMediums': ([<class'str'>], False), 'ForceAliasCreation': (<function boolean>, False),'MessageAction': (<class 'str'>, False), 'UserAttributes': ([<class'troposphere.cognito.AttributeType'>], False), 'UserPoolId': (<class 'str'>, True),'Username': (<class 'str'>, False), 'ValidationData': ([<class'troposphere.cognito.AttributeType'>], False)}

resource_type: Optional[str] = 'AWS::Cognito::UserPoolUser'

class troposphere.cognito.UserPoolUserToGroupAttachment(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

UserPoolUserToGroupAttachment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GroupName': (<class 'str'>, True), 'UserPoolId': (<class 'str'>, True),'Username': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::Cognito::UserPoolUserToGroupAttachment'

class troposphere.cognito.UsernameConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

UsernameConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CaseSensitive': (<function boolean>, False)}

class troposphere.cognito.VerificationMessageTemplate(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VerificationMessageTemplate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DefaultEmailOption': (<class 'str'>, False), 'EmailMessage': (<class 'str'>,False), 'EmailMessageByLink': (<class 'str'>, False), 'EmailSubject': (<class'str'>, False), 'EmailSubjectByLink': (<class 'str'>, False), 'SmsMessage':(<class 'str'>, False)}

troposphere.compat module

troposphere.compat.validate_policytype(policy)

212 Chapter 7. Licensing

Page 217: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.config module

class troposphere.config.AccountAggregationSources(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AccountAggregationSources

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccountIds': ([<class 'str'>], True), 'AllAwsRegions': (<function boolean>,False), 'AwsRegions': ([<class 'str'>], False)}

class troposphere.config.AggregationAuthorization(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

AggregationAuthorization

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthorizedAccountId': (<class 'str'>, True), 'AuthorizedAwsRegion': (<class'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::Config::AggregationAuthorization'

class troposphere.config.ConfigRule(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ConfigRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConfigRuleName': (<class 'str'>, False), 'Description': (<class 'str'>, False),'InputParameters': (<class 'dict'>, False), 'MaximumExecutionFrequency': (<class'str'>, False), 'Scope': (<class 'troposphere.config.Scope'>, False), 'Source':(<class 'troposphere.config.Source'>, True)}

resource_type: Optional[str] = 'AWS::Config::ConfigRule'

class troposphere.config.ConfigSnapshotDeliveryProperties(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

ConfigSnapshotDeliveryProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeliveryFrequency': (<class 'str'>, False)}

class troposphere.config.ConfigurationAggregator(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ConfigurationAggregator

7.3. troposphere 213

Page 218: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccountAggregationSources': ([<class'troposphere.config.AccountAggregationSources'>], False),'ConfigurationAggregatorName': (<class 'str'>, False),'OrganizationAggregationSource': (<class'troposphere.config.OrganizationAggregationSource'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::Config::ConfigurationAggregator'

class troposphere.config.ConfigurationRecorder(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ConfigurationRecorder

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'RecordingGroup': (<class'troposphere.config.RecordingGroup'>, False), 'RoleARN': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::Config::ConfigurationRecorder'

class troposphere.config.ConformancePack(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ConformancePack

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConformancePackInputParameters': ([<class'troposphere.config.ConformancePackInputParameter'>], False), 'ConformancePackName':(<class 'str'>, True), 'DeliveryS3Bucket': (<class 'str'>, False),'DeliveryS3KeyPrefix': (<class 'str'>, False), 'TemplateBody': (<class 'str'>,False), 'TemplateS3Uri': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::Config::ConformancePack'

class troposphere.config.ConformancePackInputParameter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConformancePackInputParameter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ParameterName': (<class 'str'>, True), 'ParameterValue': (<class 'str'>, True)}

class troposphere.config.DeliveryChannel(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DeliveryChannel

214 Chapter 7. Licensing

Page 219: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConfigSnapshotDeliveryProperties': (<class'troposphere.config.ConfigSnapshotDeliveryProperties'>, False), 'Name': (<class'str'>, False), 'S3BucketName': (<class 'str'>, True), 'S3KeyPrefix': (<class'str'>, False), 'S3KmsKeyArn': (<class 'str'>, False), 'SnsTopicARN': (<class'str'>, False)}

resource_type: Optional[str] = 'AWS::Config::DeliveryChannel'

class troposphere.config.ExecutionControls(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ExecutionControls

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SsmControls': (<class 'troposphere.config.SsmControls'>, False)}

class troposphere.config.OrganizationAggregationSource(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OrganizationAggregationSource

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllAwsRegions': (<function boolean>, False), 'AwsRegions': ([<class 'str'>],False), 'RoleArn': (<class 'str'>, True)}

class troposphere.config.OrganizationConfigRule(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

OrganizationConfigRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ExcludedAccounts': ([<class 'str'>], False), 'OrganizationConfigRuleName':(<class 'str'>, True), 'OrganizationCustomCodeRuleMetadata': (<class'troposphere.config.OrganizationCustomCodeRuleMetadata'>, False),'OrganizationCustomRuleMetadata': (<class'troposphere.config.OrganizationCustomRuleMetadata'>, False),'OrganizationManagedRuleMetadata': (<class'troposphere.config.OrganizationManagedRuleMetadata'>, False)}

resource_type: Optional[str] = 'AWS::Config::OrganizationConfigRule'

class troposphere.config.OrganizationConformancePack(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

OrganizationConformancePack

7.3. troposphere 215

Page 220: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConformancePackInputParameters': ([<class'troposphere.config.ConformancePackInputParameter'>], False), 'DeliveryS3Bucket':(<class 'str'>, False), 'DeliveryS3KeyPrefix': (<class 'str'>, False),'ExcludedAccounts': ([<class 'str'>], False), 'OrganizationConformancePackName':(<class 'str'>, True), 'TemplateBody': (<class 'str'>, False), 'TemplateS3Uri':(<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::Config::OrganizationConformancePack'

class troposphere.config.OrganizationCustomCodeRuleMetadata(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

OrganizationCustomCodeRuleMetadata

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CodeText': (<class 'str'>, True), 'DebugLogDeliveryAccounts': ([<class 'str'>],False), 'Description': (<class 'str'>, False), 'InputParameters': (<class 'str'>,False), 'MaximumExecutionFrequency': (<class 'str'>, False),'OrganizationConfigRuleTriggerTypes': ([<class 'str'>], False), 'ResourceIdScope':(<class 'str'>, False), 'ResourceTypesScope': ([<class 'str'>], False), 'Runtime':(<class 'str'>, True), 'TagKeyScope': (<class 'str'>, False), 'TagValueScope':(<class 'str'>, False)}

class troposphere.config.OrganizationCustomRuleMetadata(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

OrganizationCustomRuleMetadata

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'InputParameters': (<class 'str'>, False),'LambdaFunctionArn': (<class 'str'>, True), 'MaximumExecutionFrequency': (<class'str'>, False), 'OrganizationConfigRuleTriggerTypes': ([<class 'str'>], True),'ResourceIdScope': (<class 'str'>, False), 'ResourceTypesScope': ([<class 'str'>],False), 'TagKeyScope': (<class 'str'>, False), 'TagValueScope': (<class 'str'>,False)}

class troposphere.config.OrganizationManagedRuleMetadata(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

OrganizationManagedRuleMetadata

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'InputParameters': (<class 'str'>, False),'MaximumExecutionFrequency': (<class 'str'>, False), 'ResourceIdScope': (<class'str'>, False), 'ResourceTypesScope': ([<class 'str'>], False), 'RuleIdentifier':(<class 'str'>, True), 'TagKeyScope': (<class 'str'>, False), 'TagValueScope':(<class 'str'>, False)}

class troposphere.config.RecordingGroup(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RecordingGroup

216 Chapter 7. Licensing

Page 221: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllSupported': (<function boolean>, False), 'IncludeGlobalResourceTypes':(<function boolean>, False), 'ResourceTypes': ([<class 'str'>], False)}

class troposphere.config.RemediationConfiguration(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

RemediationConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Automatic': (<function boolean>, False), 'ConfigRuleName': (<class 'str'>,True), 'ExecutionControls': (<class 'troposphere.config.ExecutionControls'>,False), 'MaximumAutomaticAttempts': (<function integer>, False), 'Parameters':(<class 'dict'>, False), 'ResourceType': (<class 'str'>, False),'RetryAttemptSeconds': (<function integer>, False), 'TargetId': (<class 'str'>,True), 'TargetType': (<class 'str'>, True), 'TargetVersion': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::Config::RemediationConfiguration'

class troposphere.config.RemediationParameterValue(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RemediationParameterValue

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ResourceValue': (<class 'troposphere.config.ResourceValue'>, False),'StaticValue': (<class 'troposphere.config.StaticValue'>, False)}

class troposphere.config.ResourceValue(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ResourceValue

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Value': (<class 'str'>, False)}

class troposphere.config.Scope(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Scope

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComplianceResourceId': (<class 'str'>, False), 'ComplianceResourceTypes':([<class 'str'>], False), 'TagKey': (<class 'str'>, False), 'TagValue': (<class'str'>, False)}

class troposphere.config.Source(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Source

7.3. troposphere 217

Page 222: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Owner': (<class 'str'>, True), 'SourceDetails': ([<class'troposphere.config.SourceDetails'>], False), 'SourceIdentifier': (<class 'str'>,True)}

class troposphere.config.SourceDetails(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SourceDetails

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EventSource': (<class 'str'>, True), 'MaximumExecutionFrequency': (<class'str'>, False), 'MessageType': (<class 'str'>, True)}

validate()

class troposphere.config.SsmControls(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SsmControls

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConcurrentExecutionRatePercentage': (<function integer>, False),'ErrorPercentage': (<function integer>, False)}

class troposphere.config.StaticValue(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

StaticValue

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Values': ([<class 'str'>], False)}

class troposphere.config.StoredQuery(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

StoredQuery

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'QueryDescription': (<class 'str'>, False), 'QueryExpression': (<class 'str'>,True), 'QueryName': (<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>,False)}

resource_type: Optional[str] = 'AWS::Config::StoredQuery'

218 Chapter 7. Licensing

Page 223: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.connect module

class troposphere.connect.ContactFlow(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ContactFlow

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Content': (<class 'str'>, True), 'Description': (<class 'str'>, False),'InstanceArn': (<class 'str'>, True), 'Name': (<class 'str'>, True), 'State':(<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>, False), 'Type':(<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::Connect::ContactFlow'

class troposphere.connect.ContactFlowModule(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

ContactFlowModule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Content': (<class 'str'>, True), 'Description': (<class 'str'>, False),'InstanceArn': (<class 'str'>, True), 'Name': (<class 'str'>, True), 'State':(<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::Connect::ContactFlowModule'

class troposphere.connect.HoursOfOperation(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

HoursOfOperation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Config': ([<class 'troposphere.connect.HoursOfOperationConfig'>], True),'Description': (<class 'str'>, False), 'InstanceArn': (<class 'str'>, True),'Name': (<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False),'TimeZone': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::Connect::HoursOfOperation'

class troposphere.connect.HoursOfOperationConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HoursOfOperationConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Day':(<class 'str'>, True), 'EndTime': (<class'troposphere.connect.HoursOfOperationTimeSlice'>, True), 'StartTime': (<class'troposphere.connect.HoursOfOperationTimeSlice'>, True)}

class troposphere.connect.HoursOfOperationTimeSlice(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 219

Page 224: Release 3.1

troposphere Documentation, Release 4.0.1

HoursOfOperationTimeSlice

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Hours': (<function integer>, True), 'Minutes': (<function integer>, True)}

class troposphere.connect.PhoneNumberQuickConnectConfig(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

PhoneNumberQuickConnectConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PhoneNumber': (<class 'str'>, True)}

class troposphere.connect.QueueQuickConnectConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

QueueQuickConnectConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContactFlowArn': (<class 'str'>, True), 'QueueArn': (<class 'str'>, True)}

class troposphere.connect.QuickConnect(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

QuickConnect

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'InstanceArn': (<class 'str'>, True),'Name': (<class 'str'>, True), 'QuickConnectConfig': (<class'troposphere.connect.QuickConnectConfig'>, True), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::Connect::QuickConnect'

class troposphere.connect.QuickConnectConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

QuickConnectConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PhoneConfig': (<class 'troposphere.connect.PhoneNumberQuickConnectConfig'>,False), 'QueueConfig': (<class 'troposphere.connect.QueueQuickConnectConfig'>,False), 'QuickConnectType': (<class 'str'>, True), 'UserConfig': (<class'troposphere.connect.UserQuickConnectConfig'>, False)}

class troposphere.connect.User(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

User

220 Chapter 7. Licensing

Page 225: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DirectoryUserId': (<class 'str'>, False), 'HierarchyGroupArn': (<class 'str'>,False), 'IdentityInfo': (<class 'troposphere.connect.UserIdentityInfo'>, False),'InstanceArn': (<class 'str'>, True), 'Password': (<class 'str'>, False),'PhoneConfig': (<class 'troposphere.connect.UserPhoneConfig'>, True),'RoutingProfileArn': (<class 'str'>, True), 'SecurityProfileArns': ([<class'str'>], True), 'Tags': (<class 'troposphere.Tags'>, False), 'Username': (<class'str'>, True)}

resource_type: Optional[str] = 'AWS::Connect::User'

class troposphere.connect.UserHierarchyGroup(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

UserHierarchyGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InstanceArn': (<class 'str'>, True), 'Name': (<class 'str'>, True),'ParentGroupArn': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::Connect::UserHierarchyGroup'

class troposphere.connect.UserIdentityInfo(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

UserIdentityInfo

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Email': (<class 'str'>, False), 'FirstName': (<class 'str'>, False), 'LastName':(<class 'str'>, False)}

class troposphere.connect.UserPhoneConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

UserPhoneConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AfterContactWorkTimeLimit': (<function integer>, False), 'AutoAccept':(<function boolean>, False), 'DeskPhoneNumber': (<class 'str'>, False),'PhoneType': (<class 'str'>, True)}

class troposphere.connect.UserQuickConnectConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

UserQuickConnectConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContactFlowArn': (<class 'str'>, True), 'UserArn': (<class 'str'>, True)}

7.3. troposphere 221

Page 226: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.constants module

troposphere.cur module

class troposphere.cur.ReportDefinition(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ReportDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AdditionalArtifacts': ([<class 'str'>], False), 'AdditionalSchemaElements':([<class 'str'>], False), 'BillingViewArn': (<class 'str'>, False), 'Compression':(<class 'str'>, True), 'Format': (<class 'str'>, True), 'RefreshClosedReports':(<function boolean>, True), 'ReportName': (<class 'str'>, True),'ReportVersioning': (<class 'str'>, True), 'S3Bucket': (<class 'str'>, True),'S3Prefix': (<class 'str'>, True), 'S3Region': (<class 'str'>, True), 'TimeUnit':(<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::CUR::ReportDefinition'

troposphere.customerprofiles module

class troposphere.customerprofiles.ConnectorOperator(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConnectorOperator

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Marketo': (<class 'str'>, False), 'S3': (<class 'str'>, False), 'Salesforce':(<class 'str'>, False), 'ServiceNow': (<class 'str'>, False), 'Zendesk': (<class'str'>, False)}

class troposphere.customerprofiles.Domain(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

Domain

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeadLetterQueueUrl': (<class 'str'>, False), 'DefaultEncryptionKey': (<class'str'>, False), 'DefaultExpirationDays': (<function integer>, False), 'DomainName':(<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::CustomerProfiles::Domain'

class troposphere.customerprofiles.FieldMap(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FieldMap

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'ObjectTypeField': (<class'troposphere.customerprofiles.ObjectTypeField'>, False)}

222 Chapter 7. Licensing

Page 227: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.customerprofiles.FlowDefinition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FlowDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'FlowName': (<class 'str'>, True),'KmsArn': (<class 'str'>, True), 'SourceFlowConfig': (<class'troposphere.customerprofiles.SourceFlowConfig'>, True), 'Tasks': ([<class'troposphere.customerprofiles.Task'>], True), 'TriggerConfig': (<class'troposphere.customerprofiles.TriggerConfig'>, True)}

class troposphere.customerprofiles.IncrementalPullConfig(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

IncrementalPullConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DatetimeTypeFieldName': (<class 'str'>, False)}

class troposphere.customerprofiles.Integration(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Integration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DomainName': (<class 'str'>, True), 'FlowDefinition': (<class'troposphere.customerprofiles.FlowDefinition'>, False), 'ObjectTypeName': (<class'str'>, False), 'ObjectTypeNames': ([<class'troposphere.customerprofiles.ObjectTypeMapping'>], False), 'Tags': (<class'troposphere.Tags'>, False), 'Uri': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::CustomerProfiles::Integration'

class troposphere.customerprofiles.KeyMap(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KeyMap

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'ObjectTypeKeyList': ([<class'troposphere.customerprofiles.ObjectTypeKey'>], False)}

class troposphere.customerprofiles.MarketoSourceProperties(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

MarketoSourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Object': (<class 'str'>, True)}

7.3. troposphere 223

Page 228: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.customerprofiles.ObjectType(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ObjectType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllowProfileCreation': (<function boolean>, False), 'Description': (<class'str'>, False), 'DomainName': (<class 'str'>, True), 'EncryptionKey': (<class'str'>, False), 'ExpirationDays': (<function integer>, False), 'Fields': ([<class'troposphere.customerprofiles.FieldMap'>], False), 'Keys': ([<class'troposphere.customerprofiles.KeyMap'>], False), 'ObjectTypeName': (<class 'str'>,False), 'Tags': (<class 'troposphere.Tags'>, False), 'TemplateId': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::CustomerProfiles::ObjectType'

class troposphere.customerprofiles.ObjectTypeField(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ObjectTypeField

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContentType': (<class 'str'>, False), 'Source': (<class 'str'>, False),'Target': (<class 'str'>, False)}

class troposphere.customerprofiles.ObjectTypeKey(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ObjectTypeKey

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FieldNames': ([<class 'str'>], False), 'StandardIdentifiers': ([<class 'str'>],False)}

class troposphere.customerprofiles.ObjectTypeMapping(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ObjectTypeMapping

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.customerprofiles.S3SourceProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3SourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketName': (<class 'str'>, True), 'BucketPrefix': (<class 'str'>, False)}

class troposphere.customerprofiles.SalesforceSourceProperties(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

SalesforceSourceProperties

224 Chapter 7. Licensing

Page 229: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EnableDynamicFieldUpdate': (<function boolean>, False), 'IncludeDeletedRecords':(<function boolean>, False), 'Object': (<class 'str'>, True)}

class troposphere.customerprofiles.ScheduledTriggerProperties(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ScheduledTriggerProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DataPullMode': (<class 'str'>, False), 'FirstExecutionFrom': (<function double>,False), 'ScheduleEndTime': (<function double>, False), 'ScheduleExpression':(<class 'str'>, True), 'ScheduleOffset': (<function integer>, False),'ScheduleStartTime': (<function double>, False), 'Timezone': (<class 'str'>,False)}

class troposphere.customerprofiles.ServiceNowSourceProperties(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ServiceNowSourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Object': (<class 'str'>, True)}

class troposphere.customerprofiles.SourceConnectorProperties(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

SourceConnectorProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Marketo': (<class 'troposphere.customerprofiles.MarketoSourceProperties'>,False), 'S3': (<class 'troposphere.customerprofiles.S3SourceProperties'>, False),'Salesforce': (<class 'troposphere.customerprofiles.SalesforceSourceProperties'>,False), 'ServiceNow': (<class'troposphere.customerprofiles.ServiceNowSourceProperties'>, False), 'Zendesk':(<class 'troposphere.customerprofiles.ZendeskSourceProperties'>, False)}

class troposphere.customerprofiles.SourceFlowConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SourceFlowConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectorProfileName': (<class 'str'>, False), 'ConnectorType': (<class 'str'>,True), 'IncrementalPullConfig': (<class'troposphere.customerprofiles.IncrementalPullConfig'>, False),'SourceConnectorProperties': (<class'troposphere.customerprofiles.SourceConnectorProperties'>, True)}

class troposphere.customerprofiles.Task(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Task

7.3. troposphere 225

Page 230: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectorOperator': (<class 'troposphere.customerprofiles.ConnectorOperator'>,False), 'DestinationField': (<class 'str'>, False), 'SourceFields': ([<class'str'>], True), 'TaskProperties': ([<class'troposphere.customerprofiles.TaskPropertiesMap'>], False), 'TaskType': (<class'str'>, True)}

class troposphere.customerprofiles.TaskPropertiesMap(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TaskPropertiesMap

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'OperatorPropertyKey': (<class 'str'>, True), 'Property': (<class 'str'>, True)}

class troposphere.customerprofiles.TriggerConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TriggerConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TriggerProperties': (<class 'troposphere.customerprofiles.TriggerProperties'>,False), 'TriggerType': (<class 'str'>, True)}

class troposphere.customerprofiles.TriggerProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TriggerProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Scheduled': (<class 'troposphere.customerprofiles.ScheduledTriggerProperties'>,False)}

class troposphere.customerprofiles.ZendeskSourceProperties(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

ZendeskSourceProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Object': (<class 'str'>, True)}

troposphere.databrew module

class troposphere.databrew.Action(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Action

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Operation': (<class 'str'>, True), 'Parameters': (<class'troposphere.databrew.RecipeParameters'>, False)}

226 Chapter 7. Licensing

Page 231: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.databrew.AllowedStatistics(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AllowedStatistics

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Statistics': ([<class 'str'>], True)}

class troposphere.databrew.ColumnSelector(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ColumnSelector

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'Regex': (<class 'str'>, False)}

class troposphere.databrew.ColumnStatisticsConfiguration(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

ColumnStatisticsConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Selectors': ([<class 'troposphere.databrew.ColumnSelector'>], False),'Statistics': (<class 'troposphere.databrew.StatisticsConfiguration'>, True)}

class troposphere.databrew.ConditionExpression(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConditionExpression

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Condition': (<class 'str'>, True), 'TargetColumn': (<class 'str'>, True),'Value': (<class 'str'>, False)}

class troposphere.databrew.CsvOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CsvOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Delimiter': (<class 'str'>, False), 'HeaderRow': (<function boolean>, False)}

class troposphere.databrew.CsvOutputOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CsvOutputOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Delimiter': (<class 'str'>, False)}

class troposphere.databrew.DataCatalogInputDefinition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DataCatalogInputDefinition

7.3. troposphere 227

Page 232: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CatalogId': (<class 'str'>, False), 'DatabaseName': (<class 'str'>, False),'TableName': (<class 'str'>, False), 'TempDirectory': (<class'troposphere.databrew.S3Location'>, False)}

class troposphere.databrew.DataCatalogOutput(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DataCatalogOutput

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CatalogId': (<class 'str'>, False), 'DatabaseName': (<class 'str'>, True),'DatabaseOptions': (<class 'troposphere.databrew.DatabaseTableOutputOptions'>,False), 'Overwrite': (<function boolean>, False), 'S3Options': (<class'troposphere.databrew.S3TableOutputOptions'>, False), 'TableName': (<class 'str'>,True)}

class troposphere.databrew.DatabaseInputDefinition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DatabaseInputDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DatabaseTableName': (<class 'str'>, False), 'GlueConnectionName': (<class'str'>, True), 'QueryString': (<class 'str'>, False), 'TempDirectory': (<class'troposphere.databrew.S3Location'>, False)}

class troposphere.databrew.DatabaseOutput(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DatabaseOutput

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DatabaseOptions': (<class 'troposphere.databrew.DatabaseTableOutputOptions'>,True), 'DatabaseOutputMode': (<class 'str'>, False), 'GlueConnectionName': (<class'str'>, True)}

class troposphere.databrew.DatabaseTableOutputOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DatabaseTableOutputOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TableName': (<class 'str'>, True), 'TempDirectory': (<class'troposphere.databrew.S3Location'>, False)}

class troposphere.databrew.Dataset(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Dataset

228 Chapter 7. Licensing

Page 233: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Format': (<class 'str'>, False), 'FormatOptions': (<class'troposphere.databrew.FormatOptions'>, False), 'Input': (<class'troposphere.databrew.Input'>, True), 'Name': (<class 'str'>, True), 'PathOptions':(<class 'troposphere.databrew.PathOptions'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::DataBrew::Dataset'

class troposphere.databrew.DatasetParameter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DatasetParameter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CreateColumn': (<function boolean>, False), 'DatetimeOptions': (<class'troposphere.databrew.DatetimeOptions'>, False), 'Filter': (<class'troposphere.databrew.FilterExpression'>, False), 'Name': (<class 'str'>, True),'Type': (<class 'str'>, True)}

class troposphere.databrew.DatetimeOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DatetimeOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Format': (<class 'str'>, True), 'LocaleCode': (<class 'str'>, False),'TimezoneOffset': (<class 'str'>, False)}

class troposphere.databrew.EntityDetectorConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EntityDetectorConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllowedStatistics': (<class 'troposphere.databrew.AllowedStatistics'>, False),'EntityTypes': ([<class 'str'>], True)}

class troposphere.databrew.ExcelOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ExcelOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HeaderRow': (<function boolean>, False), 'SheetIndexes': ([<function integer>],False), 'SheetNames': ([<class 'str'>], False)}

class troposphere.databrew.FilesLimit(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FilesLimit

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxFiles': (<function integer>, True), 'Order': (<class 'str'>, False),'OrderedBy': (<class 'str'>, False)}

7.3. troposphere 229

Page 234: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.databrew.FilterExpression(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FilterExpression

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Expression': (<class 'str'>, True), 'ValuesMap': ([<class'troposphere.databrew.FilterValue'>], True)}

class troposphere.databrew.FilterValue(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FilterValue

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Value': (<class 'str'>, True), 'ValueReference': (<class 'str'>, True)}

class troposphere.databrew.FormatOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FormatOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Csv':(<class 'troposphere.databrew.CsvOptions'>, False), 'Excel': (<class'troposphere.databrew.ExcelOptions'>, False), 'Json': (<class'troposphere.databrew.JsonOptions'>, False)}

class troposphere.databrew.Input(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Input

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DataCatalogInputDefinition': (<class'troposphere.databrew.DataCatalogInputDefinition'>, False),'DatabaseInputDefinition': (<class 'troposphere.databrew.DatabaseInputDefinition'>,False), 'Metadata': (<class 'troposphere.databrew.Metadata'>, False),'S3InputDefinition': (<class 'troposphere.databrew.S3Location'>, False)}

class troposphere.databrew.Job(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Job

230 Chapter 7. Licensing

Page 235: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DataCatalogOutputs': ([<class 'troposphere.databrew.DataCatalogOutput'>], False),'DatabaseOutputs': ([<class 'troposphere.databrew.DatabaseOutput'>], False),'DatasetName': (<class 'str'>, False), 'EncryptionKeyArn': (<class 'str'>, False),'EncryptionMode': (<class 'str'>, False), 'JobSample': (<class'troposphere.databrew.JobSample'>, False), 'LogSubscription': (<class 'str'>,False), 'MaxCapacity': (<function integer>, False), 'MaxRetries': (<functioninteger>, False), 'Name': (<class 'str'>, True), 'OutputLocation': (<class'troposphere.databrew.OutputLocation'>, False), 'Outputs': ([<class'troposphere.databrew.Output'>], False), 'ProfileConfiguration': (<class'troposphere.databrew.ProfileConfiguration'>, False), 'ProjectName': (<class'str'>, False), 'Recipe': (<class 'troposphere.databrew.JobRecipe'>, False),'RoleArn': (<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False),'Timeout': (<function integer>, False), 'Type': (<class 'str'>, True),'ValidationConfigurations': ([<class'troposphere.databrew.ValidationConfiguration'>], False)}

resource_type: Optional[str] = 'AWS::DataBrew::Job'

class troposphere.databrew.JobRecipe(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

JobRecipe

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'Version': (<class 'str'>, False)}

class troposphere.databrew.JobS3Location(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

JobS3Location

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Bucket': (<class 'str'>, True), 'BucketOwner': (<class 'str'>, False), 'Key':(<class 'str'>, False)}

class troposphere.databrew.JobSample(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

JobSample

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Mode': (<class 'str'>, False), 'Size': (<function integer>, False)}

class troposphere.databrew.JsonOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

JsonOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MultiLine': (<function boolean>, False)}

class troposphere.databrew.Metadata(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Metadata

7.3. troposphere 231

Page 236: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SourceArn': (<class 'str'>, False)}

class troposphere.databrew.Output(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Output

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CompressionFormat': (<class 'str'>, False), 'Format': (<class 'str'>, False),'FormatOptions': (<class 'troposphere.databrew.OutputFormatOptions'>, False),'Location': (<class 'troposphere.databrew.S3Location'>, True), 'MaxOutputFiles':(<function integer>, False), 'Overwrite': (<function boolean>, False),'PartitionColumns': ([<class 'str'>], False)}

class troposphere.databrew.OutputFormatOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OutputFormatOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Csv':(<class 'troposphere.databrew.CsvOutputOptions'>, False)}

class troposphere.databrew.OutputLocation(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OutputLocation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Bucket': (<class 'str'>, True), 'BucketOwner': (<class 'str'>, False), 'Key':(<class 'str'>, False)}

class troposphere.databrew.PathOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PathOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FilesLimit': (<class 'troposphere.databrew.FilesLimit'>, False),'LastModifiedDateCondition': (<class 'troposphere.databrew.FilterExpression'>,False), 'Parameters': ([<class 'troposphere.databrew.PathParameter'>], False)}

class troposphere.databrew.PathParameter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PathParameter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DatasetParameter': (<class 'troposphere.databrew.DatasetParameter'>, True),'PathParameterName': (<class 'str'>, True)}

class troposphere.databrew.ProfileConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ProfileConfiguration

232 Chapter 7. Licensing

Page 237: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ColumnStatisticsConfigurations': ([<class'troposphere.databrew.ColumnStatisticsConfiguration'>], False),'DatasetStatisticsConfiguration': (<class'troposphere.databrew.StatisticsConfiguration'>, False),'EntityDetectorConfiguration': (<class'troposphere.databrew.EntityDetectorConfiguration'>, False), 'ProfileColumns':([<class 'troposphere.databrew.ColumnSelector'>], False)}

class troposphere.databrew.Project(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Project

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DatasetName': (<class 'str'>, True), 'Name': (<class 'str'>, True),'RecipeName': (<class 'str'>, True), 'RoleArn': (<class 'str'>, True), 'Sample':(<class 'troposphere.databrew.Sample'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::DataBrew::Project'

class troposphere.databrew.Recipe(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Recipe

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'Name': (<class 'str'>, True), 'Steps':([<class 'troposphere.databrew.RecipeStep'>], True), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::DataBrew::Recipe'

class troposphere.databrew.RecipeParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RecipeParameters

7.3. troposphere 233

Page 238: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AggregateFunction': (<class 'str'>, False), 'Base': (<class 'str'>, False),'CaseStatement': (<class 'str'>, False), 'CategoryMap': (<class 'str'>, False),'CharsToRemove': (<class 'str'>, False), 'CollapseConsecutiveWhitespace': (<class'str'>, False), 'ColumnDataType': (<class 'str'>, False), 'ColumnRange': (<class'str'>, False), 'Count': (<class 'str'>, False), 'CustomCharacters': (<class'str'>, False), 'CustomStopWords': (<class 'str'>, False), 'CustomValue': (<class'str'>, False), 'DatasetsColumns': (<class 'str'>, False), 'DateAddValue': (<class'str'>, False), 'DateTimeFormat': (<class 'str'>, False), 'DateTimeParameters':(<class 'str'>, False), 'DeleteOtherRows': (<class 'str'>, False), 'Delimiter':(<class 'str'>, False), 'EndPattern': (<class 'str'>, False), 'EndPosition':(<class 'str'>, False), 'EndValue': (<class 'str'>, False), 'ExpandContractions':(<class 'str'>, False), 'Exponent': (<class 'str'>, False), 'FalseString': (<class'str'>, False), 'GroupByAggFunctionOptions': (<class 'str'>, False),'GroupByColumns': (<class 'str'>, False), 'HiddenColumns': (<class 'str'>, False),'IgnoreCase': (<class 'str'>, False), 'IncludeInSplit': (<class 'str'>, False),'Input': (<class 'dict'>, False), 'Interval': (<class 'str'>, False), 'IsText':(<class 'str'>, False), 'JoinKeys': (<class 'str'>, False), 'JoinType': (<class'str'>, False), 'LeftColumns': (<class 'str'>, False), 'Limit': (<class 'str'>,False), 'LowerBound': (<class 'str'>, False), 'MapType': (<class 'str'>, False),'ModeType': (<class 'str'>, False), 'MultiLine': (<function boolean>, False),'NumRows': (<class 'str'>, False), 'NumRowsAfter': (<class 'str'>, False),'NumRowsBefore': (<class 'str'>, False), 'OrderByColumn': (<class 'str'>, False),'OrderByColumns': (<class 'str'>, False), 'Other': (<class 'str'>, False),'Pattern': (<class 'str'>, False), 'PatternOption1': (<class 'str'>, False),'PatternOption2': (<class 'str'>, False), 'PatternOptions': (<class 'str'>,False), 'Period': (<class 'str'>, False), 'Position': (<class 'str'>, False),'RemoveAllPunctuation': (<class 'str'>, False), 'RemoveAllQuotes': (<class 'str'>,False), 'RemoveAllWhitespace': (<class 'str'>, False), 'RemoveCustomCharacters':(<class 'str'>, False), 'RemoveCustomValue': (<class 'str'>, False),'RemoveLeadingAndTrailingPunctuation': (<class 'str'>, False),'RemoveLeadingAndTrailingQuotes': (<class 'str'>, False),'RemoveLeadingAndTrailingWhitespace': (<class 'str'>, False), 'RemoveLetters':(<class 'str'>, False), 'RemoveNumbers': (<class 'str'>, False),'RemoveSourceColumn': (<class 'str'>, False), 'RemoveSpecialCharacters': (<class'str'>, False), 'RightColumns': (<class 'str'>, False), 'SampleSize': (<class'str'>, False), 'SampleType': (<class 'str'>, False), 'SecondInput': (<class'str'>, False), 'SecondaryInputs': ([<class'troposphere.databrew.SecondaryInput'>], False), 'SheetIndexes': ([<functioninteger>], False), 'SheetNames': ([<class 'str'>], False), 'SourceColumn': (<class'str'>, False), 'SourceColumn1': (<class 'str'>, False), 'SourceColumn2': (<class'str'>, False), 'SourceColumns': (<class 'str'>, False), 'StartColumnIndex':(<class 'str'>, False), 'StartPattern': (<class 'str'>, False), 'StartPosition':(<class 'str'>, False), 'StartValue': (<class 'str'>, False), 'StemmingMode':(<class 'str'>, False), 'StepCount': (<class 'str'>, False), 'StepIndex': (<class'str'>, False), 'StopWordsMode': (<class 'str'>, False), 'Strategy': (<class'str'>, False), 'TargetColumn': (<class 'str'>, False), 'TargetColumnNames':(<class 'str'>, False), 'TargetDateFormat': (<class 'str'>, False), 'TargetIndex':(<class 'str'>, False), 'TimeZone': (<class 'str'>, False), 'TokenizerPattern':(<class 'str'>, False), 'TrueString': (<class 'str'>, False), 'UdfLang': (<class'str'>, False), 'Units': (<class 'str'>, False), 'UnpivotColumn': (<class 'str'>,False), 'UpperBound': (<class 'str'>, False), 'UseNewDataFrame': (<class 'str'>,False), 'Value': (<class 'str'>, False), 'Value1': (<class 'str'>, False),'Value2': (<class 'str'>, False), 'ValueColumn': (<class 'str'>, False),'ViewFrame': (<class 'str'>, False)}

234 Chapter 7. Licensing

Page 239: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.databrew.RecipeStep(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RecipeStep

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Action': (<class 'troposphere.databrew.Action'>, True), 'ConditionExpressions':([<class 'troposphere.databrew.ConditionExpression'>], False)}

class troposphere.databrew.Rule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Rule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CheckExpression': (<class 'str'>, True), 'ColumnSelectors': ([<class'troposphere.databrew.ColumnSelector'>], False), 'Disabled': (<function boolean>,False), 'Name': (<class 'str'>, True), 'SubstitutionMap': ([<class'troposphere.databrew.SubstitutionValue'>], False), 'Threshold': (<class'troposphere.databrew.Threshold'>, False)}

class troposphere.databrew.Ruleset(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Ruleset

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'Name': (<class 'str'>, True), 'Rules':([<class 'troposphere.databrew.Rule'>], True), 'Tags': (<class 'troposphere.Tags'>,False), 'TargetArn': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::DataBrew::Ruleset'

class troposphere.databrew.S3Location(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3Location

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Bucket': (<class 'str'>, True), 'Key': (<class 'str'>, False)}

class troposphere.databrew.S3TableOutputOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3TableOutputOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Location': (<class 'troposphere.databrew.JobS3Location'>, True)}

class troposphere.databrew.Sample(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Sample

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Size': (<function integer>, False), 'Type': (<class 'str'>, True)}

7.3. troposphere 235

Page 240: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.databrew.Schedule(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Schedule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CronExpression': (<class 'str'>, True), 'JobNames': ([<class 'str'>], False),'Name': (<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::DataBrew::Schedule'

class troposphere.databrew.SecondaryInput(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SecondaryInput

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DataCatalogInputDefinition': (<class'troposphere.databrew.DataCatalogInputDefinition'>, False), 'S3InputDefinition':(<class 'troposphere.databrew.S3Location'>, False)}

class troposphere.databrew.StatisticOverride(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

StatisticOverride

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Parameters': (<class 'dict'>, True), 'Statistic': (<class 'str'>, True)}

class troposphere.databrew.StatisticsConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

StatisticsConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'IncludedStatistics': ([<class 'str'>], False), 'Overrides': ([<class'troposphere.databrew.StatisticOverride'>], False)}

class troposphere.databrew.SubstitutionValue(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SubstitutionValue

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Value': (<class 'str'>, True), 'ValueReference': (<class 'str'>, True)}

class troposphere.databrew.Threshold(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Threshold

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Type': (<class 'str'>, False), 'Unit': (<class 'str'>, False), 'Value':(<function double>, True)}

236 Chapter 7. Licensing

Page 241: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.databrew.ValidationConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ValidationConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RulesetArn': (<class 'str'>, True), 'ValidationMode': (<class 'str'>, False)}

troposphere.datapipeline module

class troposphere.datapipeline.ObjectField(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ObjectField

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, True), 'RefValue': (<class 'str'>, False), 'StringValue': (<class'str'>, False)}

class troposphere.datapipeline.ParameterObject(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ParameterObject

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Attributes': ([<class 'troposphere.datapipeline.ParameterObjectAttribute'>],True), 'Id': (<class 'str'>, True)}

class troposphere.datapipeline.ParameterObjectAttribute(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

ParameterObjectAttribute

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, True), 'StringValue': (<class 'str'>, True)}

class troposphere.datapipeline.ParameterValue(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ParameterValue

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Id':(<class 'str'>, True), 'StringValue': (<class 'str'>, True)}

class troposphere.datapipeline.Pipeline(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Pipeline

7.3. troposphere 237

Page 242: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Activate': (<function boolean>, False), 'Description': (<class 'str'>, False),'Name': (<class 'str'>, True), 'ParameterObjects': ([<class'troposphere.datapipeline.ParameterObject'>], True), 'ParameterValues': ([<class'troposphere.datapipeline.ParameterValue'>], False), 'PipelineObjects': ([<class'troposphere.datapipeline.PipelineObject'>], False), 'PipelineTags': ([<class'troposphere.datapipeline.PipelineTag'>], False)}

resource_type: Optional[str] = 'AWS::DataPipeline::Pipeline'

class troposphere.datapipeline.PipelineObject(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PipelineObject

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Fields': ([<class 'troposphere.datapipeline.ObjectField'>], True), 'Id': (<class'str'>, True), 'Name': (<class 'str'>, True)}

class troposphere.datapipeline.PipelineTag(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PipelineTag

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, True), 'Value': (<class 'str'>, True)}

troposphere.datasync module

class troposphere.datasync.Agent(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Agent

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ActivationKey': (<class 'str'>, True), 'AgentName': (<class 'str'>, False),'SecurityGroupArns': ([<class 'str'>], False), 'SubnetArns': ([<class 'str'>],False), 'Tags': (<class 'troposphere.Tags'>, False), 'VpcEndpointId': (<class'str'>, False)}

resource_type: Optional[str] = 'AWS::DataSync::Agent'

class troposphere.datasync.Ec2Config(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Ec2Config

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SecurityGroupArns': ([<class 'str'>], True), 'SubnetArn': (<class 'str'>, True)}

class troposphere.datasync.FilterRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FilterRule

238 Chapter 7. Licensing

Page 243: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FilterType': (<class 'str'>, False), 'Value': (<class 'str'>, False)}

class troposphere.datasync.LocationEFS(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

LocationEFS

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Ec2Config': (<class 'troposphere.datasync.Ec2Config'>, True), 'EfsFilesystemArn':(<class 'str'>, True), 'Subdirectory': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::DataSync::LocationEFS'

class troposphere.datasync.LocationFSxLustre(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

LocationFSxLustre

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FsxFilesystemArn': (<class 'str'>, True), 'SecurityGroupArns': ([<class 'str'>],True), 'Subdirectory': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::DataSync::LocationFSxLustre'

class troposphere.datasync.LocationFSxOpenZFS(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

LocationFSxOpenZFS

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FsxFilesystemArn': (<class 'str'>, True), 'Protocol': (<class'troposphere.datasync.Protocol'>, True), 'SecurityGroupArns': ([<class 'str'>],True), 'Subdirectory': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::DataSync::LocationFSxOpenZFS'

class troposphere.datasync.LocationFSxWindows(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

LocationFSxWindows

7.3. troposphere 239

Page 244: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Domain': (<class 'str'>, False), 'FsxFilesystemArn': (<class 'str'>, True),'Password': (<class 'str'>, True), 'SecurityGroupArns': ([<class 'str'>], True),'Subdirectory': (<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>,False), 'User': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::DataSync::LocationFSxWindows'

class troposphere.datasync.LocationHDFS(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

LocationHDFS

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AgentArns': ([<class 'str'>], True), 'AuthenticationType': (<class 'str'>,True), 'BlockSize': (<function integer>, False), 'KerberosKeytab': (<class 'str'>,False), 'KerberosKrb5Conf': (<class 'str'>, False), 'KerberosPrincipal': (<class'str'>, False), 'KmsKeyProviderUri': (<class 'str'>, False), 'NameNodes': ([<class'troposphere.datasync.NameNode'>], True), 'QopConfiguration': (<class'troposphere.datasync.QopConfiguration'>, False), 'ReplicationFactor': (<functioninteger>, False), 'SimpleUser': (<class 'str'>, False), 'Subdirectory': (<class'str'>, False), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::DataSync::LocationHDFS'

class troposphere.datasync.LocationNFS(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

LocationNFS

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MountOptions': (<class 'troposphere.datasync.MountOptions'>, False),'OnPremConfig': (<class 'troposphere.datasync.OnPremConfig'>, True),'ServerHostname': (<class 'str'>, True), 'Subdirectory': (<class 'str'>, True),'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::DataSync::LocationNFS'

class troposphere.datasync.LocationObjectStorage(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

LocationObjectStorage

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessKey': (<class 'str'>, False), 'AgentArns': ([<class 'str'>], True),'BucketName': (<class 'str'>, True), 'SecretKey': (<class 'str'>, False),'ServerHostname': (<class 'str'>, True), 'ServerPort': (<function integer>,False), 'ServerProtocol': (<class 'str'>, False), 'Subdirectory': (<class 'str'>,False), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::DataSync::LocationObjectStorage'

240 Chapter 7. Licensing

Page 245: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.datasync.LocationS3(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

LocationS3

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'S3BucketArn': (<class 'str'>, True), 'S3Config': (<class'troposphere.datasync.S3Config'>, True), 'S3StorageClass': (<class 'str'>, False),'Subdirectory': (<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>,False)}

resource_type: Optional[str] = 'AWS::DataSync::LocationS3'

class troposphere.datasync.LocationSMB(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

LocationSMB

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AgentArns': ([<class 'str'>], True), 'Domain': (<class 'str'>, False),'MountOptions': (<class 'troposphere.datasync.MountOptions'>, False), 'Password':(<class 'str'>, True), 'ServerHostname': (<class 'str'>, True), 'Subdirectory':(<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False), 'User':(<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::DataSync::LocationSMB'

class troposphere.datasync.MountOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MountOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Version': (<class 'str'>, False)}

class troposphere.datasync.NFS(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NFS

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MountOptions': (<class 'troposphere.datasync.MountOptions'>, True)}

class troposphere.datasync.NameNode(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NameNode

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Hostname': (<class 'str'>, True), 'Port': (<function integer>, True)}

class troposphere.datasync.OnPremConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OnPremConfig

7.3. troposphere 241

Page 246: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AgentArns': ([<class 'str'>], True)}

class troposphere.datasync.Options(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Options

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Atime': (<class 'str'>, False), 'BytesPerSecond': (<function integer>, False),'Gid': (<class 'str'>, False), 'LogLevel': (<class 'str'>, False), 'Mtime':(<class 'str'>, False), 'OverwriteMode': (<class 'str'>, False),'PosixPermissions': (<class 'str'>, False), 'PreserveDeletedFiles': (<class'str'>, False), 'PreserveDevices': (<class 'str'>, False),'SecurityDescriptorCopyFlags': (<class 'str'>, False), 'TaskQueueing': (<class'str'>, False), 'TransferMode': (<class 'str'>, False), 'Uid': (<class 'str'>,False), 'VerifyMode': (<class 'str'>, False)}

class troposphere.datasync.Protocol(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Protocol

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'NFS':(<class 'troposphere.datasync.NFS'>, False)}

class troposphere.datasync.QopConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

QopConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DataTransferProtection': (<class 'str'>, False), 'RpcProtection': (<class'str'>, False)}

class troposphere.datasync.S3Config(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3Config

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketAccessRoleArn': (<class 'str'>, True)}

class troposphere.datasync.Task(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Task

242 Chapter 7. Licensing

Page 247: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudWatchLogGroupArn': (<class 'str'>, False), 'DestinationLocationArn':(<class 'str'>, True), 'Excludes': ([<class 'troposphere.datasync.FilterRule'>],False), 'Includes': ([<class 'troposphere.datasync.FilterRule'>], False), 'Name':(<class 'str'>, False), 'Options': (<class 'troposphere.datasync.Options'>, False),'Schedule': (<class 'troposphere.datasync.TaskSchedule'>, False),'SourceLocationArn': (<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>,False)}

resource_type: Optional[str] = 'AWS::DataSync::Task'

class troposphere.datasync.TaskSchedule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TaskSchedule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ScheduleExpression': (<class 'str'>, True)}

troposphere.dax module

class troposphere.dax.Cluster(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Cluster

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AvailabilityZones': ([<class 'str'>], False), 'ClusterEndpointEncryptionType':(<class 'str'>, False), 'ClusterName': (<class 'str'>, False), 'Description':(<class 'str'>, False), 'IAMRoleARN': (<class 'str'>, True), 'NodeType': (<class'str'>, True), 'NotificationTopicARN': (<class 'str'>, False), 'ParameterGroupName':(<class 'str'>, False), 'PreferredMaintenanceWindow': (<class 'str'>, False),'ReplicationFactor': (<function integer>, True), 'SSESpecification': (<class'troposphere.dax.SSESpecification'>, False), 'SecurityGroupIds': ([<class 'str'>],False), 'SubnetGroupName': (<class 'str'>, False), 'Tags': (<class 'dict'>,False)}

resource_type: Optional[str] = 'AWS::DAX::Cluster'

class troposphere.dax.ParameterGroup(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ParameterGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'ParameterGroupName': (<class 'str'>,False), 'ParameterNameValues': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::DAX::ParameterGroup'

class troposphere.dax.SSESpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 243

Page 248: Release 3.1

troposphere Documentation, Release 4.0.1

SSESpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SSEEnabled': (<function boolean>, False)}

class troposphere.dax.SubnetGroup(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

SubnetGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'SubnetGroupName': (<class 'str'>, False),'SubnetIds': ([<class 'str'>], True)}

resource_type: Optional[str] = 'AWS::DAX::SubnetGroup'

troposphere.detective module

class troposphere.detective.Graph(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Graph

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::Detective::Graph'

class troposphere.detective.MemberInvitation(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

MemberInvitation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DisableEmailNotification': (<function boolean>, False), 'GraphArn': (<class'str'>, True), 'MemberEmailAddress': (<class 'str'>, True), 'MemberId': (<class'str'>, True), 'Message': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::Detective::MemberInvitation'

troposphere.devopsguru module

class troposphere.devopsguru.CloudFormationCollectionFilter(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

CloudFormationCollectionFilter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'StackNames': ([<class 'str'>], False)}

244 Chapter 7. Licensing

Page 249: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.devopsguru.NotificationChannel(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

NotificationChannel

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Config': (<class 'troposphere.devopsguru.NotificationChannelConfig'>, True)}

resource_type: Optional[str] = 'AWS::DevOpsGuru::NotificationChannel'

class troposphere.devopsguru.NotificationChannelConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NotificationChannelConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Sns':(<class 'troposphere.devopsguru.SnsChannelConfig'>, False)}

class troposphere.devopsguru.ResourceCollection(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ResourceCollection

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ResourceCollectionFilter': (<class'troposphere.devopsguru.ResourceCollectionFilter'>, True)}

resource_type: Optional[str] = 'AWS::DevOpsGuru::ResourceCollection'

class troposphere.devopsguru.ResourceCollectionFilter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ResourceCollectionFilter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudFormation': (<class'troposphere.devopsguru.CloudFormationCollectionFilter'>, False), 'Tags': ([<class'troposphere.devopsguru.TagCollection'>], False)}

class troposphere.devopsguru.SnsChannelConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SnsChannelConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TopicArn': (<class 'str'>, False)}

class troposphere.devopsguru.TagCollection(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TagCollection

7.3. troposphere 245

Page 250: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AppBoundaryKey': (<class 'str'>, False), 'TagValues': ([<class 'str'>], False)}

troposphere.directoryservice module

class troposphere.directoryservice.MicrosoftAD(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

MicrosoftAD

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CreateAlias': (<function boolean>, False), 'Edition': (<class 'str'>, False),'EnableSso': (<function boolean>, False), 'Name': (<class 'str'>, True),'Password': (<class 'str'>, True), 'ShortName': (<class 'str'>, False),'VpcSettings': (<class 'troposphere.directoryservice.VpcSettings'>, True)}

resource_type: Optional[str] = 'AWS::DirectoryService::MicrosoftAD'

class troposphere.directoryservice.SimpleAD(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

SimpleAD

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CreateAlias': (<function boolean>, False), 'Description': (<class 'str'>,False), 'EnableSso': (<function boolean>, False), 'Name': (<class 'str'>, True),'Password': (<class 'str'>, True), 'ShortName': (<class 'str'>, False), 'Size':(<class 'str'>, True), 'VpcSettings': (<class'troposphere.directoryservice.VpcSettings'>, True)}

resource_type: Optional[str] = 'AWS::DirectoryService::SimpleAD'

class troposphere.directoryservice.VpcSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VpcSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SubnetIds': ([<class 'str'>], True), 'VpcId': (<class 'str'>, True)}

246 Chapter 7. Licensing

Page 251: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.dlm module

class troposphere.dlm.Action(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Action

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CrossRegionCopy': ([<class 'troposphere.dlm.CrossRegionCopyAction'>], True),'Name': (<class 'str'>, True)}

class troposphere.dlm.CreateRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CreateRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CronExpression': (<class 'str'>, False), 'Interval': (<functionvalidate_interval>, False), 'IntervalUnit': (<function validate_interval_unit>,False), 'Location': (<class 'str'>, False), 'Times': ([<class 'str'>], False)}

class troposphere.dlm.CrossRegionCopyAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CrossRegionCopyAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EncryptionConfiguration': (<class 'troposphere.dlm.EncryptionConfiguration'>,True), 'RetainRule': (<class 'troposphere.dlm.CrossRegionCopyRetainRule'>, False),'Target': (<class 'str'>, True)}

class troposphere.dlm.CrossRegionCopyDeprecateRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CrossRegionCopyDeprecateRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Interval': (<function integer>, True), 'IntervalUnit': (<class 'str'>, True)}

class troposphere.dlm.CrossRegionCopyRetainRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CrossRegionCopyRetainRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Interval': (<function integer>, True), 'IntervalUnit': (<class 'str'>, True)}

class troposphere.dlm.CrossRegionCopyRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CrossRegionCopyRule

7.3. troposphere 247

Page 252: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CmkArn': (<class 'str'>, False), 'CopyTags': (<function boolean>, False),'DeprecateRule': (<class 'troposphere.dlm.CrossRegionCopyDeprecateRule'>, False),'Encrypted': (<function boolean>, True), 'RetainRule': (<class'troposphere.dlm.CrossRegionCopyRetainRule'>, False), 'Target': (<class 'str'>,False), 'TargetRegion': (<class 'str'>, False)}

class troposphere.dlm.DeprecateRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DeprecateRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Count': (<function integer>, False), 'Interval': (<function integer>, False),'IntervalUnit': (<class 'str'>, False)}

class troposphere.dlm.EncryptionConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EncryptionConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CmkArn': (<class 'str'>, False), 'Encrypted': (<function boolean>, True)}

class troposphere.dlm.EventParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EventParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DescriptionRegex': (<class 'str'>, False), 'EventType': (<class 'str'>, True),'SnapshotOwner': ([<class 'str'>], True)}

class troposphere.dlm.EventSource(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EventSource

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Parameters': (<class 'troposphere.dlm.EventParameters'>, False), 'Type': (<class'str'>, True)}

class troposphere.dlm.FastRestoreRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FastRestoreRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AvailabilityZones': ([<class 'str'>], False), 'Count': (<function integer>,False), 'Interval': (<function integer>, False), 'IntervalUnit': (<class 'str'>,False)}

class troposphere.dlm.LifecyclePolicy(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

248 Chapter 7. Licensing

Page 253: Release 3.1

troposphere Documentation, Release 4.0.1

LifecyclePolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'ExecutionRoleArn': (<class 'str'>,False), 'PolicyDetails': (<class 'troposphere.dlm.PolicyDetails'>, False), 'State':(<function validate_state>, False), 'Tags': (<function validate_tags_or_list>,False)}

resource_type: Optional[str] = 'AWS::DLM::LifecyclePolicy'

class troposphere.dlm.Parameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Parameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ExcludeBootVolume': (<function boolean>, False), 'NoReboot': (<functionboolean>, False)}

class troposphere.dlm.PolicyDetails(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PolicyDetails

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Actions': ([<class 'troposphere.dlm.Action'>], False), 'EventSource': (<class'troposphere.dlm.EventSource'>, False), 'Parameters': (<class'troposphere.dlm.Parameters'>, False), 'PolicyType': (<class 'str'>, False),'ResourceLocations': ([<class 'str'>], False), 'ResourceTypes': ([<class 'str'>],False), 'Schedules': ([<class 'troposphere.dlm.Schedule'>], False), 'TargetTags':(<function validate_tags_or_list>, False)}

class troposphere.dlm.RetainRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RetainRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Count': (<function integer>, False), 'Interval': (<function integer>, False),'IntervalUnit': (<class 'str'>, False)}

class troposphere.dlm.Schedule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Schedule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CopyTags': (<function boolean>, False), 'CreateRule': (<class'troposphere.dlm.CreateRule'>, False), 'CrossRegionCopyRules': ([<class'troposphere.dlm.CrossRegionCopyRule'>], False), 'DeprecateRule': (<class'troposphere.dlm.DeprecateRule'>, False), 'FastRestoreRule': (<class'troposphere.dlm.FastRestoreRule'>, False), 'Name': (<class 'str'>, False),'RetainRule': (<class 'troposphere.dlm.RetainRule'>, False), 'ShareRules':([<class 'troposphere.dlm.ShareRule'>], False), 'TagsToAdd': (<functionvalidate_tags_or_list>, False), 'VariableTags': (<class 'troposphere.Tags'>,False)}

7.3. troposphere 249

Page 254: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.dlm.ShareRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ShareRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TargetAccounts': ([<class 'str'>], False), 'UnshareInterval': (<functioninteger>, False), 'UnshareIntervalUnit': (<class 'str'>, False)}

troposphere.dms module

class troposphere.dms.Certificate(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Certificate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateIdentifier': (<class 'str'>, False), 'CertificatePem': (<class'str'>, False), 'CertificateWallet': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::DMS::Certificate'

class troposphere.dms.DocDbSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DocDbSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DocsToInvestigate': (<function integer>, False), 'ExtractDocId': (<functionboolean>, False), 'NestingLevel': (<class 'str'>, False),'SecretsManagerAccessRoleArn': (<class 'str'>, False), 'SecretsManagerSecretId':(<class 'str'>, False)}

class troposphere.dms.DynamoDbSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DynamoDbSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ServiceAccessRoleArn': (<class 'str'>, False)}

class troposphere.dms.ElasticsearchSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ElasticsearchSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EndpointUri': (<class 'str'>, False), 'ErrorRetryDuration': (<function integer>,False), 'FullLoadErrorPercentage': (<function integer>, False),'ServiceAccessRoleArn': (<class 'str'>, False)}

class troposphere.dms.Endpoint(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

250 Chapter 7. Licensing

Page 255: Release 3.1

troposphere Documentation, Release 4.0.1

Endpoint

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateArn': (<class 'str'>, False), 'DatabaseName': (<class 'str'>, False),'DocDbSettings': (<class 'troposphere.dms.DocDbSettings'>, False),'DynamoDbSettings': (<class 'troposphere.dms.DynamoDbSettings'>, False),'ElasticsearchSettings': (<class 'troposphere.dms.ElasticsearchSettings'>, False),'EndpointIdentifier': (<class 'str'>, False), 'EndpointType': (<class 'str'>,True), 'EngineName': (<class 'str'>, True), 'ExtraConnectionAttributes': (<class'str'>, False), 'GcpMySQLSettings': (<class 'troposphere.dms.GcpMySQLSettings'>,False), 'IbmDb2Settings': (<class 'troposphere.dms.IbmDb2Settings'>, False),'KafkaSettings': (<class 'troposphere.dms.KafkaSettings'>, False),'KinesisSettings': (<class 'troposphere.dms.KinesisSettings'>, False), 'KmsKeyId':(<class 'str'>, False), 'MicrosoftSqlServerSettings': (<class'troposphere.dms.MicrosoftSqlServerSettings'>, False), 'MongoDbSettings': (<class'troposphere.dms.MongoDbSettings'>, False), 'MySqlSettings': (<class'troposphere.dms.MySqlSettings'>, False), 'NeptuneSettings': (<class'troposphere.dms.NeptuneSettings'>, False), 'OracleSettings': (<class'troposphere.dms.OracleSettings'>, False), 'Password': (<class 'str'>, False),'Port': (<function validate_network_port>, False), 'PostgreSqlSettings': (<class'troposphere.dms.PostgreSqlSettings'>, False), 'RedisSettings': (<class'troposphere.dms.RedisSettings'>, False), 'RedshiftSettings': (<class'troposphere.dms.RedshiftSettings'>, False), 'ResourceIdentifier': (<class 'str'>,False), 'S3Settings': (<class 'troposphere.dms.S3Settings'>, False), 'ServerName':(<class 'str'>, False), 'SslMode': (<class 'str'>, False), 'SybaseSettings':(<class 'troposphere.dms.SybaseSettings'>, False), 'Tags': (<class'troposphere.Tags'>, False), 'Username': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::DMS::Endpoint'

class troposphere.dms.EventSubscription(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

EventSubscription

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False), 'EventCategories': ([<class 'str'>],False), 'SnsTopicArn': (<class 'str'>, True), 'SourceIds': ([<class 'str'>],False), 'SourceType': (<class 'str'>, False), 'SubscriptionName': (<class 'str'>,False), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::DMS::EventSubscription'

class troposphere.dms.GcpMySQLSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GcpMySQLSettings

7.3. troposphere 251

Page 256: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AfterConnectScript': (<class 'str'>, False), 'CleanSourceMetadataOnMismatch':(<function boolean>, False), 'DatabaseName': (<class 'str'>, False),'EventsPollInterval': (<function integer>, False), 'MaxFileSize': (<functioninteger>, False), 'ParallelLoadThreads': (<function integer>, False), 'Password':(<class 'str'>, False), 'Port': (<function integer>, False),'SecretsManagerAccessRoleArn': (<class 'str'>, False), 'SecretsManagerSecretId':(<class 'str'>, False), 'ServerName': (<class 'str'>, False), 'ServerTimezone':(<class 'str'>, False), 'Username': (<class 'str'>, False)}

class troposphere.dms.IbmDb2Settings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

IbmDb2Settings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CurrentLsn': (<class 'str'>, False), 'MaxKBytesPerRead': (<function integer>,False), 'SecretsManagerAccessRoleArn': (<class 'str'>, False),'SecretsManagerSecretId': (<class 'str'>, False), 'SetDataCaptureChanges':(<function boolean>, False)}

class troposphere.dms.KafkaSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KafkaSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Broker': (<class 'str'>, False), 'IncludeControlDetails': (<function boolean>,False), 'IncludeNullAndEmpty': (<function boolean>, False),'IncludePartitionValue': (<function boolean>, False),'IncludeTableAlterOperations': (<function boolean>, False),'IncludeTransactionDetails': (<function boolean>, False), 'MessageFormat': (<class'str'>, False), 'MessageMaxBytes': (<function integer>, False), 'NoHexPrefix':(<function boolean>, False), 'PartitionIncludeSchemaTable': (<function boolean>,False), 'SaslPassword': (<class 'str'>, False), 'SaslUserName': (<class 'str'>,False), 'SecurityProtocol': (<class 'str'>, False), 'SslCaCertificateArn': (<class'str'>, False), 'SslClientCertificateArn': (<class 'str'>, False),'SslClientKeyArn': (<class 'str'>, False), 'SslClientKeyPassword': (<class 'str'>,False), 'Topic': (<class 'str'>, False)}

class troposphere.dms.KinesisSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KinesisSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'IncludeControlDetails': (<function boolean>, False), 'IncludeNullAndEmpty':(<function boolean>, False), 'IncludePartitionValue': (<function boolean>, False),'IncludeTableAlterOperations': (<function boolean>, False),'IncludeTransactionDetails': (<function boolean>, False), 'MessageFormat': (<class'str'>, False), 'NoHexPrefix': (<function boolean>, False),'PartitionIncludeSchemaTable': (<function boolean>, False), 'ServiceAccessRoleArn':(<class 'str'>, False), 'StreamArn': (<class 'str'>, False)}

252 Chapter 7. Licensing

Page 257: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.dms.MicrosoftSqlServerSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MicrosoftSqlServerSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BcpPacketSize': (<function integer>, False), 'ControlTablesFileGroup': (<class'str'>, False), 'QuerySingleAlwaysOnNode': (<function boolean>, False),'ReadBackupOnly': (<function boolean>, False), 'SafeguardPolicy': (<class 'str'>,False), 'SecretsManagerAccessRoleArn': (<class 'str'>, False),'SecretsManagerSecretId': (<class 'str'>, False), 'UseBcpFullLoad': (<functionboolean>, False), 'UseThirdPartyBackupDevice': (<function boolean>, False)}

class troposphere.dms.MongoDbSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MongoDbSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthMechanism': (<class 'str'>, False), 'AuthSource': (<class 'str'>, False),'AuthType': (<class 'str'>, False), 'DatabaseName': (<class 'str'>, False),'DocsToInvestigate': (<class 'str'>, False), 'ExtractDocId': (<class 'str'>,False), 'NestingLevel': (<class 'str'>, False), 'Password': (<class 'str'>,False), 'Port': (<function validate_network_port>, False),'SecretsManagerAccessRoleArn': (<class 'str'>, False), 'SecretsManagerSecretId':(<class 'str'>, False), 'ServerName': (<class 'str'>, False), 'Username': (<class'str'>, False)}

class troposphere.dms.MySqlSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MySqlSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AfterConnectScript': (<class 'str'>, False), 'CleanSourceMetadataOnMismatch':(<function boolean>, False), 'EventsPollInterval': (<function integer>, False),'MaxFileSize': (<function integer>, False), 'ParallelLoadThreads': (<functioninteger>, False), 'SecretsManagerAccessRoleArn': (<class 'str'>, False),'SecretsManagerSecretId': (<class 'str'>, False), 'ServerTimezone': (<class'str'>, False), 'TargetDbType': (<class 'str'>, False)}

class troposphere.dms.NeptuneSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NeptuneSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ErrorRetryDuration': (<function integer>, False), 'IamAuthEnabled': (<functionboolean>, False), 'MaxFileSize': (<function integer>, False), 'MaxRetryCount':(<function integer>, False), 'S3BucketFolder': (<class 'str'>, False),'S3BucketName': (<class 'str'>, False), 'ServiceAccessRoleArn': (<class 'str'>,False)}

class troposphere.dms.OracleSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 253

Page 258: Release 3.1

troposphere Documentation, Release 4.0.1

OracleSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessAlternateDirectly': (<function boolean>, False), 'AddSupplementalLogging':(<function boolean>, False), 'AdditionalArchivedLogDestId': (<function integer>,False), 'AllowSelectNestedTables': (<function boolean>, False),'ArchivedLogDestId': (<function integer>, False), 'ArchivedLogsOnly': (<functionboolean>, False), 'AsmPassword': (<class 'str'>, False), 'AsmServer': (<class'str'>, False), 'AsmUser': (<class 'str'>, False), 'CharLengthSemantics': (<class'str'>, False), 'DirectPathNoLog': (<function boolean>, False),'DirectPathParallelLoad': (<function boolean>, False),'EnableHomogenousTablespace': (<function boolean>, False),'ExtraArchivedLogDestIds': ([<function integer>], False),'FailTasksOnLobTruncation': (<function boolean>, False), 'NumberDatatypeScale':(<function integer>, False), 'OraclePathPrefix': (<class 'str'>, False),'ParallelAsmReadThreads': (<function integer>, False), 'ReadAheadBlocks':(<function integer>, False), 'ReadTableSpaceName': (<function boolean>, False),'ReplacePathPrefix': (<function boolean>, False), 'RetryInterval': (<functioninteger>, False), 'SecretsManagerAccessRoleArn': (<class 'str'>, False),'SecretsManagerOracleAsmAccessRoleArn': (<class 'str'>, False),'SecretsManagerOracleAsmSecretId': (<class 'str'>, False),'SecretsManagerSecretId': (<class 'str'>, False), 'SecurityDbEncryption': (<class'str'>, False), 'SecurityDbEncryptionName': (<class 'str'>, False),'SpatialDataOptionToGeoJsonFunctionName': (<class 'str'>, False),'StandbyDelayTime': (<function integer>, False), 'UseAlternateFolderForOnline':(<function boolean>, False), 'UseBFile': (<function boolean>, False),'UseDirectPathFullLoad': (<function boolean>, False), 'UseLogminerReader':(<function boolean>, False), 'UsePathPrefix': (<class 'str'>, False)}

class troposphere.dms.PostgreSqlSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PostgreSqlSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AfterConnectScript': (<class 'str'>, False), 'CaptureDdls': (<function boolean>,False), 'DdlArtifactsSchema': (<class 'str'>, False), 'ExecuteTimeout': (<functioninteger>, False), 'FailTasksOnLobTruncation': (<function boolean>, False),'HeartbeatEnable': (<function boolean>, False), 'HeartbeatFrequency': (<functioninteger>, False), 'HeartbeatSchema': (<class 'str'>, False), 'MaxFileSize':(<function integer>, False), 'PluginName': (<class 'str'>, False),'SecretsManagerAccessRoleArn': (<class 'str'>, False), 'SecretsManagerSecretId':(<class 'str'>, False), 'SlotName': (<class 'str'>, False)}

class troposphere.dms.RedisSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RedisSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthPassword': (<class 'str'>, False), 'AuthType': (<class 'str'>, False),'AuthUserName': (<class 'str'>, False), 'Port': (<function validate_network_port>,False), 'ServerName': (<class 'str'>, False), 'SslCaCertificateArn': (<class'str'>, False), 'SslSecurityProtocol': (<class 'str'>, False)}

254 Chapter 7. Licensing

Page 259: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.dms.RedshiftSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RedshiftSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AcceptAnyDate': (<function boolean>, False), 'AfterConnectScript': (<class'str'>, False), 'BucketFolder': (<class 'str'>, False), 'BucketName': (<class'str'>, False), 'CaseSensitiveNames': (<function boolean>, False), 'CompUpdate':(<function boolean>, False), 'ConnectionTimeout': (<function integer>, False),'DateFormat': (<class 'str'>, False), 'EmptyAsNull': (<function boolean>, False),'EncryptionMode': (<class 'str'>, False), 'ExplicitIds': (<function boolean>,False), 'FileTransferUploadStreams': (<function integer>, False), 'LoadTimeout':(<function integer>, False), 'MaxFileSize': (<function integer>, False),'RemoveQuotes': (<function boolean>, False), 'ReplaceChars': (<class 'str'>,False), 'ReplaceInvalidChars': (<class 'str'>, False),'SecretsManagerAccessRoleArn': (<class 'str'>, False), 'SecretsManagerSecretId':(<class 'str'>, False), 'ServerSideEncryptionKmsKeyId': (<class 'str'>, False),'ServiceAccessRoleArn': (<class 'str'>, False), 'TimeFormat': (<class 'str'>,False), 'TrimBlanks': (<function boolean>, False), 'TruncateColumns': (<functionboolean>, False), 'WriteBufferSize': (<function integer>, False)}

class troposphere.dms.ReplicationInstance(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

ReplicationInstance

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllocatedStorage': (<function integer>, False), 'AllowMajorVersionUpgrade':(<function boolean>, False), 'AutoMinorVersionUpgrade': (<function boolean>,False), 'AvailabilityZone': (<class 'str'>, False), 'EngineVersion': (<class'str'>, False), 'KmsKeyId': (<class 'str'>, False), 'MultiAZ': (<function boolean>,False), 'PreferredMaintenanceWindow': (<class 'str'>, False), 'PubliclyAccessible':(<function boolean>, False), 'ReplicationInstanceClass': (<class 'str'>, True),'ReplicationInstanceIdentifier': (<class 'str'>, False),'ReplicationSubnetGroupIdentifier': (<class 'str'>, False), 'ResourceIdentifier':(<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>, False),'VpcSecurityGroupIds': ([<class 'str'>], False)}

resource_type: Optional[str] = 'AWS::DMS::ReplicationInstance'

class troposphere.dms.ReplicationSubnetGroup(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

ReplicationSubnetGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ReplicationSubnetGroupDescription': (<class 'str'>, True),'ReplicationSubnetGroupIdentifier': (<class 'str'>, False), 'SubnetIds': ([<class'str'>], True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::DMS::ReplicationSubnetGroup'

7.3. troposphere 255

Page 260: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.dms.ReplicationTask(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ReplicationTask

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CdcStartPosition': (<class 'str'>, False), 'CdcStartTime': (<function double>,False), 'CdcStopPosition': (<class 'str'>, False), 'MigrationType': (<class'str'>, True), 'ReplicationInstanceArn': (<class 'str'>, True),'ReplicationTaskIdentifier': (<class 'str'>, False), 'ReplicationTaskSettings':(<class 'str'>, False), 'ResourceIdentifier': (<class 'str'>, False),'SourceEndpointArn': (<class 'str'>, True), 'TableMappings': (<class 'str'>,True), 'Tags': (<class 'troposphere.Tags'>, False), 'TargetEndpointArn': (<class'str'>, True), 'TaskData': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::DMS::ReplicationTask'

class troposphere.dms.S3Settings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3Settings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AddColumnName': (<function boolean>, False), 'BucketFolder': (<class 'str'>,False), 'BucketName': (<class 'str'>, False), 'CannedAclForObjects': (<class'str'>, False), 'CdcInsertsAndUpdates': (<function boolean>, False),'CdcInsertsOnly': (<function boolean>, False), 'CdcMaxBatchInterval': (<functioninteger>, False), 'CdcMinFileSize': (<function integer>, False), 'CdcPath':(<class 'str'>, False), 'CompressionType': (<class 'str'>, False), 'CsvDelimiter':(<class 'str'>, False), 'CsvNoSupValue': (<class 'str'>, False), 'CsvNullValue':(<class 'str'>, False), 'CsvRowDelimiter': (<class 'str'>, False), 'DataFormat':(<class 'str'>, False), 'DataPageSize': (<function integer>, False),'DatePartitionDelimiter': (<class 'str'>, False), 'DatePartitionEnabled':(<function boolean>, False), 'DatePartitionSequence': (<class 'str'>, False),'DatePartitionTimezone': (<class 'str'>, False), 'DictPageSizeLimit': (<functioninteger>, False), 'EnableStatistics': (<function boolean>, False), 'EncodingType':(<class 'str'>, False), 'EncryptionMode': (<class 'str'>, False),'ExternalTableDefinition': (<class 'str'>, False), 'IgnoreHeaderRows': (<functioninteger>, False), 'IncludeOpForFullLoad': (<function boolean>, False),'MaxFileSize': (<function integer>, False), 'ParquetTimestampInMillisecond':(<function boolean>, False), 'ParquetVersion': (<class 'str'>, False),'PreserveTransactions': (<function boolean>, False), 'Rfc4180': (<functionboolean>, False), 'RowGroupLength': (<function integer>, False),'ServerSideEncryptionKmsKeyId': (<class 'str'>, False), 'ServiceAccessRoleArn':(<class 'str'>, False), 'TimestampColumnName': (<class 'str'>, False),'UseCsvNoSupValue': (<function boolean>, False),'UseTaskStartTimeForFullLoadTimestamp': (<function boolean>, False)}

class troposphere.dms.SybaseSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SybaseSettings

256 Chapter 7. Licensing

Page 261: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SecretsManagerAccessRoleArn': (<class 'str'>, False), 'SecretsManagerSecretId':(<class 'str'>, False)}

troposphere.docdb module

class troposphere.docdb.DBCluster(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DBCluster

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AvailabilityZones': ([<class 'str'>], False), 'BackupRetentionPeriod':(<function integer>, False), 'CopyTagsToSnapshot': (<function boolean>, False),'DBClusterIdentifier': (<class 'str'>, False), 'DBClusterParameterGroupName':(<class 'str'>, False), 'DBSubnetGroupName': (<class 'str'>, False),'DeletionProtection': (<function boolean>, False), 'EnableCloudwatchLogsExports':([<class 'str'>], False), 'EngineVersion': (<class 'str'>, False), 'KmsKeyId':(<class 'str'>, False), 'MasterUserPassword': (<class 'str'>, False),'MasterUsername': (<class 'str'>, False), 'Port': (<function integer>, False),'PreferredBackupWindow': (<class 'str'>, False), 'PreferredMaintenanceWindow':(<class 'str'>, False), 'SnapshotIdentifier': (<class 'str'>, False),'StorageEncrypted': (<function boolean>, False), 'Tags': (<class'troposphere.Tags'>, False), 'VpcSecurityGroupIds': ([<class 'str'>], False)}

resource_type: Optional[str] = 'AWS::DocDB::DBCluster'

class troposphere.docdb.DBClusterParameterGroup(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DBClusterParameterGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, True), 'Family': (<class 'str'>, True), 'Name':(<class 'str'>, False), 'Parameters': (<class 'dict'>, True), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::DocDB::DBClusterParameterGroup'

class troposphere.docdb.DBInstance(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DBInstance

7.3. troposphere 257

Page 262: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoMinorVersionUpgrade': (<function boolean>, False), 'AvailabilityZone':(<class 'str'>, False), 'DBClusterIdentifier': (<class 'str'>, True),'DBInstanceClass': (<class 'str'>, True), 'DBInstanceIdentifier': (<class 'str'>,False), 'EnablePerformanceInsights': (<function boolean>, False),'PreferredMaintenanceWindow': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::DocDB::DBInstance'

class troposphere.docdb.DBSubnetGroup(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DBSubnetGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DBSubnetGroupDescription': (<class 'str'>, True), 'DBSubnetGroupName': (<class'str'>, False), 'SubnetIds': ([<class 'str'>], True), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::DocDB::DBSubnetGroup'

troposphere.dynamodb module

class troposphere.dynamodb.AttributeDefinition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AttributeDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AttributeName': (<class 'str'>, True), 'AttributeType': (<functionattribute_type_validator>, True)}

class troposphere.dynamodb.CapacityAutoScalingSettings(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CapacityAutoScalingSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxCapacity': (<function integer>, True), 'MinCapacity': (<function integer>,True), 'SeedCapacity': (<function integer>, False),'TargetTrackingScalingPolicyConfiguration': (<class'troposphere.dynamodb.TargetTrackingScalingPolicyConfiguration'>, True)}

class troposphere.dynamodb.ContributorInsightsSpecification(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ContributorInsightsSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, True)}

258 Chapter 7. Licensing

Page 263: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.dynamodb.GlobalSecondaryIndex(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GlobalSecondaryIndex

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContributorInsightsSpecification': (<class'troposphere.dynamodb.ContributorInsightsSpecification'>, False), 'IndexName':(<class 'str'>, True), 'KeySchema': ([<class 'troposphere.dynamodb.KeySchema'>],True), 'Projection': (<class 'troposphere.dynamodb.Projection'>, True),'ProvisionedThroughput': (<class 'troposphere.dynamodb.ProvisionedThroughput'>,False)}

class troposphere.dynamodb.GlobalTable(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

GlobalTable

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AttributeDefinitions': ([<class 'troposphere.dynamodb.AttributeDefinition'>],True), 'BillingMode': (<class 'str'>, False), 'GlobalSecondaryIndexes': ([<class'troposphere.dynamodb.GlobalTableGlobalSecondaryIndex'>], False), 'KeySchema':([<class 'troposphere.dynamodb.KeySchema'>], True), 'LocalSecondaryIndexes':([<class 'troposphere.dynamodb.LocalSecondaryIndex'>], False), 'Replicas': ([<class'troposphere.dynamodb.ReplicaSpecification'>], True), 'SSESpecification': (<class'troposphere.dynamodb.GlobalTableSSESpecification'>, False), 'StreamSpecification':(<class 'troposphere.dynamodb.StreamSpecification'>, False), 'TableName': (<class'str'>, False), 'TimeToLiveSpecification': (<class'troposphere.dynamodb.TimeToLiveSpecification'>, False),'WriteProvisionedThroughputSettings': (<class'troposphere.dynamodb.WriteProvisionedThroughputSettings'>, False)}

resource_type: Optional[str] = 'AWS::DynamoDB::GlobalTable'

class troposphere.dynamodb.GlobalTableGlobalSecondaryIndex(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

GlobalTableGlobalSecondaryIndex

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'IndexName': (<class 'str'>, True), 'KeySchema': ([<class'troposphere.dynamodb.KeySchema'>], True), 'Projection': (<class'troposphere.dynamodb.Projection'>, True), 'WriteProvisionedThroughputSettings':(<class 'troposphere.dynamodb.WriteProvisionedThroughputSettings'>, False)}

class troposphere.dynamodb.GlobalTableSSESpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GlobalTableSSESpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SSEEnabled': (<function boolean>, True), 'SSEType': (<class 'str'>, False)}

7.3. troposphere 259

Page 264: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.dynamodb.KeySchema(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KeySchema

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AttributeName': (<class 'str'>, True), 'KeyType': (<functionkey_type_validator>, True)}

class troposphere.dynamodb.KinesisStreamSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KinesisStreamSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'StreamArn': (<class 'str'>, True)}

class troposphere.dynamodb.LocalSecondaryIndex(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LocalSecondaryIndex

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'IndexName': (<class 'str'>, True), 'KeySchema': ([<class'troposphere.dynamodb.KeySchema'>], True), 'Projection': (<class'troposphere.dynamodb.Projection'>, True)}

class troposphere.dynamodb.PointInTimeRecoverySpecification(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

PointInTimeRecoverySpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PointInTimeRecoveryEnabled': (<function boolean>, False)}

class troposphere.dynamodb.Projection(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Projection

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'NonKeyAttributes': ([<class 'str'>], False), 'ProjectionType': (<functionprojection_type_validator>, False)}

class troposphere.dynamodb.ProvisionedThroughput(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ProvisionedThroughput

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ReadCapacityUnits': (<function integer>, True), 'WriteCapacityUnits': (<functioninteger>, True)}

class troposphere.dynamodb.ReadProvisionedThroughputSettings(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

260 Chapter 7. Licensing

Page 265: Release 3.1

troposphere Documentation, Release 4.0.1

ReadProvisionedThroughputSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ReadCapacityAutoScalingSettings': (<class'troposphere.dynamodb.CapacityAutoScalingSettings'>, False), 'ReadCapacityUnits':(<function integer>, False)}

class troposphere.dynamodb.ReplicaGlobalSecondaryIndexSpecification(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ReplicaGlobalSecondaryIndexSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContributorInsightsSpecification': (<class'troposphere.dynamodb.ContributorInsightsSpecification'>, False), 'IndexName':(<class 'str'>, True), 'ReadProvisionedThroughputSettings': (<class'troposphere.dynamodb.ReadProvisionedThroughputSettings'>, False)}

class troposphere.dynamodb.ReplicaSSESpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ReplicaSSESpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KMSMasterKeyId': (<class 'str'>, True)}

class troposphere.dynamodb.ReplicaSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ReplicaSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContributorInsightsSpecification': (<class'troposphere.dynamodb.ContributorInsightsSpecification'>, False),'GlobalSecondaryIndexes': ([<class'troposphere.dynamodb.ReplicaGlobalSecondaryIndexSpecification'>], False),'PointInTimeRecoverySpecification': (<class'troposphere.dynamodb.PointInTimeRecoverySpecification'>, False),'ReadProvisionedThroughputSettings': (<class'troposphere.dynamodb.ReadProvisionedThroughputSettings'>, False), 'Region':(<class 'str'>, True), 'SSESpecification': (<class'troposphere.dynamodb.ReplicaSSESpecification'>, False), 'TableClass': (<class'str'>, False), 'Tags': (<class 'troposphere.Tags'>, False)}

class troposphere.dynamodb.SSESpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SSESpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KMSMasterKeyId': (<class 'str'>, False), 'SSEEnabled': (<function boolean>,True), 'SSEType': (<class 'str'>, False)}

class troposphere.dynamodb.StreamSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 261

Page 266: Release 3.1

troposphere Documentation, Release 4.0.1

StreamSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'StreamViewType': (<class 'str'>, True)}

class troposphere.dynamodb.Table(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Table

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AttributeDefinitions': ([<class 'troposphere.dynamodb.AttributeDefinition'>],False), 'BillingMode': (<function billing_mode_validator>, False),'ContributorInsightsSpecification': (<class'troposphere.dynamodb.ContributorInsightsSpecification'>, False),'GlobalSecondaryIndexes': ([<class 'troposphere.dynamodb.GlobalSecondaryIndex'>],False), 'KeySchema': ([<class 'troposphere.dynamodb.KeySchema'>], True),'KinesisStreamSpecification': (<class'troposphere.dynamodb.KinesisStreamSpecification'>, False), 'LocalSecondaryIndexes':([<class 'troposphere.dynamodb.LocalSecondaryIndex'>], False),'PointInTimeRecoverySpecification': (<class'troposphere.dynamodb.PointInTimeRecoverySpecification'>, False),'ProvisionedThroughput': (<class 'troposphere.dynamodb.ProvisionedThroughput'>,False), 'SSESpecification': (<class 'troposphere.dynamodb.SSESpecification'>,False), 'StreamSpecification': (<class 'troposphere.dynamodb.StreamSpecification'>,False), 'TableClass': (<function table_class_validator>, False), 'TableName':(<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>, False),'TimeToLiveSpecification': (<class 'troposphere.dynamodb.TimeToLiveSpecification'>,False)}

resource_type: Optional[str] = 'AWS::DynamoDB::Table'

validate()

class troposphere.dynamodb.TargetTrackingScalingPolicyConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

TargetTrackingScalingPolicyConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DisableScaleIn': (<function boolean>, False), 'ScaleInCooldown': (<functioninteger>, False), 'ScaleOutCooldown': (<function integer>, False), 'TargetValue':(<function double>, True)}

class troposphere.dynamodb.TimeToLiveSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TimeToLiveSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AttributeName': (<class 'str'>, True), 'Enabled': (<function boolean>, True)}

262 Chapter 7. Licensing

Page 267: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.dynamodb.WriteProvisionedThroughputSettings(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

WriteProvisionedThroughputSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'WriteCapacityAutoScalingSettings': (<class'troposphere.dynamodb.CapacityAutoScalingSettings'>, False)}

troposphere.ec2 module

class troposphere.ec2.AcceleratorCount(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AcceleratorCount

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.ec2.AcceleratorCountRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AcceleratorCountRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.ec2.AcceleratorTotalMemoryMiB(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AcceleratorTotalMemoryMiB

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.ec2.AcceleratorTotalMemoryMiBRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AcceleratorTotalMemoryMiBRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.ec2.AccessScopePathRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AccessScopePathRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Destination': (<class 'troposphere.ec2.PathStatementRequest'>, False), 'Source':(<class 'troposphere.ec2.PathStatementRequest'>, False), 'ThroughResources':([<class 'troposphere.ec2.ThroughResourcesStatementRequest'>], False)}

7.3. troposphere 263

Page 268: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.ec2.AssociationParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AssociationParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, True), 'Value': ([<class 'str'>], True)}

class troposphere.ec2.BaselineEbsBandwidthMbps(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BaselineEbsBandwidthMbps

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.ec2.BaselineEbsBandwidthMbpsRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BaselineEbsBandwidthMbpsRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.ec2.BlockDeviceMapping(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BlockDeviceMapping

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeviceName': (<class 'str'>, True), 'Ebs': (<class'troposphere.ec2.EBSBlockDevice'>, False), 'NoDevice': (<class 'dict'>, False),'VirtualName': (<class 'str'>, False)}

class troposphere.ec2.CapacityRebalance(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CapacityRebalance

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ReplacementStrategy': (<class 'str'>, False), 'TerminationDelay': (<functioninteger>, False)}

class troposphere.ec2.CapacityReservation(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

CapacityReservation

264 Chapter 7. Licensing

Page 269: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AvailabilityZone': (<class 'str'>, True), 'EbsOptimized': (<function boolean>,False), 'EndDate': (<class 'str'>, False), 'EndDateType': (<class 'str'>, False),'EphemeralStorage': (<function boolean>, False), 'InstanceCount': (<functioninteger>, True), 'InstanceMatchCriteria': (<class 'str'>, False),'InstancePlatform': (<class 'str'>, True), 'InstanceType': (<class 'str'>, True),'OutPostArn': (<class 'str'>, False), 'PlacementGroupArn': (<class 'str'>, False),'TagSpecifications': ([<class 'troposphere.ec2.TagSpecifications'>], False),'Tenancy': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::EC2::CapacityReservation'

class troposphere.ec2.CapacityReservationFleet(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

CapacityReservationFleet

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllocationStrategy': (<class 'str'>, False), 'EndDate': (<class 'str'>, False),'InstanceMatchCriteria': (<class 'str'>, False), 'InstanceTypeSpecifications':([<class 'troposphere.ec2.InstanceTypeSpecification'>], False), 'NoRemoveEndDate':(<function boolean>, False), 'RemoveEndDate': (<function boolean>, False),'TagSpecifications': ([<class 'troposphere.ec2.TagSpecifications'>], False),'Tenancy': (<class 'str'>, False), 'TotalTargetCapacity': (<function integer>,False)}

resource_type: Optional[str] = 'AWS::EC2::CapacityReservationFleet'

class troposphere.ec2.CapacityReservationOptionsRequest(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

CapacityReservationOptionsRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'UsageStrategy': (<class 'str'>, False)}

class troposphere.ec2.CapacityReservationSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CapacityReservationSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CapacityReservationPreference': (<class 'str'>, False),'CapacityReservationTarget': (<class 'troposphere.ec2.CapacityReservationTarget'>,False)}

class troposphere.ec2.CapacityReservationTarget(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CapacityReservationTarget

7.3. troposphere 265

Page 270: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CapacityReservationId': (<class 'str'>, False),'CapacityReservationResourceGroupArn': (<class 'str'>, False)}

class troposphere.ec2.CarrierGateway(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

CarrierGateway

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Tags': (<class 'troposphere.Tags'>, False), 'VpcId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::CarrierGateway'

class troposphere.ec2.CertificateAuthenticationRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CertificateAuthenticationRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClientRootCertificateChainArn': (<class 'str'>, True)}

class troposphere.ec2.ClassicLoadBalancer(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ClassicLoadBalancer

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True)}

class troposphere.ec2.ClassicLoadBalancersConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ClassicLoadBalancersConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClassicLoadBalancers': ([<class 'troposphere.ec2.ClassicLoadBalancer'>], True)}

class troposphere.ec2.ClientAuthenticationRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ClientAuthenticationRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ActiveDirectory': (<class'troposphere.ec2.DirectoryServiceAuthenticationRequest'>, False),'FederatedAuthentication': (<class'troposphere.ec2.FederatedAuthenticationRequest'>, False), 'MutualAuthentication':(<class 'troposphere.ec2.CertificateAuthenticationRequest'>, False), 'Type':(<class 'str'>, True)}

class troposphere.ec2.ClientConnectOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ClientConnectOptions

266 Chapter 7. Licensing

Page 271: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, True), 'LambdaFunctionArn': (<class 'str'>,False)}

class troposphere.ec2.ClientLoginBannerOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ClientLoginBannerOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BannerText': (<class 'str'>, False), 'Enabled': (<function boolean>, True)}

class troposphere.ec2.ClientVpnAuthorizationRule(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ClientVpnAuthorizationRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessGroupId': (<class 'str'>, False), 'AuthorizeAllGroups': (<functionboolean>, False), 'ClientVpnEndpointId': (<class 'str'>, True), 'Description':(<class 'str'>, False), 'TargetNetworkCidr': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::ClientVpnAuthorizationRule'

class troposphere.ec2.ClientVpnEndpoint(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ClientVpnEndpoint

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthenticationOptions': ([<class 'troposphere.ec2.ClientAuthenticationRequest'>],True), 'ClientCidrBlock': (<class 'str'>, True), 'ClientConnectOptions': (<class'troposphere.ec2.ClientConnectOptions'>, False), 'ClientLoginBannerOptions':(<class 'troposphere.ec2.ClientLoginBannerOptions'>, False), 'ConnectionLogOptions':(<class 'troposphere.ec2.ConnectionLogOptions'>, True), 'Description': (<class'str'>, False), 'DnsServers': ([<class 'str'>], False), 'SecurityGroupIds':([<class 'str'>], False), 'SelfServicePortal': (<functionvalidate_clientvpnendpoint_selfserviceportal>, False), 'ServerCertificateArn':(<class 'str'>, True), 'SessionTimeoutHours': (<function integer>, False),'SplitTunnel': (<function boolean>, False), 'TagSpecifications': ([<class'troposphere.ec2.TagSpecifications'>], False), 'TransportProtocol': (<class 'str'>,False), 'VpcId': (<class 'str'>, False), 'VpnPort': (<functionvalidate_clientvpnendpoint_vpnport>, False)}

resource_type: Optional[str] = 'AWS::EC2::ClientVpnEndpoint'

class troposphere.ec2.ClientVpnRoute(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ClientVpnRoute

7.3. troposphere 267

Page 272: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClientVpnEndpointId': (<class 'str'>, True), 'Description': (<class 'str'>,False), 'DestinationCidrBlock': (<class 'str'>, True), 'TargetVpcSubnetId':(<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::ClientVpnRoute'

class troposphere.ec2.ClientVpnTargetNetworkAssociation(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ClientVpnTargetNetworkAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClientVpnEndpointId': (<class 'str'>, True), 'SubnetId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::ClientVpnTargetNetworkAssociation'

class troposphere.ec2.ConnectionLogOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConnectionLogOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudwatchLogGroup': (<class 'str'>, False), 'CloudwatchLogStream': (<class'str'>, False), 'Enabled': (<function boolean>, True)}

class troposphere.ec2.CpuOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CpuOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CoreCount': (<function integer>, False), 'ThreadsPerCore': (<function integer>,False)}

class troposphere.ec2.CreditSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CreditSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CPUCredits': (<class 'str'>, False)}

class troposphere.ec2.CustomerGateway(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

CustomerGateway

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BgpAsn': (<function integer>, True), 'IpAddress': (<class 'str'>, True), 'Tags':(<function validate_tags_or_list>, False), 'Type': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::CustomerGateway'

268 Chapter 7. Licensing

Page 273: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.ec2.DHCPOptions(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DHCPOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DomainName': (<class 'str'>, False), 'DomainNameServers': ([<class 'str'>],False), 'NetbiosNameServers': ([<class 'str'>], False), 'NetbiosNodeType':(<function integer>, False), 'NtpServers': ([<class 'str'>], False), 'Tags':(<function validate_tags_or_list>, False)}

resource_type: Optional[str] = 'AWS::EC2::DHCPOptions'

class troposphere.ec2.DirectoryServiceAuthenticationRequest(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

DirectoryServiceAuthenticationRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DirectoryId': (<class 'str'>, True)}

class troposphere.ec2.EBSBlockDevice(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EBSBlockDevice

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeleteOnTermination': (<function boolean>, False), 'Encrypted': (<functionboolean>, False), 'Iops': (<function integer>, False), 'KmsKeyId': (<class 'str'>,False), 'SnapshotId': (<class 'str'>, False), 'Throughput': (<function integer>,False), 'VolumeSize': (<function integer>, False), 'VolumeType': (<class 'str'>,False)}

class troposphere.ec2.EC2Fleet(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

EC2Fleet

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Context': (<class 'str'>, False), 'ExcessCapacityTerminationPolicy': (<class'str'>, False), 'LaunchTemplateConfigs': ([<class'troposphere.ec2.FleetLaunchTemplateConfigRequest'>], True), 'OnDemandOptions':(<class 'troposphere.ec2.OnDemandOptionsRequest'>, False),'ReplaceUnhealthyInstances': (<function boolean>, False), 'SpotOptions': (<class'troposphere.ec2.SpotOptionsRequest'>, False), 'TagSpecifications': ([<class'troposphere.ec2.TagSpecifications'>], False), 'TargetCapacitySpecification':(<class 'troposphere.ec2.TargetCapacitySpecificationRequest'>, True),'TerminateInstancesWithExpiration': (<function boolean>, False), 'Type': (<class'str'>, False), 'ValidFrom': (<class 'str'>, False), 'ValidUntil': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::EC2::EC2Fleet'

7.3. troposphere 269

Page 274: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.ec2.EIP(title: Optional[str], template: Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

EIP

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Domain': (<class 'str'>, False), 'InstanceId': (<class 'str'>, False),'PublicIpv4Pool': (<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>,False)}

resource_type: Optional[str] = 'AWS::EC2::EIP'

class troposphere.ec2.EIPAssociation(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

EIPAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllocationId': (<class 'str'>, False), 'EIP': (<class 'str'>, False),'InstanceId': (<class 'str'>, False), 'NetworkInterfaceId': (<class 'str'>,False), 'PrivateIpAddress': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::EC2::EIPAssociation'

class troposphere.ec2.EbsBlockDevice(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EbsBlockDevice

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeleteOnTermination': (<function boolean>, False), 'Encrypted': (<functionboolean>, False), 'Iops': (<function integer>, False), 'SnapshotId': (<class'str'>, False), 'VolumeSize': (<function integer>, False), 'VolumeType': (<class'str'>, False)}

class troposphere.ec2.Egress(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Egress

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CidrIp': (<class 'str'>, False), 'CidrIpv6': (<class 'str'>, False),'Description': (<class 'str'>, False), 'DestinationPrefixListId': (<class 'str'>,False), 'DestinationSecurityGroupId': (<class 'str'>, False), 'FromPort':(<function integer>, False), 'IpProtocol': (<class 'str'>, True), 'ToPort':(<function integer>, False)}

class troposphere.ec2.EgressOnlyInternetGateway(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

EgressOnlyInternetGateway

270 Chapter 7. Licensing

Page 275: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'VpcId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::EgressOnlyInternetGateway'

class troposphere.ec2.ElasticGpuSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ElasticGpuSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Type': (<class 'str'>, False)}

class troposphere.ec2.ElasticInferenceAccelerator(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ElasticInferenceAccelerator

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Count': (<function integer>, False), 'Type': (<functionvalidate_elasticinferenceaccelerator_type>, True)}

class troposphere.ec2.EnclaveCertificateIamRoleAssociation(title: Optional[str], template:Optional[troposphere.Template] =None, validation: bool = True,**kwargs: Any)

Bases: troposphere.AWSObject

EnclaveCertificateIamRoleAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateArn': (<class 'str'>, True), 'RoleArn': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::EnclaveCertificateIamRoleAssociation'

class troposphere.ec2.EnclaveOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EnclaveOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False)}

class troposphere.ec2.Entry(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Entry

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Cidr': (<class 'str'>, True), 'Description': (<class 'str'>, False)}

class troposphere.ec2.FederatedAuthenticationRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FederatedAuthenticationRequest

7.3. troposphere 271

Page 276: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SAMLProviderArn': (<class 'str'>, True), 'SelfServiceSAMLProviderArn': (<class'str'>, False)}

class troposphere.ec2.FleetLaunchTemplateConfigRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FleetLaunchTemplateConfigRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LaunchTemplateSpecification': (<class'troposphere.ec2.FleetLaunchTemplateSpecificationRequest'>, False), 'Overrides':([<class 'troposphere.ec2.FleetLaunchTemplateOverridesRequest'>], False)}

class troposphere.ec2.FleetLaunchTemplateOverridesRequest(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

FleetLaunchTemplateOverridesRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AvailabilityZone': (<class 'str'>, False), 'InstanceRequirements': (<class'troposphere.ec2.InstanceRequirementsRequest'>, False), 'InstanceType': (<class'str'>, False), 'MaxPrice': (<class 'str'>, False), 'Placement': (<class'troposphere.ec2.Placement'>, False), 'Priority': (<function double>, False),'SubnetId': (<class 'str'>, False), 'WeightedCapacity': (<function double>,False)}

class troposphere.ec2.FleetLaunchTemplateSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FleetLaunchTemplateSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LaunchTemplateId': (<class 'str'>, False), 'LaunchTemplateName': (<class 'str'>,False), 'Version': (<class 'str'>, True)}

class troposphere.ec2.FleetLaunchTemplateSpecificationRequest(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

FleetLaunchTemplateSpecificationRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LaunchTemplateId': (<class 'str'>, False), 'LaunchTemplateName': (<class 'str'>,False), 'Version': (<class 'str'>, False)}

class troposphere.ec2.FlowLog(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

FlowLog

272 Chapter 7. Licensing

Page 277: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeliverLogsPermissionArn': (<class 'str'>, False), 'DestinationOptions': (<class'dict'>, False), 'LogDestination': (<class 'str'>, False), 'LogDestinationType':(<class 'str'>, False), 'LogFormat': (<class 'str'>, False), 'LogGroupName':(<class 'str'>, False), 'MaxAggregationInterval': (<function integer>, False),'ResourceId': (<class 'str'>, True), 'ResourceType': (<class 'str'>, True),'Tags': (<class 'troposphere.Tags'>, False), 'TrafficType': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::FlowLog'

class troposphere.ec2.GatewayRouteTableAssociation(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

GatewayRouteTableAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GatewayId': (<class 'str'>, True), 'RouteTableId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::GatewayRouteTableAssociation'

class troposphere.ec2.HibernationOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HibernationOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Configured': (<function boolean>, False)}

class troposphere.ec2.Host(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Host

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoPlacement': (<class 'str'>, False), 'AvailabilityZone': (<class 'str'>,True), 'HostRecovery': (<class 'str'>, False), 'InstanceType': (<class 'str'>,True)}

resource_type: Optional[str] = 'AWS::EC2::Host'

class troposphere.ec2.ICMP(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ICMP

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Code': (<function integer>, False), 'Type': (<function integer>, False)}

class troposphere.ec2.IPAM(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

IPAM

7.3. troposphere 273

Page 278: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'OperatingRegions': ([<class'troposphere.ec2.IpamOperatingRegion'>], False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::EC2::IPAM'

class troposphere.ec2.IPAMAllocation(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

IPAMAllocation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Cidr': (<class 'str'>, False), 'Description': (<class 'str'>, False),'IpamPoolId': (<class 'str'>, True), 'NetmaskLength': (<function integer>, False)}

resource_type: Optional[str] = 'AWS::EC2::IPAMAllocation'

class troposphere.ec2.IPAMPool(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

IPAMPool

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AddressFamily': (<class 'str'>, True), 'AllocationDefaultNetmaskLength':(<function integer>, False), 'AllocationMaxNetmaskLength': (<function integer>,False), 'AllocationMinNetmaskLength': (<function integer>, False),'AllocationResourceTags': (<class 'troposphere.Tags'>, False), 'AutoImport':(<function boolean>, False), 'Description': (<class 'str'>, False), 'IpamScopeId':(<class 'str'>, True), 'Locale': (<class 'str'>, False), 'ProvisionedCidrs':([<class 'troposphere.ec2.ProvisionedCidr'>], False), 'PubliclyAdvertisable':(<function boolean>, False), 'SourceIpamPoolId': (<class 'str'>, False), 'Tags':(<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::EC2::IPAMPool'

class troposphere.ec2.IPAMScope(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

IPAMScope

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'IpamId': (<class 'str'>, True), 'Tags':(<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::EC2::IPAMScope'

class troposphere.ec2.IamInstanceProfile(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

IamInstanceProfile

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Arn':(<class 'str'>, False), 'Name': (<class 'str'>, False)}

274 Chapter 7. Licensing

Page 279: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.ec2.IamInstanceProfileSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

IamInstanceProfileSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Arn':(<class 'str'>, False)}

class troposphere.ec2.Ingress(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Ingress

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CidrIp': (<class 'str'>, False), 'CidrIpv6': (<class 'str'>, False),'Description': (<class 'str'>, False), 'FromPort': (<function integer>, False),'IpProtocol': (<class 'str'>, True), 'SourcePrefixListId': (<class 'str'>, False),'SourceSecurityGroupId': (<class 'str'>, False), 'SourceSecurityGroupName':(<class 'str'>, False), 'SourceSecurityGroupOwnerId': (<class 'str'>, False),'ToPort': (<function integer>, False)}

class troposphere.ec2.Instance(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Instance

7.3. troposphere 275

Page 280: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AdditionalInfo': (<class 'str'>, False), 'Affinity': (<class 'str'>, False),'AvailabilityZone': (<class 'str'>, False), 'BlockDeviceMappings': ([<class'troposphere.ec2.BlockDeviceMapping'>], False), 'CpuOptions': (<class'troposphere.ec2.CpuOptions'>, False), 'CreditSpecification': (<class'troposphere.ec2.CreditSpecification'>, False), 'DisableApiTermination': (<functionboolean>, False), 'EbsOptimized': (<function boolean>, False),'ElasticGpuSpecifications': ([<class 'troposphere.ec2.ElasticGpuSpecification'>],False), 'ElasticInferenceAccelerators': ([<class'troposphere.ec2.ElasticInferenceAccelerator'>], False), 'EnclaveOptions': (<class'troposphere.ec2.EnclaveOptions'>, False), 'HibernationOptions': (<class'troposphere.ec2.HibernationOptions'>, False), 'HostId': (<class 'str'>, False),'HostResourceGroupArn': (<class 'str'>, False), 'IamInstanceProfile': (<class'str'>, False), 'ImageId': (<class 'str'>, False),'InstanceInitiatedShutdownBehavior': (<class 'str'>, False), 'InstanceType':(<class 'str'>, False), 'Ipv6AddressCount': (<function integer>, False),'Ipv6Addresses': ([<class 'troposphere.ec2.InstanceIpv6Address'>], False),'KernelId': (<class 'str'>, False), 'KeyName': (<class 'str'>, False),'LaunchTemplate': (<class 'troposphere.ec2.LaunchTemplateSpecification'>, False),'LicenseSpecifications': ([<class 'troposphere.ec2.LicenseSpecification'>], False),'Monitoring': (<function boolean>, False), 'NetworkInterfaces': ([<class'troposphere.ec2.NetworkInterfaceProperty'>], False), 'PlacementGroupName': (<class'str'>, False), 'PrivateDnsNameOptions': (<class'troposphere.ec2.PrivateDnsNameOptions'>, False), 'PrivateIpAddress': (<class'str'>, False), 'PropagateTagsToVolumeOnCreation': (<function boolean>, False),'RamdiskId': (<class 'str'>, False), 'SecurityGroupIds': (<class 'list'>, False),'SecurityGroups': ([<class 'str'>], False), 'SourceDestCheck': (<functionboolean>, False), 'SsmAssociations': ([<class 'troposphere.ec2.SsmAssociations'>],False), 'SubnetId': (<class 'str'>, False), 'Tags': (<functionvalidate_tags_or_list>, False), 'Tenancy': (<class 'str'>, False), 'UserData':(<class 'str'>, False), 'Volumes': (<class 'list'>, False)}

resource_type: Optional[str] = 'AWS::EC2::Instance'

class troposphere.ec2.InstanceIpv6Address(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InstanceIpv6Address

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Ipv6Address': (<class 'str'>, True)}

class troposphere.ec2.InstanceMarketOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InstanceMarketOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MarketType': (<class 'str'>, False), 'SpotOptions': (<class'troposphere.ec2.SpotOptions'>, False)}

class troposphere.ec2.InstanceNetworkInterfaceSpecification(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

276 Chapter 7. Licensing

Page 281: Release 3.1

troposphere Documentation, Release 4.0.1

InstanceNetworkInterfaceSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssociatePublicIpAddress': (<function boolean>, False), 'DeleteOnTermination':(<function boolean>, False), 'Description': (<class 'str'>, False), 'DeviceIndex':(<function integer>, False), 'Groups': ([<class 'str'>], False),'Ipv6AddressCount': (<function integer>, False), 'Ipv6Addresses': ([<class'troposphere.ec2.InstanceIpv6Address'>], False), 'NetworkInterfaceId': (<class'str'>, False), 'PrivateIpAddresses': ([<class'troposphere.ec2.PrivateIpAddressSpecification'>], False),'SecondaryPrivateIpAddressCount': (<function integer>, False), 'SubnetId': (<class'str'>, False)}

class troposphere.ec2.InstanceRequirements(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InstanceRequirements

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AcceleratorCount': (<class 'troposphere.ec2.AcceleratorCount'>, False),'AcceleratorManufacturers': ([<class 'str'>], False), 'AcceleratorNames': ([<class'str'>], False), 'AcceleratorTotalMemoryMiB': (<class'troposphere.ec2.AcceleratorTotalMemoryMiB'>, False), 'AcceleratorTypes': ([<class'str'>], False), 'BareMetal': (<class 'str'>, False), 'BaselineEbsBandwidthMbps':(<class 'troposphere.ec2.BaselineEbsBandwidthMbps'>, False), 'BurstablePerformance':(<class 'str'>, False), 'CpuManufacturers': ([<class 'str'>], False),'ExcludedInstanceTypes': ([<class 'str'>], False), 'InstanceGenerations': ([<class'str'>], False), 'LocalStorage': (<class 'str'>, False), 'LocalStorageTypes':([<class 'str'>], False), 'MemoryGiBPerVCpu': (<class'troposphere.ec2.MemoryGiBPerVCpu'>, False), 'MemoryMiB': (<class'troposphere.ec2.MemoryMiB'>, False), 'NetworkInterfaceCount': (<class'troposphere.ec2.NetworkInterfaceCount'>, False),'OnDemandMaxPricePercentageOverLowestPrice': (<function integer>, False),'RequireHibernateSupport': (<function boolean>, False),'SpotMaxPricePercentageOverLowestPrice': (<function integer>, False),'TotalLocalStorageGB': (<class 'troposphere.ec2.TotalLocalStorageGB'>, False),'VCpuCount': (<class 'troposphere.ec2.VCpuCount'>, False)}

class troposphere.ec2.InstanceRequirementsRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InstanceRequirementsRequest

7.3. troposphere 277

Page 282: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AcceleratorCount': (<class 'troposphere.ec2.AcceleratorCountRequest'>, False),'AcceleratorManufacturers': ([<class 'str'>], False), 'AcceleratorNames': ([<class'str'>], False), 'AcceleratorTotalMemoryMiB': (<class'troposphere.ec2.AcceleratorTotalMemoryMiBRequest'>, False), 'AcceleratorTypes':([<class 'str'>], False), 'BareMetal': (<class 'str'>, False),'BaselineEbsBandwidthMbps': (<class'troposphere.ec2.BaselineEbsBandwidthMbpsRequest'>, False), 'BurstablePerformance':(<class 'str'>, False), 'CpuManufacturers': ([<class 'str'>], False),'ExcludedInstanceTypes': ([<class 'str'>], False), 'InstanceGenerations': ([<class'str'>], False), 'LocalStorage': (<class 'str'>, False), 'LocalStorageTypes':([<class 'str'>], False), 'MemoryGiBPerVCpu': (<class'troposphere.ec2.MemoryGiBPerVCpuRequest'>, False), 'MemoryMiB': (<class'troposphere.ec2.MemoryMiBRequest'>, False), 'NetworkInterfaceCount': (<class'troposphere.ec2.NetworkInterfaceCountRequest'>, False),'OnDemandMaxPricePercentageOverLowestPrice': (<function integer>, False),'RequireHibernateSupport': (<function boolean>, False),'SpotMaxPricePercentageOverLowestPrice': (<function integer>, False),'TotalLocalStorageGB': (<class 'troposphere.ec2.TotalLocalStorageGBRequest'>,False), 'VCpuCount': (<class 'troposphere.ec2.VCpuCountRangeRequest'>, False)}

class troposphere.ec2.InstanceTypeSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InstanceTypeSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AvailabilityZone': (<class 'str'>, False), 'AvailabilityZoneId': (<class 'str'>,False), 'EbsOptimized': (<function boolean>, False), 'InstancePlatform': (<class'str'>, False), 'InstanceType': (<class 'str'>, False), 'Priority': (<functioninteger>, False), 'Weight': (<function double>, False)}

class troposphere.ec2.InternetGateway(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

InternetGateway

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Tags': (<function validate_tags_or_list>, False)}

resource_type: Optional[str] = 'AWS::EC2::InternetGateway'

class troposphere.ec2.IpamOperatingRegion(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

IpamOperatingRegion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RegionName': (<class 'str'>, True)}

class troposphere.ec2.Ipv4PrefixSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Ipv4PrefixSpecification

278 Chapter 7. Licensing

Page 283: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Ipv4Prefix': (<class 'str'>, False)}

class troposphere.ec2.Ipv6Add(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Ipv6Add

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Ipv6Address': (<class 'str'>, False)}

class troposphere.ec2.Ipv6PrefixSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Ipv6PrefixSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Ipv6Prefix': (<class 'str'>, False)}

class troposphere.ec2.LaunchSpecifications(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LaunchSpecifications

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BlockDeviceMappings': ([<class 'troposphere.ec2.BlockDeviceMapping'>], False),'EbsOptimized': (<function boolean>, False), 'IamInstanceProfile': (<class'troposphere.ec2.IamInstanceProfileSpecification'>, False), 'ImageId': (<class'str'>, True), 'InstanceRequirements': (<class'troposphere.ec2.InstanceRequirementsRequest'>, False), 'InstanceType': (<class'str'>, False), 'KernelId': (<class 'str'>, False), 'KeyName': (<class 'str'>,False), 'Monitoring': (<class 'troposphere.ec2.Monitoring'>, False),'NetworkInterfaces': ([<class'troposphere.ec2.InstanceNetworkInterfaceSpecification'>], False), 'Placement':(<class 'troposphere.ec2.SpotPlacement'>, False), 'RamdiskId': (<class 'str'>,False), 'SecurityGroups': ([<class 'troposphere.ec2.SecurityGroups'>], False),'SpotPrice': (<class 'str'>, False), 'SubnetId': (<class 'str'>, False),'TagSpecifications': ([<class 'troposphere.ec2.SpotFleetTagSpecification'>],False), 'UserData': (<class 'str'>, False), 'WeightedCapacity': (<functiondouble>, False)}

class troposphere.ec2.LaunchTemplate(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

LaunchTemplate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LaunchTemplateData': (<class 'troposphere.ec2.LaunchTemplateData'>, False),'LaunchTemplateName': (<class 'str'>, False), 'TagSpecifications': ([<class'troposphere.ec2.TagSpecifications'>], False)}

resource_type: Optional[str] = 'AWS::EC2::LaunchTemplate'

class troposphere.ec2.LaunchTemplateBlockDeviceMapping(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 279

Page 284: Release 3.1

troposphere Documentation, Release 4.0.1

LaunchTemplateBlockDeviceMapping

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeviceName': (<class 'str'>, False), 'Ebs': (<class'troposphere.ec2.EBSBlockDevice'>, False), 'NoDevice': (<class 'str'>, False),'VirtualName': (<class 'str'>, False)}

class troposphere.ec2.LaunchTemplateConfigs(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LaunchTemplateConfigs

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LaunchTemplateSpecification': (<class'troposphere.ec2.FleetLaunchTemplateSpecification'>, False), 'Overrides': ([<class'troposphere.ec2.LaunchTemplateOverrides'>], False)}

class troposphere.ec2.LaunchTemplateCreditSpecification(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

LaunchTemplateCreditSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CpuCredits': (<class 'str'>, False)}

class troposphere.ec2.LaunchTemplateData(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LaunchTemplateData

280 Chapter 7. Licensing

Page 285: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BlockDeviceMappings': ([<class'troposphere.ec2.LaunchTemplateBlockDeviceMapping'>], False),'CapacityReservationSpecification': (<class'troposphere.ec2.CapacityReservationSpecification'>, False), 'CpuOptions': (<class'troposphere.ec2.CpuOptions'>, False), 'CreditSpecification': (<class'troposphere.ec2.LaunchTemplateCreditSpecification'>, False),'DisableApiTermination': (<function boolean>, False), 'EbsOptimized': (<functionboolean>, False), 'ElasticGpuSpecifications': ([<class'troposphere.ec2.ElasticGpuSpecification'>], False), 'ElasticInferenceAccelerators':([<class 'troposphere.ec2.LaunchTemplateElasticInferenceAccelerator'>], False),'EnclaveOptions': (<class 'troposphere.ec2.EnclaveOptions'>, False),'HibernationOptions': (<class 'troposphere.ec2.HibernationOptions'>, False),'IamInstanceProfile': (<class 'troposphere.ec2.IamInstanceProfile'>, False),'ImageId': (<class 'str'>, False), 'InstanceInitiatedShutdownBehavior': (<class'str'>, False), 'InstanceMarketOptions': (<class'troposphere.ec2.InstanceMarketOptions'>, False), 'InstanceRequirements': (<class'troposphere.ec2.InstanceRequirements'>, False), 'InstanceType': (<class 'str'>,False), 'KernelId': (<class 'str'>, False), 'KeyName': (<class 'str'>, False),'LicenseSpecifications': ([<class 'troposphere.ec2.LicenseSpecification'>], False),'MaintenanceOptions': (<class 'troposphere.ec2.MaintenanceOptions'>, False),'MetadataOptions': (<class 'troposphere.ec2.MetadataOptions'>, False),'Monitoring': (<class 'troposphere.ec2.Monitoring'>, False), 'NetworkInterfaces':([<class 'troposphere.ec2.NetworkInterfaces'>], False), 'Placement': (<class'troposphere.ec2.Placement'>, False), 'PrivateDnsNameOptions': (<class'troposphere.ec2.PrivateDnsNameOptions'>, False), 'RamDiskId': (<class 'str'>,False), 'SecurityGroupIds': ([<class 'str'>], False), 'SecurityGroups': ([<class'str'>], False), 'TagSpecifications': ([<class'troposphere.ec2.TagSpecifications'>], False), 'UserData': (<class 'str'>, False)}

class troposphere.ec2.LaunchTemplateElasticInferenceAccelerator(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

LaunchTemplateElasticInferenceAccelerator

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Count': (<function integer>, False), 'Type': (<functionvalidate_elasticinferenceaccelerator_type>, False)}

class troposphere.ec2.LaunchTemplateOverrides(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LaunchTemplateOverrides

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AvailabilityZone': (<class 'str'>, False), 'InstanceRequirements': (<class'troposphere.ec2.InstanceRequirementsRequest'>, False), 'InstanceType': (<class'str'>, False), 'Priority': (<function double>, False), 'SpotPrice': (<class'str'>, False), 'SubnetId': (<class 'str'>, False), 'WeightedCapacity': (<functiondouble>, False)}

class troposphere.ec2.LaunchTemplateSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 281

Page 286: Release 3.1

troposphere Documentation, Release 4.0.1

LaunchTemplateSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LaunchTemplateId': (<class 'str'>, False), 'LaunchTemplateName': (<class 'str'>,False), 'Version': (<class 'str'>, True)}

class troposphere.ec2.LicenseSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LicenseSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LicenseConfigurationArn': (<class 'str'>, False)}

class troposphere.ec2.LoadBalancersConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LoadBalancersConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClassicLoadBalancersConfig': (<class'troposphere.ec2.ClassicLoadBalancersConfig'>, False), 'TargetGroupsConfig':(<class 'troposphere.ec2.TargetGroupConfig'>, False)}

class troposphere.ec2.LocalGatewayRoute(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

LocalGatewayRoute

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DestinationCidrBlock': (<class 'str'>, True), 'LocalGatewayRouteTableId':(<class 'str'>, True), 'LocalGatewayVirtualInterfaceGroupId': (<class 'str'>,True)}

resource_type: Optional[str] = 'AWS::EC2::LocalGatewayRoute'

class troposphere.ec2.LocalGatewayRouteTableVPCAssociation(title: Optional[str], template:Optional[troposphere.Template] =None, validation: bool = True,**kwargs: Any)

Bases: troposphere.AWSObject

LocalGatewayRouteTableVPCAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LocalGatewayRouteTableId': (<class 'str'>, True), 'Tags': (<functionvalidate_tags_or_list>, False), 'VpcId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::LocalGatewayRouteTableVPCAssociation'

class troposphere.ec2.MaintenanceOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MaintenanceOptions

282 Chapter 7. Licensing

Page 287: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoRecovery': (<class 'str'>, False)}

class troposphere.ec2.MaintenanceStrategies(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MaintenanceStrategies

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CapacityRebalance': (<class 'troposphere.ec2.CapacityRebalance'>, False)}

class troposphere.ec2.MemoryGiBPerVCpu(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MemoryGiBPerVCpu

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function double>, False), 'Min': (<function double>, False)}

class troposphere.ec2.MemoryGiBPerVCpuRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MemoryGiBPerVCpuRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function double>, False), 'Min': (<function double>, False)}

class troposphere.ec2.MemoryMiB(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MemoryMiB

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.ec2.MemoryMiBRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MemoryMiBRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.ec2.MetadataOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MetadataOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HttpEndpoint': (<class 'str'>, False), 'HttpProtocolIpv6': (<class 'str'>,False), 'HttpPutResponseHopLimit': (<function integer>, False), 'HttpTokens':(<class 'str'>, False), 'InstanceMetadataTags': (<class 'str'>, False)}

class troposphere.ec2.Monitoring(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 283

Page 288: Release 3.1

troposphere Documentation, Release 4.0.1

Monitoring

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False)}

class troposphere.ec2.MountPoint(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MountPoint

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Device': (<class 'str'>, True), 'VolumeId': (<class 'str'>, True)}

class troposphere.ec2.NatGateway(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

NatGateway

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllocationId': (<class 'str'>, False), 'ConnectivityType': (<class 'str'>,False), 'SubnetId': (<class 'str'>, True), 'Tags': (<functionvalidate_tags_or_list>, False)}

resource_type: Optional[str] = 'AWS::EC2::NatGateway'

class troposphere.ec2.NetworkAcl(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

NetworkAcl

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Tags': (<function validate_tags_or_list>, False), 'VpcId': (<class 'str'>,True)}

resource_type: Optional[str] = 'AWS::EC2::NetworkAcl'

class troposphere.ec2.NetworkAclEntry(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

NetworkAclEntry

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CidrBlock': (<class 'str'>, False), 'Egress': (<function boolean>, False),'Icmp': (<class 'troposphere.ec2.ICMP'>, False), 'Ipv6CidrBlock': (<class 'str'>,False), 'NetworkAclId': (<class 'str'>, True), 'PortRange': (<class'troposphere.ec2.PortRange'>, False), 'Protocol': (<functionvalidate_network_port>, True), 'RuleAction': (<class 'str'>, True), 'RuleNumber':(<function validate_networkaclentry_rulenumber>, True)}

resource_type: Optional[str] = 'AWS::EC2::NetworkAclEntry'

validate()

284 Chapter 7. Licensing

Page 289: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.ec2.NetworkInsightsAccessScope(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

NetworkInsightsAccessScope

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ExcludePaths': ([<class 'troposphere.ec2.AccessScopePathRequest'>], False),'MatchPaths': ([<class 'troposphere.ec2.AccessScopePathRequest'>], False), 'Tags':(<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::EC2::NetworkInsightsAccessScope'

class troposphere.ec2.NetworkInsightsAccessScopeAnalysis(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

NetworkInsightsAccessScopeAnalysis

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'NetworkInsightsAccessScopeId': (<class 'str'>, True), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::EC2::NetworkInsightsAccessScopeAnalysis'

class troposphere.ec2.NetworkInsightsAnalysis(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

NetworkInsightsAnalysis

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FilterInArns': ([<class 'str'>], False), 'NetworkInsightsPathId': (<class'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::EC2::NetworkInsightsAnalysis'

class troposphere.ec2.NetworkInsightsPath(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

NetworkInsightsPath

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Destination': (<class 'str'>, True), 'DestinationIp': (<class 'str'>, False),'DestinationPort': (<function integer>, False), 'Protocol': (<class 'str'>, True),'Source': (<class 'str'>, True), 'SourceIp': (<class 'str'>, False), 'Tags':(<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::EC2::NetworkInsightsPath'

class troposphere.ec2.NetworkInterface(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

7.3. troposphere 285

Page 290: Release 3.1

troposphere Documentation, Release 4.0.1

NetworkInterface

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'GroupSet': ([<class 'str'>], False),'InterfaceType': (<class 'str'>, False), 'Ipv6AddressCount': (<function integer>,False), 'Ipv6Addresses': ([<class 'troposphere.ec2.InstanceIpv6Address'>], False),'PrivateIpAddress': (<class 'str'>, False), 'PrivateIpAddresses': ([<class'troposphere.ec2.PrivateIpAddressSpecification'>], False),'SecondaryPrivateIpAddressCount': (<function integer>, False), 'SourceDestCheck':(<function boolean>, False), 'SubnetId': (<class 'str'>, True), 'Tags': (<functionvalidate_tags_or_list>, False)}

resource_type: Optional[str] = 'AWS::EC2::NetworkInterface'

class troposphere.ec2.NetworkInterfaceAttachment(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

NetworkInterfaceAttachment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeleteOnTermination': (<function boolean>, False), 'DeviceIndex': (<functionvalidate_int_to_str>, True), 'InstanceId': (<class 'str'>, True),'NetworkInterfaceId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::NetworkInterfaceAttachment'

class troposphere.ec2.NetworkInterfaceCount(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NetworkInterfaceCount

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.ec2.NetworkInterfaceCountRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NetworkInterfaceCountRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.ec2.NetworkInterfacePermission(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

NetworkInterfacePermission

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AwsAccountId': (<class 'str'>, True), 'NetworkInterfaceId': (<class 'str'>,True), 'Permission': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::NetworkInterfacePermission'

286 Chapter 7. Licensing

Page 291: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.ec2.NetworkInterfaceProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NetworkInterfaceProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssociatePublicIpAddress': (<function boolean>, False), 'DeleteOnTermination':(<function boolean>, False), 'Description': (<class 'str'>, False), 'DeviceIndex':(<function validate_int_to_str>, True), 'GroupSet': ([<class 'str'>], False),'Ipv6AddressCount': (<function integer>, False), 'Ipv6Addresses': ([<class'troposphere.ec2.InstanceIpv6Address'>], False), 'NetworkInterfaceId': (<class'str'>, False), 'PrivateIpAddress': (<class 'str'>, False), 'PrivateIpAddresses':([<class 'troposphere.ec2.PrivateIpAddressSpecification'>], False),'SecondaryPrivateIpAddressCount': (<function integer>, False), 'SubnetId': (<class'str'>, False)}

class troposphere.ec2.NetworkInterfaces(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NetworkInterfaces

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssociateCarrierIpAddress': (<function boolean>, False),'AssociatePublicIpAddress': (<function boolean>, False), 'DeleteOnTermination':(<function boolean>, False), 'Description': (<class 'str'>, False), 'DeviceIndex':(<function integer>, False), 'Groups': ([<class 'str'>], False), 'InterfaceType':(<class 'str'>, False), 'Ipv4PrefixCount': (<function integer>, False),'Ipv4Prefixes': ([<class 'troposphere.ec2.Ipv4PrefixSpecification'>], False),'Ipv6AddressCount': (<function integer>, False), 'Ipv6Addresses': ([<class'troposphere.ec2.Ipv6Add'>], False), 'Ipv6PrefixCount': (<function integer>,False), 'Ipv6Prefixes': ([<class 'troposphere.ec2.Ipv6PrefixSpecification'>],False), 'NetworkCardIndex': (<function integer>, False), 'NetworkInterfaceId':(<class 'str'>, False), 'PrivateIpAddress': (<class 'str'>, False),'PrivateIpAddresses': ([<class 'troposphere.ec2.PrivateIpAddressSpecification'>],False), 'SecondaryPrivateIpAddressCount': (<function integer>, False), 'SubnetId':(<class 'str'>, False)}

class troposphere.ec2.NoDevice(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NoDevice

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {}

class troposphere.ec2.OnDemandOptionsRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OnDemandOptionsRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllocationStrategy': (<class 'str'>, False), 'CapacityReservationOptions':(<class 'troposphere.ec2.CapacityReservationOptionsRequest'>, False),'MaxTotalPrice': (<class 'str'>, False), 'MinTargetCapacity': (<function integer>,False), 'SingleAvailabilityZone': (<function boolean>, False),'SingleInstanceType': (<function boolean>, False)}

7.3. troposphere 287

Page 292: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.ec2.PacketHeaderStatementRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PacketHeaderStatementRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DestinationAddresses': ([<class 'str'>], False), 'DestinationPorts': ([<class'str'>], False), 'DestinationPrefixLists': ([<class 'str'>], False), 'Protocols':([<class 'str'>], False), 'SourceAddresses': ([<class 'str'>], False),'SourcePorts': ([<class 'str'>], False), 'SourcePrefixLists': ([<class 'str'>],False)}

class troposphere.ec2.PathStatementRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PathStatementRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PacketHeaderStatement': (<class 'troposphere.ec2.PacketHeaderStatementRequest'>,False), 'ResourceStatement': (<class 'troposphere.ec2.ResourceStatementRequest'>,False)}

class troposphere.ec2.Placement(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Placement

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Affinity': (<class 'str'>, False), 'AvailabilityZone': (<class 'str'>, False),'GroupName': (<class 'str'>, False), 'HostId': (<class 'str'>, False),'HostResourceGroupArn': (<class 'str'>, False), 'PartitionNumber': (<functioninteger>, False), 'SpreadDomain': (<class 'str'>, False), 'Tenancy': (<class'str'>, False)}

class troposphere.ec2.PlacementGroup(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

PlacementGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Strategy': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::EC2::PlacementGroup'

class troposphere.ec2.PortRange(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PortRange

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'From': (<function validate_network_port>, False), 'To': (<functionvalidate_network_port>, False)}

class troposphere.ec2.PrefixList(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

288 Chapter 7. Licensing

Page 293: Release 3.1

troposphere Documentation, Release 4.0.1

PrefixList

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AddressFamily': (<class 'str'>, True), 'Entries': ([<class'troposphere.ec2.Entry'>], False), 'MaxEntries': (<function integer>, True),'PrefixListName': (<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>,False)}

resource_type: Optional[str] = 'AWS::EC2::PrefixList'

class troposphere.ec2.PrivateDnsNameOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PrivateDnsNameOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EnableResourceNameDnsAAAARecord': (<function boolean>, False),'EnableResourceNameDnsARecord': (<function boolean>, False), 'HostnameType':(<class 'str'>, False)}

class troposphere.ec2.PrivateIpAddressSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PrivateIpAddressSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Primary': (<function boolean>, False), 'PrivateIpAddress': (<class 'str'>,True)}

class troposphere.ec2.ProvisionedCidr(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ProvisionedCidr

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Cidr': (<class 'str'>, True)}

class troposphere.ec2.ResourceStatementRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ResourceStatementRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ResourceTypes': ([<class 'str'>], False), 'Resources': ([<class 'str'>], False)}

class troposphere.ec2.Route(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Route

7.3. troposphere 289

Page 294: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CarrierGatewayId': (<class 'str'>, False), 'DestinationCidrBlock': (<class'str'>, False), 'DestinationIpv6CidrBlock': (<class 'str'>, False),'EgressOnlyInternetGatewayId': (<class 'str'>, False), 'GatewayId': (<class'str'>, False), 'InstanceId': (<class 'str'>, False), 'LocalGatewayId': (<class'str'>, False), 'NatGatewayId': (<class 'str'>, False), 'NetworkInterfaceId':(<class 'str'>, False), 'RouteTableId': (<class 'str'>, True), 'TransitGatewayId':(<class 'str'>, False), 'VpcEndpointId': (<class 'str'>, False),'VpcPeeringConnectionId': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::EC2::Route'

validate()

class troposphere.ec2.RouteTable(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

RouteTable

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Tags': (<function validate_tags_or_list>, False), 'VpcId': (<class 'str'>,True)}

resource_type: Optional[str] = 'AWS::EC2::RouteTable'

class troposphere.ec2.SecurityGroup(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

SecurityGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GroupDescription': (<class 'str'>, True), 'GroupName': (<class 'str'>, False),'SecurityGroupEgress': (<class 'list'>, False), 'SecurityGroupIngress': (<class'list'>, False), 'Tags': (<function validate_tags_or_list>, False), 'VpcId':(<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::EC2::SecurityGroup'

class troposphere.ec2.SecurityGroupEgress(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

SecurityGroupEgress

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CidrIp': (<class 'str'>, False), 'CidrIpv6': (<class 'str'>, False),'Description': (<class 'str'>, False), 'DestinationPrefixListId': (<class 'str'>,False), 'DestinationSecurityGroupId': (<class 'str'>, False), 'FromPort':(<function validate_network_port>, False), 'GroupId': (<class 'str'>, True),'IpProtocol': (<class 'str'>, True), 'ToPort': (<function validate_network_port>,False)}

resource_type: Optional[str] = 'AWS::EC2::SecurityGroupEgress'

290 Chapter 7. Licensing

Page 295: Release 3.1

troposphere Documentation, Release 4.0.1

validate()

class troposphere.ec2.SecurityGroupIngress(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

SecurityGroupIngress

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CidrIp': (<class 'str'>, False), 'CidrIpv6': (<class 'str'>, False),'Description': (<class 'str'>, False), 'FromPort': (<functionvalidate_network_port>, False), 'GroupId': (<class 'str'>, False), 'GroupName':(<class 'str'>, False), 'IpProtocol': (<class 'str'>, True), 'SourcePrefixListId':(<class 'str'>, False), 'SourceSecurityGroupId': (<class 'str'>, False),'SourceSecurityGroupName': (<class 'str'>, False), 'SourceSecurityGroupOwnerId':(<class 'str'>, False), 'ToPort': (<function validate_network_port>, False)}

resource_type: Optional[str] = 'AWS::EC2::SecurityGroupIngress'

validate()

class troposphere.ec2.SecurityGroupRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SecurityGroupRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CidrIp': (<class 'str'>, False), 'CidrIpv6': (<class 'str'>, False),'Description': (<class 'str'>, False), 'DestinationPrefixListId': (<class 'str'>,False), 'DestinationSecurityGroupId': (<class 'str'>, False), 'FromPort':(<function validate_network_port>, False), 'IpProtocol': (<class 'str'>, True),'SourcePrefixListId': (<class 'str'>, False), 'SourceSecurityGroupId': (<class'str'>, False), 'SourceSecurityGroupName': (<class 'str'>, False),'SourceSecurityGroupOwnerId': (<class 'str'>, False), 'ToPort': (<functionvalidate_network_port>, False)}

class troposphere.ec2.SecurityGroups(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SecurityGroups

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GroupId': (<class 'str'>, True)}

class troposphere.ec2.SpotCapacityRebalance(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SpotCapacityRebalance

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ReplacementStrategy': (<class 'str'>, False), 'TerminationDelay': (<functioninteger>, False)}

class troposphere.ec2.SpotFleet(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

7.3. troposphere 291

Page 296: Release 3.1

troposphere Documentation, Release 4.0.1

SpotFleet

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SpotFleetRequestConfigData': (<class'troposphere.ec2.SpotFleetRequestConfigData'>, True)}

resource_type: Optional[str] = 'AWS::EC2::SpotFleet'

class troposphere.ec2.SpotFleetRequestConfigData(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SpotFleetRequestConfigData

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllocationStrategy': (<class 'str'>, False), 'Context': (<class 'str'>, False),'ExcessCapacityTerminationPolicy': (<class 'str'>, False), 'IamFleetRole': (<class'str'>, True), 'InstanceInterruptionBehavior': (<class 'str'>, False),'InstancePoolsToUseCount': (<function integer>, False), 'LaunchSpecifications':([<class 'troposphere.ec2.LaunchSpecifications'>], False), 'LaunchTemplateConfigs':([<class 'troposphere.ec2.LaunchTemplateConfigs'>], False), 'LoadBalancersConfig':(<class 'troposphere.ec2.LoadBalancersConfig'>, False),'OnDemandAllocationStrategy': (<class 'str'>, False), 'OnDemandMaxTotalPrice':(<class 'str'>, False), 'OnDemandTargetCapacity': (<function integer>, False),'ReplaceUnhealthyInstances': (<function boolean>, False),'SpotMaintenanceStrategies': (<class 'troposphere.ec2.SpotMaintenanceStrategies'>,False), 'SpotMaxTotalPrice': (<class 'str'>, False), 'SpotPrice': (<class 'str'>,False), 'TargetCapacity': (<function integer>, True), 'TargetCapacityUnitType':(<class 'str'>, False), 'TerminateInstancesWithExpiration': (<function boolean>,False), 'Type': (<class 'str'>, False), 'ValidFrom': (<class 'str'>, False),'ValidUntil': (<class 'str'>, False)}

validate()

class troposphere.ec2.SpotFleetTagSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SpotFleetTagSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ResourceType': (<class 'str'>, False), 'Tags': (<functionvalidate_tags_or_list>, False)}

class troposphere.ec2.SpotMaintenanceStrategies(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SpotMaintenanceStrategies

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CapacityRebalance': (<class 'troposphere.ec2.SpotCapacityRebalance'>, False)}

class troposphere.ec2.SpotOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SpotOptions

292 Chapter 7. Licensing

Page 297: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BlockDurationMinutes': (<function integer>, False),'InstanceInterruptionBehavior': (<class 'str'>, False), 'MaxPrice': (<class'str'>, False), 'SpotInstanceType': (<class 'str'>, False), 'ValidUntil': (<class'str'>, False)}

class troposphere.ec2.SpotOptionsRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SpotOptionsRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllocationStrategy': (<class 'str'>, False), 'InstanceInterruptionBehavior':(<class 'str'>, False), 'InstancePoolsToUseCount': (<function integer>, False),'MaintenanceStrategies': (<class 'troposphere.ec2.MaintenanceStrategies'>, False),'MaxTotalPrice': (<class 'str'>, False), 'MinTargetCapacity': (<function integer>,False), 'SingleAvailabilityZone': (<function boolean>, False),'SingleInstanceType': (<function boolean>, False)}

class troposphere.ec2.SpotPlacement(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SpotPlacement

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AvailabilityZone': (<class 'str'>, False), 'GroupName': (<class 'str'>, False),'Tenancy': (<class 'str'>, False)}

class troposphere.ec2.SsmAssociations(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SsmAssociations

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssociationParameters': ([<class 'troposphere.ec2.AssociationParameters'>],False), 'DocumentName': (<class 'str'>, True)}

class troposphere.ec2.Subnet(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Subnet

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssignIpv6AddressOnCreation': (<function boolean>, False), 'AvailabilityZone':(<class 'str'>, False), 'AvailabilityZoneId': (<class 'str'>, False), 'CidrBlock':(<class 'str'>, False), 'EnableDns64': (<function boolean>, False),'Ipv6CidrBlock': (<class 'str'>, False), 'Ipv6Native': (<function boolean>,False), 'MapPublicIpOnLaunch': (<function boolean>, False), 'OutpostArn': (<class'str'>, False), 'PrivateDnsNameOptionsOnLaunch': (<class 'dict'>, False), 'Tags':(<function validate_tags_or_list>, False), 'VpcId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::Subnet'

validate()

7.3. troposphere 293

Page 298: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.ec2.SubnetCidrBlock(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

SubnetCidrBlock

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Ipv6CidrBlock': (<class 'str'>, True), 'SubnetId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::SubnetCidrBlock'

class troposphere.ec2.SubnetNetworkAclAssociation(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

SubnetNetworkAclAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'NetworkAclId': (<class 'str'>, True), 'SubnetId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::SubnetNetworkAclAssociation'

class troposphere.ec2.SubnetRouteTableAssociation(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

SubnetRouteTableAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RouteTableId': (<class 'str'>, True), 'SubnetId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::SubnetRouteTableAssociation'

class troposphere.ec2.TagSpecifications(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TagSpecifications

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ResourceType': (<class 'str'>, False), 'Tags': (<functionvalidate_tags_or_list>, False)}

class troposphere.ec2.TargetCapacitySpecificationRequest(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

TargetCapacitySpecificationRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DefaultTargetCapacityType': (<class 'str'>, False), 'OnDemandTargetCapacity':(<function integer>, False), 'SpotTargetCapacity': (<function integer>, False),'TargetCapacityUnitType': (<class 'str'>, False), 'TotalTargetCapacity':(<function integer>, True)}

class troposphere.ec2.TargetGroup(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

294 Chapter 7. Licensing

Page 299: Release 3.1

troposphere Documentation, Release 4.0.1

TargetGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Arn':(<class 'str'>, True)}

class troposphere.ec2.TargetGroupConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TargetGroupConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TargetGroups': ([<class 'troposphere.ec2.TargetGroup'>], True)}

class troposphere.ec2.ThroughResourcesStatementRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ThroughResourcesStatementRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ResourceStatement': (<class 'troposphere.ec2.ResourceStatementRequest'>, False)}

class troposphere.ec2.TotalLocalStorageGB(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TotalLocalStorageGB

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function double>, False), 'Min': (<function double>, False)}

class troposphere.ec2.TotalLocalStorageGBRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TotalLocalStorageGBRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function double>, False), 'Min': (<function double>, False)}

class troposphere.ec2.TrafficMirrorFilter(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

TrafficMirrorFilter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'NetworkServices': ([<class 'str'>],False), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::EC2::TrafficMirrorFilter'

class troposphere.ec2.TrafficMirrorFilterRule(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

TrafficMirrorFilterRule

7.3. troposphere 295

Page 300: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'DestinationCidrBlock': (<class 'str'>,True), 'DestinationPortRange': (<class 'troposphere.ec2.TrafficMirrorPortRange'>,False), 'Protocol': (<function integer>, False), 'RuleAction': (<class 'str'>,True), 'RuleNumber': (<function integer>, True), 'SourceCidrBlock': (<class'str'>, True), 'SourcePortRange': (<class'troposphere.ec2.TrafficMirrorPortRange'>, False), 'TrafficDirection': (<class'str'>, True), 'TrafficMirrorFilterId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::TrafficMirrorFilterRule'

class troposphere.ec2.TrafficMirrorPortRange(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TrafficMirrorPortRange

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FromPort': (<function integer>, True), 'ToPort': (<function integer>, True)}

class troposphere.ec2.TrafficMirrorSession(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

TrafficMirrorSession

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'NetworkInterfaceId': (<class 'str'>,True), 'PacketLength': (<function integer>, False), 'SessionNumber': (<functioninteger>, True), 'Tags': (<class 'troposphere.Tags'>, False),'TrafficMirrorFilterId': (<class 'str'>, True), 'TrafficMirrorTargetId': (<class'str'>, True), 'VirtualNetworkId': (<function integer>, False)}

resource_type: Optional[str] = 'AWS::EC2::TrafficMirrorSession'

class troposphere.ec2.TrafficMirrorTarget(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

TrafficMirrorTarget

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'NetworkInterfaceId': (<class 'str'>,False), 'NetworkLoadBalancerArn': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::EC2::TrafficMirrorTarget'

class troposphere.ec2.TransitGateway(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

TransitGateway

296 Chapter 7. Licensing

Page 301: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AmazonSideAsn': (<function integer>, False), 'AssociationDefaultRouteTableId':(<class 'str'>, False), 'AutoAcceptSharedAttachments': (<class 'str'>, False),'DefaultRouteTableAssociation': (<class 'str'>, False),'DefaultRouteTablePropagation': (<class 'str'>, False), 'Description': (<class'str'>, False), 'DnsSupport': (<class 'str'>, False), 'MulticastSupport': (<class'str'>, False), 'PropagationDefaultRouteTableId': (<class 'str'>, False), 'Tags':(<function validate_tags_or_list>, False), 'TransitGatewayCidrBlocks': ([<class'str'>], False), 'VpnEcmpSupport': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::EC2::TransitGateway'

class troposphere.ec2.TransitGatewayAttachment(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

TransitGatewayAttachment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SubnetIds': ([<class 'str'>], True), 'Tags': (<function validate_tags_or_list>,False), 'TransitGatewayId': (<class 'str'>, True), 'VpcId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::TransitGatewayAttachment'

class troposphere.ec2.TransitGatewayConnect(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

TransitGatewayConnect

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Options': (<class 'troposphere.ec2.TransitGatewayConnectOptions'>, True), 'Tags':(<class 'troposphere.Tags'>, False), 'TransportTransitGatewayAttachmentId': (<class'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::TransitGatewayConnect'

class troposphere.ec2.TransitGatewayConnectOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TransitGatewayConnectOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Protocol': (<class 'str'>, False)}

class troposphere.ec2.TransitGatewayMulticastDomain(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

TransitGatewayMulticastDomain

7.3. troposphere 297

Page 302: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Options': (<class 'dict'>, False), 'Tags': (<class 'troposphere.Tags'>, False),'TransitGatewayId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::TransitGatewayMulticastDomain'

class troposphere.ec2.TransitGatewayMulticastDomainAssociation(title: Optional[str], template:Optional[troposphere.Template] =None, validation: bool = True,**kwargs: Any)

Bases: troposphere.AWSObject

TransitGatewayMulticastDomainAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SubnetId': (<class 'str'>, True), 'TransitGatewayAttachmentId': (<class 'str'>,True), 'TransitGatewayMulticastDomainId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::TransitGatewayMulticastDomainAssociation'

class troposphere.ec2.TransitGatewayMulticastGroupMember(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

TransitGatewayMulticastGroupMember

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GroupIpAddress': (<class 'str'>, True), 'NetworkInterfaceId': (<class 'str'>,True), 'TransitGatewayMulticastDomainId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::TransitGatewayMulticastGroupMember'

class troposphere.ec2.TransitGatewayMulticastGroupSource(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

TransitGatewayMulticastGroupSource

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GroupIpAddress': (<class 'str'>, True), 'NetworkInterfaceId': (<class 'str'>,True), 'TransitGatewayMulticastDomainId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::TransitGatewayMulticastGroupSource'

class troposphere.ec2.TransitGatewayPeeringAttachment(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

TransitGatewayPeeringAttachment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PeerAccountId': (<class 'str'>, True), 'PeerRegion': (<class 'str'>, True),'PeerTransitGatewayId': (<class 'str'>, True), 'Tags': (<class'troposphere.Tags'>, False), 'TransitGatewayId': (<class 'str'>, True)}

298 Chapter 7. Licensing

Page 303: Release 3.1

troposphere Documentation, Release 4.0.1

resource_type: Optional[str] = 'AWS::EC2::TransitGatewayPeeringAttachment'

class troposphere.ec2.TransitGatewayRoute(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

TransitGatewayRoute

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Blackhole': (<function boolean>, False), 'DestinationCidrBlock': (<class 'str'>,False), 'TransitGatewayAttachmentId': (<class 'str'>, False),'TransitGatewayRouteTableId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::TransitGatewayRoute'

class troposphere.ec2.TransitGatewayRouteTable(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

TransitGatewayRouteTable

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Tags': (<function validate_tags_or_list>, False), 'TransitGatewayId': (<class'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::TransitGatewayRouteTable'

class troposphere.ec2.TransitGatewayRouteTableAssociation(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

TransitGatewayRouteTableAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TransitGatewayAttachmentId': (<class 'str'>, True), 'TransitGatewayRouteTableId':(<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::TransitGatewayRouteTableAssociation'

class troposphere.ec2.TransitGatewayRouteTablePropagation(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

TransitGatewayRouteTablePropagation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TransitGatewayAttachmentId': (<class 'str'>, True), 'TransitGatewayRouteTableId':(<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::TransitGatewayRouteTablePropagation'

7.3. troposphere 299

Page 304: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.ec2.TransitGatewayVpcAttachment(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

TransitGatewayVpcAttachment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AddSubnetIds': ([<class 'str'>], False), 'Options': (<class 'dict'>, False),'RemoveSubnetIds': ([<class 'str'>], False), 'SubnetIds': ([<class 'str'>], True),'Tags': (<class 'troposphere.Tags'>, False), 'TransitGatewayId': (<class 'str'>,True), 'VpcId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::TransitGatewayVpcAttachment'

class troposphere.ec2.VCpuCount(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VCpuCount

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.ec2.VCpuCountRangeRequest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VCpuCountRangeRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Max':(<function integer>, False), 'Min': (<function integer>, False)}

class troposphere.ec2.VPC(title: Optional[str], template: Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VPC

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CidrBlock': (<class 'str'>, True), 'EnableDnsHostnames': (<function boolean>,False), 'EnableDnsSupport': (<function boolean>, False), 'InstanceTenancy':(<function instance_tenancy>, False), 'Ipv4IpamPoolId': (<class 'str'>, False),'Ipv4NetmaskLength': (<function integer>, False), 'Tags': (<functionvalidate_tags_or_list>, False)}

resource_type: Optional[str] = 'AWS::EC2::VPC'

class troposphere.ec2.VPCCidrBlock(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VPCCidrBlock

300 Chapter 7. Licensing

Page 305: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AmazonProvidedIpv6CidrBlock': (<function boolean>, False), 'CidrBlock': (<class'str'>, False), 'Ipv4IpamPoolId': (<class 'str'>, False), 'Ipv4NetmaskLength':(<function integer>, False), 'Ipv6CidrBlock': (<class 'str'>, False),'Ipv6IpamPoolId': (<class 'str'>, False), 'Ipv6NetmaskLength': (<functioninteger>, False), 'Ipv6Pool': (<class 'str'>, False), 'VpcId': (<class 'str'>,True)}

resource_type: Optional[str] = 'AWS::EC2::VPCCidrBlock'

class troposphere.ec2.VPCDHCPOptionsAssociation(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VPCDHCPOptionsAssociation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DhcpOptionsId': (<class 'str'>, True), 'VpcId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::VPCDHCPOptionsAssociation'

class troposphere.ec2.VPCEndpoint(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VPCEndpoint

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PolicyDocument': (<function policytypes>, False), 'PrivateDnsEnabled':(<function boolean>, False), 'RouteTableIds': ([<class 'str'>], False),'SecurityGroupIds': ([<class 'str'>], False), 'ServiceName': (<class 'str'>,True), 'SubnetIds': ([<class 'str'>], False), 'VpcEndpointType': (<functionvpc_endpoint_type>, False), 'VpcId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::VPCEndpoint'

class troposphere.ec2.VPCEndpointConnectionNotification(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VPCEndpointConnectionNotification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectionEvents': ([<class 'str'>], True), 'ConnectionNotificationArn': (<class'str'>, True), 'ServiceId': (<class 'str'>, False), 'VPCEndpointId': (<class'str'>, False)}

resource_type: Optional[str] = 'AWS::EC2::VPCEndpointConnectionNotification'

class troposphere.ec2.VPCEndpointService(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VPCEndpointService

7.3. troposphere 301

Page 306: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AcceptanceRequired': (<function boolean>, False), 'GatewayLoadBalancerArns':([<class 'str'>], False), 'NetworkLoadBalancerArns': ([<class 'str'>], False),'PayerResponsibility': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::EC2::VPCEndpointService'

class troposphere.ec2.VPCEndpointServicePermissions(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VPCEndpointServicePermissions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllowedPrincipals': ([<class 'str'>], False), 'ServiceId': (<class 'str'>,True)}

resource_type: Optional[str] = 'AWS::EC2::VPCEndpointServicePermissions'

class troposphere.ec2.VPCGatewayAttachment(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

VPCGatewayAttachment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InternetGatewayId': (<class 'str'>, False), 'VpcId': (<class 'str'>, True),'VpnGatewayId': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::EC2::VPCGatewayAttachment'

class troposphere.ec2.VPCPeeringConnection(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

VPCPeeringConnection

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PeerOwnerId': (<class 'str'>, False), 'PeerRegion': (<class 'str'>, False),'PeerRoleArn': (<class 'str'>, False), 'PeerVpcId': (<class 'str'>, True), 'Tags':(<function validate_tags_or_list>, False), 'VpcId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::VPCPeeringConnection'

class troposphere.ec2.VPNConnection(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VPNConnection

302 Chapter 7. Licensing

Page 307: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CustomerGatewayId': (<class 'str'>, True), 'StaticRoutesOnly': (<functionboolean>, False), 'Tags': (<function validate_tags_or_list>, False),'TransitGatewayId': (<class 'str'>, False), 'Type': (<class 'str'>, True),'VpnGatewayId': (<class 'str'>, False), 'VpnTunnelOptionsSpecifications': ([<class'troposphere.ec2.VpnTunnelOptionsSpecification'>], False)}

resource_type: Optional[str] = 'AWS::EC2::VPNConnection'

validate()

class troposphere.ec2.VPNConnectionRoute(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VPNConnectionRoute

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DestinationCidrBlock': (<class 'str'>, True), 'VpnConnectionId': (<class 'str'>,True)}

resource_type: Optional[str] = 'AWS::EC2::VPNConnectionRoute'

class troposphere.ec2.VPNGateway(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VPNGateway

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AmazonSideAsn': (<function integer>, False), 'Tags': (<functionvalidate_tags_or_list>, False), 'Type': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::VPNGateway'

class troposphere.ec2.VPNGatewayRoutePropagation(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VPNGatewayRoutePropagation

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RouteTableIds': ([<class 'str'>], True), 'VpnGatewayId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::VPNGatewayRoutePropagation'

class troposphere.ec2.Volume(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Volume

7.3. troposphere 303

Page 308: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoEnableIO': (<function boolean>, False), 'AvailabilityZone': (<class 'str'>,True), 'Encrypted': (<function boolean>, False), 'Iops': (<function integer>,False), 'KmsKeyId': (<class 'str'>, False), 'MultiAttachEnabled': (<functionboolean>, False), 'OutpostArn': (<class 'str'>, False), 'Size': (<functioninteger>, False), 'SnapshotId': (<class 'str'>, False), 'Tags': (<functionvalidate_tags_or_list>, False), 'Throughput': (<function integer>, False),'VolumeType': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::EC2::Volume'

class troposphere.ec2.VolumeAttachment(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VolumeAttachment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Device': (<class 'str'>, True), 'InstanceId': (<class 'str'>, True), 'VolumeId':(<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EC2::VolumeAttachment'

class troposphere.ec2.VolumeProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VolumeProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Device': (<class 'str'>, True), 'VolumeId': (<class 'str'>, True)}

class troposphere.ec2.VpnTunnelOptionsSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VpnTunnelOptionsSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PreSharedKey': (<function vpn_pre_shared_key>, False), 'TunnelInsideCidr':(<function vpn_tunnel_inside_cidr>, False)}

troposphere.ecr module

class troposphere.ecr.EncryptionConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EncryptionConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EncryptionType': (<class 'str'>, True), 'KmsKey': (<class 'str'>, False)}

class troposphere.ecr.ImageScanningConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ImageScanningConfiguration

304 Chapter 7. Licensing

Page 309: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ScanOnPush': (<function boolean>, False)}

class troposphere.ecr.LifecyclePolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LifecyclePolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LifecyclePolicyText': (<class 'str'>, False), 'RegistryId': (<class 'str'>,False)}

class troposphere.ecr.PublicRepository(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

PublicRepository

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RepositoryCatalogData': (<class 'dict'>, False), 'RepositoryName': (<class'str'>, False), 'RepositoryPolicyText': (<function policytypes>, False), 'Tags':(<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::ECR::PublicRepository'

class troposphere.ecr.PullThroughCacheRule(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

PullThroughCacheRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EcrRepositoryPrefix': (<class 'str'>, False), 'UpstreamRegistryUrl': (<class'str'>, False)}

resource_type: Optional[str] = 'AWS::ECR::PullThroughCacheRule'

class troposphere.ecr.RegistryPolicy(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

RegistryPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PolicyText': (<function policytypes>, True)}

resource_type: Optional[str] = 'AWS::ECR::RegistryPolicy'

class troposphere.ecr.ReplicationConfiguration(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ReplicationConfiguration

7.3. troposphere 305

Page 310: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ReplicationConfigurationProperty': (<class'troposphere.ecr.ReplicationConfigurationProperty'>, True)}

resource_type: Optional[str] = 'AWS::ECR::ReplicationConfiguration'

class troposphere.ecr.ReplicationConfigurationProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ReplicationConfigurationProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Rules': ([<class 'troposphere.ecr.ReplicationRule'>], True)}

class troposphere.ecr.ReplicationDestination(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ReplicationDestination

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Region': (<class 'str'>, True), 'RegistryId': (<class 'str'>, True)}

class troposphere.ecr.ReplicationRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ReplicationRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Destinations': ([<class 'troposphere.ecr.ReplicationDestination'>], True),'RepositoryFilters': ([<class 'troposphere.ecr.RepositoryFilter'>], False)}

class troposphere.ecr.Repository(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Repository

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EncryptionConfiguration': (<class 'troposphere.ecr.EncryptionConfiguration'>,False), 'ImageScanningConfiguration': (<class'troposphere.ecr.ImageScanningConfiguration'>, False), 'ImageTagMutability':(<class 'str'>, False), 'LifecyclePolicy': (<class'troposphere.ecr.LifecyclePolicy'>, False), 'RepositoryName': (<class 'str'>,False), 'RepositoryPolicyText': (<function policytypes>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::ECR::Repository'

class troposphere.ecr.RepositoryFilter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RepositoryFilter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Filter': (<class 'str'>, True), 'FilterType': (<class 'str'>, True)}

306 Chapter 7. Licensing

Page 311: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.ecs module

class troposphere.ecs.AuthorizationConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AuthorizationConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessPointId': (<class 'str'>, False), 'IAM': (<class 'str'>, False)}

class troposphere.ecs.AutoScalingGroupProvider(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AutoScalingGroupProvider

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoScalingGroupArn': (<class 'str'>, True), 'ManagedScaling': (<class'troposphere.ecs.ManagedScaling'>, False), 'ManagedTerminationProtection': (<class'str'>, False)}

class troposphere.ecs.AwsvpcConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AwsvpcConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssignPublicIp': (<class 'str'>, False), 'SecurityGroups': ([<class 'str'>],False), 'Subnets': ([<class 'str'>], False)}

class troposphere.ecs.CapacityProvider(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

CapacityProvider

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoScalingGroupProvider': (<class 'troposphere.ecs.AutoScalingGroupProvider'>,True), 'Name': (<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>,False)}

resource_type: Optional[str] = 'AWS::ECS::CapacityProvider'

class troposphere.ecs.CapacityProviderStrategy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CapacityProviderStrategy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Base': (<function integer>, False), 'CapacityProvider': (<class 'str'>, True),'Weight': (<function integer>, False)}

class troposphere.ecs.CapacityProviderStrategyItem(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CapacityProviderStrategyItem

7.3. troposphere 307

Page 312: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Base': (<function integer>, False), 'CapacityProvider': (<class 'str'>, False),'Weight': (<function integer>, False)}

class troposphere.ecs.Cluster(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Cluster

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CapacityProviders': ([<class 'str'>], False), 'ClusterName': (<class 'str'>,False), 'ClusterSettings': ([<class 'troposphere.ecs.ClusterSetting'>], False),'Configuration': (<class 'troposphere.ecs.ClusterConfiguration'>, False),'DefaultCapacityProviderStrategy': ([<class'troposphere.ecs.CapacityProviderStrategyItem'>], False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::ECS::Cluster'

class troposphere.ecs.ClusterCapacityProviderAssociations(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ClusterCapacityProviderAssociations

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CapacityProviders': ([<class 'str'>], True), 'Cluster': (<class 'str'>, True),'DefaultCapacityProviderStrategy': ([<class'troposphere.ecs.CapacityProviderStrategy'>], True)}

resource_type: Optional[str] = 'AWS::ECS::ClusterCapacityProviderAssociations'

class troposphere.ecs.ClusterConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ClusterConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ExecuteCommandConfiguration': (<class'troposphere.ecs.ExecuteCommandConfiguration'>, False)}

class troposphere.ecs.ClusterSetting(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ClusterSetting

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'Value': (<class 'str'>, False)}

class troposphere.ecs.ContainerDefinition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ContainerDefinition

308 Chapter 7. Licensing

Page 313: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Command': ([<class 'str'>], False), 'Cpu': (<function integer>, False),'DependsOn': ([<class 'troposphere.ecs.ContainerDependency'>], False),'DisableNetworking': (<function boolean>, False), 'DnsSearchDomains': ([<class'str'>], False), 'DnsServers': ([<class 'str'>], False), 'DockerLabels': (<class'dict'>, False), 'DockerSecurityOptions': ([<class 'str'>], False), 'EntryPoint':([<class 'str'>], False), 'Environment': ([<class 'troposphere.ecs.Environment'>],False), 'EnvironmentFiles': ([<class 'troposphere.ecs.EnvironmentFile'>], False),'Essential': (<function boolean>, False), 'ExtraHosts': ([<class'troposphere.ecs.HostEntry'>], False), 'FirelensConfiguration': (<class'troposphere.ecs.FirelensConfiguration'>, False), 'HealthCheck': (<class'troposphere.ecs.HealthCheck'>, False), 'Hostname': (<class 'str'>, False),'Image': (<class 'str'>, False), 'Interactive': (<function boolean>, False),'Links': ([<class 'str'>], False), 'LinuxParameters': (<class'troposphere.ecs.LinuxParameters'>, False), 'LogConfiguration': (<class'troposphere.ecs.LogConfiguration'>, False), 'Memory': (<function integer>, False),'MemoryReservation': (<function integer>, False), 'MountPoints': ([<class'troposphere.ecs.MountPoint'>], False), 'Name': (<class 'str'>, False),'PortMappings': ([<class 'troposphere.ecs.PortMapping'>], False), 'Privileged':(<function boolean>, False), 'PseudoTerminal': (<function boolean>, False),'ReadonlyRootFilesystem': (<function boolean>, False), 'RepositoryCredentials':(<class 'troposphere.ecs.RepositoryCredentials'>, False), 'ResourceRequirements':([<class 'troposphere.ecs.ResourceRequirement'>], False), 'Secrets': ([<class'troposphere.ecs.Secret'>], False), 'StartTimeout': (<function integer>, False),'StopTimeout': (<function integer>, False), 'SystemControls': ([<class'troposphere.ecs.SystemControl'>], False), 'Ulimits': ([<class'troposphere.ecs.Ulimit'>], False), 'User': (<class 'str'>, False), 'VolumesFrom':([<class 'troposphere.ecs.VolumesFrom'>], False), 'WorkingDirectory': (<class'str'>, False)}

class troposphere.ecs.ContainerDependency(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ContainerDependency

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Condition': (<class 'str'>, False), 'ContainerName': (<class 'str'>, False)}

class troposphere.ecs.DeploymentCircuitBreaker(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DeploymentCircuitBreaker

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enable': (<function boolean>, True), 'Rollback': (<function boolean>, True)}

class troposphere.ecs.DeploymentConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DeploymentConfiguration

7.3. troposphere 309

Page 314: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeploymentCircuitBreaker': (<class 'troposphere.ecs.DeploymentCircuitBreaker'>,False), 'MaximumPercent': (<function integer>, False), 'MinimumHealthyPercent':(<function integer>, False)}

class troposphere.ecs.DeploymentController(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DeploymentController

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Type': (<class 'str'>, False)}

class troposphere.ecs.Device(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Device

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContainerPath': (<class 'str'>, False), 'HostPath': (<class 'str'>, False),'Permissions': ([<class 'str'>], False)}

class troposphere.ecs.DockerVolumeConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DockerVolumeConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Autoprovision': (<function boolean>, False), 'Driver': (<class 'str'>, False),'DriverOpts': (<class 'dict'>, False), 'Labels': (<class 'dict'>, False), 'Scope':(<function scope_validator>, False)}

class troposphere.ecs.EFSVolumeConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EFSVolumeConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthorizationConfig': (<class 'troposphere.ecs.AuthorizationConfig'>, False),'FilesystemId': (<class 'str'>, True), 'RootDirectory': (<class 'str'>, False),'TransitEncryption': (<function ecs_efs_encryption_status>, False),'TransitEncryptionPort': (<function validate_transit_encryption_port>, False)}

class troposphere.ecs.Environment(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Environment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'Value': (<class 'str'>, False)}

class troposphere.ecs.EnvironmentFile(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EnvironmentFile

310 Chapter 7. Licensing

Page 315: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Type': (<class 'str'>, False), 'Value': (<class 'str'>, False)}

class troposphere.ecs.EphemeralStorage(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EphemeralStorage

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SizeInGiB': (<function validate_ephemeral_storage_size>, False)}

class troposphere.ecs.ExecuteCommandConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ExecuteCommandConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KmsKeyId': (<class 'str'>, False), 'LogConfiguration': (<class'troposphere.ecs.ExecuteCommandLogConfiguration'>, False), 'Logging': (<class'str'>, False)}

class troposphere.ecs.ExecuteCommandLogConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ExecuteCommandLogConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudWatchEncryptionEnabled': (<function boolean>, False),'CloudWatchLogGroupName': (<class 'str'>, False), 'S3BucketName': (<class 'str'>,False), 'S3EncryptionEnabled': (<function boolean>, False), 'S3KeyPrefix': (<class'str'>, False)}

class troposphere.ecs.FirelensConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FirelensConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Options': (<class 'dict'>, False), 'Type': (<class 'str'>, False)}

class troposphere.ecs.HealthCheck(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HealthCheck

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Command': ([<class 'str'>], False), 'Interval': (<function integer>, False),'Retries': (<function integer>, False), 'StartPeriod': (<function integer>,False), 'Timeout': (<function integer>, False)}

class troposphere.ecs.Host(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Host

7.3. troposphere 311

Page 316: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SourcePath': (<class 'str'>, False)}

class troposphere.ecs.HostEntry(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HostEntry

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Hostname': (<class 'str'>, False), 'IpAddress': (<class 'str'>, False)}

class troposphere.ecs.InferenceAccelerator(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InferenceAccelerator

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeviceName': (<class 'str'>, False), 'DeviceType': (<class 'str'>, False)}

class troposphere.ecs.KernelCapabilities(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KernelCapabilities

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Add':([<class 'str'>], False), 'Drop': ([<class 'str'>], False)}

class troposphere.ecs.LinuxParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LinuxParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Capabilities': (<class 'troposphere.ecs.KernelCapabilities'>, False), 'Devices':([<class 'troposphere.ecs.Device'>], False), 'InitProcessEnabled': (<functionboolean>, False), 'MaxSwap': (<function integer>, False), 'SharedMemorySize':(<function integer>, False), 'Swappiness': (<function integer>, False), 'Tmpfs':([<class 'troposphere.ecs.Tmpfs'>], False)}

class troposphere.ecs.LoadBalancer(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LoadBalancer

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContainerName': (<class 'str'>, False), 'ContainerPort': (<functionvalidate_network_port>, False), 'LoadBalancerName': (<class 'str'>, False),'TargetGroupArn': (<class 'str'>, False)}

class troposphere.ecs.LogConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LogConfiguration

312 Chapter 7. Licensing

Page 317: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LogDriver': (<class 'str'>, True), 'Options': (<class 'dict'>, False),'SecretOptions': ([<class 'troposphere.ecs.Secret'>], False)}

class troposphere.ecs.ManagedScaling(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ManagedScaling

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InstanceWarmupPeriod': (<function integer>, False), 'MaximumScalingStepSize':(<function validate_scaling_step_size>, False), 'MinimumScalingStepSize':(<function validate_scaling_step_size>, False), 'Status': (<class 'str'>, False),'TargetCapacity': (<function validate_target_capacity>, False)}

class troposphere.ecs.MountPoint(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MountPoint

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContainerPath': (<class 'str'>, False), 'ReadOnly': (<function boolean>, False),'SourceVolume': (<class 'str'>, False)}

class troposphere.ecs.NetworkConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NetworkConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AwsvpcConfiguration': (<class 'troposphere.ecs.AwsvpcConfiguration'>, False)}

class troposphere.ecs.PlacementConstraint(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PlacementConstraint

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Expression': (<class 'str'>, False), 'Type': (<functionplacement_constraint_validator>, True)}

class troposphere.ecs.PlacementStrategy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PlacementStrategy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Field': (<class 'str'>, False), 'Type': (<functionplacement_strategy_validator>, True)}

class troposphere.ecs.PortMapping(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PortMapping

7.3. troposphere 313

Page 318: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContainerPort': (<function validate_network_port>, False), 'HostPort':(<function validate_network_port>, False), 'Protocol': (<class 'str'>, False)}

class troposphere.ecs.PrimaryTaskSet(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

PrimaryTaskSet

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Cluster': (<class 'str'>, True), 'Service': (<class 'str'>, True), 'TaskSetId':(<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::ECS::PrimaryTaskSet'

class troposphere.ecs.ProxyConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ProxyConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContainerName': (<class 'str'>, True), 'ProxyConfigurationProperties': (<class'list'>, False), 'Type': (<function ecs_proxy_type>, False)}

class troposphere.ecs.RepositoryCredentials(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RepositoryCredentials

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CredentialsParameter': (<class 'str'>, False)}

class troposphere.ecs.ResourceRequirement(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ResourceRequirement

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Type': (<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.ecs.RuntimePlatform(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RuntimePlatform

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CpuArchitecture': (<class 'str'>, False), 'OperatingSystemFamily': (<class'str'>, False)}

validate()

class troposphere.ecs.Scale(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Scale

314 Chapter 7. Licensing

Page 319: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Unit': (<class 'str'>, False), 'Value': (<function double>, False)}

class troposphere.ecs.Secret(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Secret

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'ValueFrom': (<class 'str'>, True)}

class troposphere.ecs.Service(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Service

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CapacityProviderStrategy': ([<class'troposphere.ecs.CapacityProviderStrategyItem'>], False), 'Cluster': (<class'str'>, False), 'DeploymentConfiguration': (<class'troposphere.ecs.DeploymentConfiguration'>, False), 'DeploymentController': (<class'troposphere.ecs.DeploymentController'>, False), 'DesiredCount': (<functioninteger>, False), 'EnableECSManagedTags': (<function boolean>, False),'EnableExecuteCommand': (<function boolean>, False),'HealthCheckGracePeriodSeconds': (<function integer>, False), 'LaunchType':(<function launch_type_validator>, False), 'LoadBalancers': ([<class'troposphere.ecs.LoadBalancer'>], False), 'NetworkConfiguration': (<class'troposphere.ecs.NetworkConfiguration'>, False), 'PlacementConstraints': ([<class'troposphere.ecs.PlacementConstraint'>], False), 'PlacementStrategies': ([<class'troposphere.ecs.PlacementStrategy'>], False), 'PlatformVersion': (<class 'str'>,False), 'PropagateTags': (<class 'str'>, False), 'Role': (<class 'str'>, False),'SchedulingStrategy': (<class 'str'>, False), 'ServiceName': (<class 'str'>,False), 'ServiceRegistries': ([<class 'troposphere.ecs.ServiceRegistry'>], False),'Tags': (<class 'troposphere.Tags'>, False), 'TaskDefinition': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::ECS::Service'

class troposphere.ecs.ServiceRegistry(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ServiceRegistry

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContainerName': (<class 'str'>, False), 'ContainerPort': (<function integer>,False), 'Port': (<function integer>, False), 'RegistryArn': (<class 'str'>,False)}

class troposphere.ecs.SystemControl(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SystemControl

7.3. troposphere 315

Page 320: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Namespace': (<class 'str'>, False), 'Value': (<class 'str'>, False)}

class troposphere.ecs.TaskDefinition(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

TaskDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContainerDefinitions': ([<class 'troposphere.ecs.ContainerDefinition'>], False),'Cpu': (<class 'str'>, False), 'EphemeralStorage': (<class'troposphere.ecs.EphemeralStorage'>, False), 'ExecutionRoleArn': (<class 'str'>,False), 'Family': (<class 'str'>, False), 'InferenceAccelerators': ([<class'troposphere.ecs.InferenceAccelerator'>], False), 'IpcMode': (<class 'str'>,False), 'Memory': (<class 'str'>, False), 'NetworkMode': (<class 'str'>, False),'PidMode': (<class 'str'>, False), 'PlacementConstraints': ([<class'troposphere.ecs.PlacementConstraint'>], False), 'ProxyConfiguration': (<class'troposphere.ecs.ProxyConfiguration'>, False), 'RequiresCompatibilities': ([<class'str'>], False), 'RuntimePlatform': (<class 'troposphere.ecs.RuntimePlatform'>,False), 'Tags': (<class 'troposphere.Tags'>, False), 'TaskRoleArn': (<class'str'>, False), 'Volumes': ([<class 'troposphere.ecs.Volume'>], False)}

resource_type: Optional[str] = 'AWS::ECS::TaskDefinition'

class troposphere.ecs.TaskSet(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

TaskSet

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Cluster': (<class 'str'>, True), 'ExternalId': (<class 'str'>, False),'LaunchType': (<class 'str'>, False), 'LoadBalancers': ([<class'troposphere.ecs.LoadBalancer'>], False), 'NetworkConfiguration': (<class'troposphere.ecs.NetworkConfiguration'>, False), 'PlatformVersion': (<class 'str'>,False), 'Scale': (<class 'troposphere.ecs.Scale'>, False), 'Service': (<class'str'>, True), 'ServiceRegistries': ([<class 'troposphere.ecs.ServiceRegistry'>],False), 'TaskDefinition': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::ECS::TaskSet'

class troposphere.ecs.Tmpfs(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Tmpfs

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContainerPath': (<class 'str'>, False), 'MountOptions': ([<class 'str'>],False), 'Size': (<function integer>, True)}

class troposphere.ecs.Ulimit(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Ulimit

316 Chapter 7. Licensing

Page 321: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HardLimit': (<function integer>, True), 'Name': (<class 'str'>, True),'SoftLimit': (<function integer>, True)}

class troposphere.ecs.Volume(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Volume

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DockerVolumeConfiguration': (<class 'troposphere.ecs.DockerVolumeConfiguration'>,False), 'EFSVolumeConfiguration': (<class'troposphere.ecs.EFSVolumeConfiguration'>, False), 'Host': (<class'troposphere.ecs.Host'>, False), 'Name': (<class 'str'>, False)}

class troposphere.ecs.VolumesFrom(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VolumesFrom

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ReadOnly': (<function boolean>, False), 'SourceContainer': (<class 'str'>,False)}

troposphere.efs module

class troposphere.efs.AccessPoint(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

AccessPoint

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessPointTags': (<class 'troposphere.Tags'>, False), 'ClientToken': (<class'str'>, False), 'FileSystemId': (<class 'str'>, True), 'PosixUser': (<class'troposphere.efs.PosixUser'>, False), 'RootDirectory': (<class'troposphere.efs.RootDirectory'>, False)}

resource_type: Optional[str] = 'AWS::EFS::AccessPoint'

class troposphere.efs.BackupPolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BackupPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Status': (<class 'str'>, True)}

validate()

class troposphere.efs.CreationInfo(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CreationInfo

7.3. troposphere 317

Page 322: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'OwnerGid': (<class 'str'>, True), 'OwnerUid': (<class 'str'>, True),'Permissions': (<class 'str'>, True)}

class troposphere.efs.FileSystem(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

FileSystem

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AvailabilityZoneName': (<class 'str'>, False), 'BackupPolicy': (<class'troposphere.efs.BackupPolicy'>, False), 'BypassPolicyLockoutSafetyCheck':(<function boolean>, False), 'Encrypted': (<function boolean>, False),'FileSystemPolicy': (<class 'dict'>, False), 'FileSystemTags': (<class'troposphere.Tags'>, False), 'KmsKeyId': (<class 'str'>, False),'LifecyclePolicies': ([<class 'troposphere.efs.LifecyclePolicy'>], False),'PerformanceMode': (<class 'str'>, False), 'ProvisionedThroughputInMibps':(<function provisioned_throughput_validator>, False), 'ThroughputMode': (<functionthroughput_mode_validator>, False)}

resource_type: Optional[str] = 'AWS::EFS::FileSystem'

class troposphere.efs.LifecyclePolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LifecyclePolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TransitionToIA': (<class 'str'>, False), 'TransitionToPrimaryStorageClass':(<class 'str'>, False)}

class troposphere.efs.MountTarget(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

MountTarget

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FileSystemId': (<class 'str'>, True), 'IpAddress': (<class 'str'>, False),'SecurityGroups': ([<class 'str'>], True), 'SubnetId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EFS::MountTarget'

class troposphere.efs.PosixUser(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PosixUser

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Gid':(<class 'str'>, True), 'SecondaryGids': ([<class 'str'>], False), 'Uid': (<class'str'>, True)}

class troposphere.efs.RootDirectory(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RootDirectory

318 Chapter 7. Licensing

Page 323: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CreationInfo': (<class 'troposphere.efs.CreationInfo'>, False), 'Path': (<class'str'>, False)}

troposphere.eks module

class troposphere.eks.Addon(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Addon

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AddonName': (<class 'str'>, True), 'AddonVersion': (<class 'str'>, False),'ClusterName': (<class 'str'>, True), 'ResolveConflicts': (<class 'str'>, False),'ServiceAccountRoleArn': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::EKS::Addon'

class troposphere.eks.Cluster(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Cluster

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EncryptionConfig': ([<class 'troposphere.eks.EncryptionConfig'>], False),'KubernetesNetworkConfig': (<class 'troposphere.eks.KubernetesNetworkConfig'>,False), 'Logging': (<class 'troposphere.eks.Logging'>, False), 'Name': (<class'str'>, False), 'ResourcesVpcConfig': (<class'troposphere.eks.ResourcesVpcConfig'>, True), 'RoleArn': (<class 'str'>, True),'Tags': (<class 'troposphere.Tags'>, False), 'Version': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::EKS::Cluster'

class troposphere.eks.ClusterLogging(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ClusterLogging

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EnabledTypes': ([<class 'troposphere.eks.LoggingTypeConfig'>], False)}

validate()

class troposphere.eks.EncryptionConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EncryptionConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Provider': (<class 'troposphere.eks.Provider'>, False), 'Resources': ([<class'str'>], False)}

7.3. troposphere 319

Page 324: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.eks.FargateProfile(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

FargateProfile

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClusterName': (<class 'str'>, True), 'FargateProfileName': (<class 'str'>,False), 'PodExecutionRoleArn': (<class 'str'>, True), 'Selectors': ([<class'troposphere.eks.Selector'>], True), 'Subnets': ([<class 'str'>], False), 'Tags':(<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::EKS::FargateProfile'

class troposphere.eks.IdentityProviderConfig(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

IdentityProviderConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClusterName': (<class 'str'>, True), 'IdentityProviderConfigName': (<class'str'>, False), 'Oidc': (<class 'troposphere.eks.OidcIdentityProviderConfig'>,False), 'Tags': (<class 'troposphere.Tags'>, False), 'Type': (<class 'str'>,True)}

resource_type: Optional[str] = 'AWS::EKS::IdentityProviderConfig'

class troposphere.eks.KubernetesNetworkConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KubernetesNetworkConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'IpFamily': (<class 'str'>, False), 'ServiceIpv4Cidr': (<class 'str'>, False),'ServiceIpv6Cidr': (<class 'str'>, False)}

class troposphere.eks.Label(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Label

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.eks.LaunchTemplateSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LaunchTemplateSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Id':(<class 'str'>, False), 'Name': (<class 'str'>, False), 'Version': (<class 'str'>,False)}

class troposphere.eks.Logging(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

320 Chapter 7. Licensing

Page 325: Release 3.1

troposphere Documentation, Release 4.0.1

Logging

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClusterLogging': (<class 'troposphere.eks.ClusterLogging'>, False)}

class troposphere.eks.LoggingTypeConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LoggingTypeConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Type': (<class 'str'>, False)}

class troposphere.eks.Nodegroup(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Nodegroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AmiType': (<class 'str'>, False), 'CapacityType': (<class 'str'>, False),'ClusterName': (<class 'str'>, True), 'DiskSize': (<function integer>, False),'ForceUpdateEnabled': (<function boolean>, False), 'InstanceTypes': ([<class'str'>], False), 'Labels': (<class 'dict'>, False), 'LaunchTemplate': (<class'troposphere.eks.LaunchTemplateSpecification'>, False), 'NodeRole': (<class 'str'>,True), 'NodegroupName': (<class 'str'>, False), 'ReleaseVersion': (<class 'str'>,False), 'RemoteAccess': (<class 'troposphere.eks.RemoteAccess'>, False),'ScalingConfig': (<class 'troposphere.eks.ScalingConfig'>, False), 'Subnets':([<class 'str'>], True), 'Tags': (<class 'dict'>, False), 'Taints': ([<class'troposphere.eks.Taint'>], False), 'UpdateConfig': (<class'troposphere.eks.UpdateConfig'>, False), 'Version': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::EKS::Nodegroup'

class troposphere.eks.OidcIdentityProviderConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OidcIdentityProviderConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClientId': (<class 'str'>, True), 'GroupsClaim': (<class 'str'>, False),'GroupsPrefix': (<class 'str'>, False), 'IssuerUrl': (<class 'str'>, True),'RequiredClaims': ([<class 'troposphere.eks.RequiredClaim'>], False),'UsernameClaim': (<class 'str'>, False), 'UsernamePrefix': (<class 'str'>, False)}

class troposphere.eks.Provider(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Provider

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KeyArn': (<class 'str'>, False)}

class troposphere.eks.RemoteAccess(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RemoteAccess

7.3. troposphere 321

Page 326: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Ec2SshKey': (<class 'str'>, True), 'SourceSecurityGroups': ([<class 'str'>],False)}

class troposphere.eks.RequiredClaim(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RequiredClaim

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.eks.ResourcesVpcConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ResourcesVpcConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EndpointPrivateAccess': (<function boolean>, False), 'EndpointPublicAccess':(<function boolean>, False), 'PublicAccessCidrs': ([<class 'str'>], False),'SecurityGroupIds': ([<class 'str'>], False), 'SubnetIds': ([<class 'str'>],True)}

class troposphere.eks.ScalingConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ScalingConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DesiredSize': (<function integer>, False), 'MaxSize': (<function integer>,False), 'MinSize': (<function integer>, False)}

class troposphere.eks.Selector(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Selector

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Labels': ([<class 'troposphere.eks.Label'>], False), 'Namespace': (<class'str'>, True)}

class troposphere.eks.Taint(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Taint

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Effect': (<function validate_taint_effect>, False), 'Key': (<functionvalidate_taint_key>, False), 'Value': (<function validate_taint_value>, False)}

class troposphere.eks.UpdateConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

UpdateConfig

322 Chapter 7. Licensing

Page 327: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxUnavailable': (<function double>, False), 'MaxUnavailablePercentage':(<function double>, False)}

troposphere.elasticache module

class troposphere.elasticache.CacheCluster(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

CacheCluster

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AZMode': (<class 'str'>, False), 'AutoMinorVersionUpgrade': (<function boolean>,False), 'CacheNodeType': (<class 'str'>, True), 'CacheParameterGroupName': (<class'str'>, False), 'CacheSecurityGroupNames': ([<class 'str'>], False),'CacheSubnetGroupName': (<class 'str'>, False), 'ClusterName': (<class 'str'>,False), 'Engine': (<class 'str'>, True), 'EngineVersion': (<class 'str'>, False),'LogDeliveryConfigurations': ([<class'troposphere.elasticache.LogDeliveryConfigurationRequest'>], False),'NotificationTopicArn': (<class 'str'>, False), 'NumCacheNodes': (<functioninteger>, True), 'Port': (<function integer>, False), 'PreferredAvailabilityZone':(<class 'str'>, False), 'PreferredAvailabilityZones': ([<class 'str'>], False),'PreferredMaintenanceWindow': (<class 'str'>, False), 'SnapshotArns': ([<class'str'>], False), 'SnapshotName': (<class 'str'>, False), 'SnapshotRetentionLimit':(<function integer>, False), 'SnapshotWindow': (<class 'str'>, False), 'Tags':(<class 'troposphere.Tags'>, False), 'VpcSecurityGroupIds': ([<class 'str'>],False)}

resource_type: Optional[str] = 'AWS::ElastiCache::CacheCluster'

validate()

class troposphere.elasticache.CloudWatchLogsDestinationDetails(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

CloudWatchLogsDestinationDetails

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LogGroup': (<class 'str'>, True)}

class troposphere.elasticache.DestinationDetails(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DestinationDetails

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudWatchLogsDetails': (<class'troposphere.elasticache.CloudWatchLogsDestinationDetails'>, False),'KinesisFirehoseDetails': (<class'troposphere.elasticache.KinesisFirehoseDestinationDetails'>, False)}

7.3. troposphere 323

Page 328: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.elasticache.GlobalReplicationGroup(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

GlobalReplicationGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutomaticFailoverEnabled': (<function boolean>, False), 'CacheNodeType': (<class'str'>, False), 'CacheParameterGroupName': (<class 'str'>, False), 'EngineVersion':(<class 'str'>, False), 'GlobalNodeGroupCount': (<function integer>, False),'GlobalReplicationGroupDescription': (<class 'str'>, False),'GlobalReplicationGroupIdSuffix': (<class 'str'>, False), 'Members': ([<class'troposphere.elasticache.GlobalReplicationGroupMember'>], True),'RegionalConfigurations': ([<class'troposphere.elasticache.RegionalConfiguration'>], False)}

resource_type: Optional[str] = 'AWS::ElastiCache::GlobalReplicationGroup'

class troposphere.elasticache.GlobalReplicationGroupMember(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

GlobalReplicationGroupMember

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ReplicationGroupId': (<class 'str'>, False), 'ReplicationGroupRegion': (<class'str'>, False), 'Role': (<class 'str'>, False)}

class troposphere.elasticache.KinesisFirehoseDestinationDetails(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

KinesisFirehoseDestinationDetails

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeliveryStream': (<class 'str'>, True)}

class troposphere.elasticache.LogDeliveryConfigurationRequest(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

LogDeliveryConfigurationRequest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DestinationDetails': (<class 'troposphere.elasticache.DestinationDetails'>,True), 'DestinationType': (<class 'str'>, True), 'LogFormat': (<class 'str'>,True), 'LogType': (<class 'str'>, True)}

class troposphere.elasticache.NodeGroupConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NodeGroupConfiguration

324 Chapter 7. Licensing

Page 329: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'NodeGroupId': (<function validate_node_group_id>, False),'PrimaryAvailabilityZone': (<class 'str'>, False), 'ReplicaAvailabilityZones':([<class 'str'>], False), 'ReplicaCount': (<function integer>, False), 'Slots':(<class 'str'>, False)}

class troposphere.elasticache.ParameterGroup(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

ParameterGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CacheParameterGroupFamily': (<class 'str'>, True), 'Description': (<class'str'>, True), 'Properties': (<class 'dict'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::ElastiCache::ParameterGroup'

class troposphere.elasticache.RegionalConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RegionalConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ReplicationGroupId': (<class 'str'>, False), 'ReplicationGroupRegion': (<class'str'>, False), 'ReshardingConfigurations': ([<class'troposphere.elasticache.ReshardingConfiguration'>], False)}

class troposphere.elasticache.ReplicationGroup(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ReplicationGroup

7.3. troposphere 325

Page 330: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AtRestEncryptionEnabled': (<function boolean>, False), 'AuthToken': (<class'str'>, False), 'AutoMinorVersionUpgrade': (<function boolean>, False),'AutomaticFailoverEnabled': (<function boolean>, False), 'CacheNodeType': (<class'str'>, False), 'CacheParameterGroupName': (<class 'str'>, False),'CacheSecurityGroupNames': ([<class 'str'>], False), 'CacheSubnetGroupName':(<class 'str'>, False), 'DataTieringEnabled': (<function boolean>, False),'Engine': (<class 'str'>, False), 'EngineVersion': (<class 'str'>, False),'GlobalReplicationGroupId': (<class 'str'>, False), 'KmsKeyId': (<class 'str'>,False), 'LogDeliveryConfigurations': ([<class'troposphere.elasticache.LogDeliveryConfigurationRequest'>], False),'MultiAZEnabled': (<function boolean>, False), 'NodeGroupConfiguration': ([<class'troposphere.elasticache.NodeGroupConfiguration'>], False), 'NotificationTopicArn':(<class 'str'>, False), 'NumCacheClusters': (<function integer>, False),'NumNodeGroups': (<function integer>, False), 'Port': (<functionvalidate_network_port>, False), 'PreferredCacheClusterAZs': ([<class 'str'>],False), 'PreferredMaintenanceWindow': (<class 'str'>, False), 'PrimaryClusterId':(<class 'str'>, False), 'ReplicasPerNodeGroup': (<function integer>, False),'ReplicationGroupDescription': (<class 'str'>, True), 'ReplicationGroupId':(<class 'str'>, False), 'SecurityGroupIds': ([<class 'str'>], False),'SnapshotArns': ([<class 'str'>], False), 'SnapshotName': (<class 'str'>, False),'SnapshotRetentionLimit': (<function integer>, False), 'SnapshotWindow': (<class'str'>, False), 'SnapshottingClusterId': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False), 'TransitEncryptionEnabled': (<function boolean>,False), 'UserGroupIds': ([<class 'str'>], False)}

resource_type: Optional[str] = 'AWS::ElastiCache::ReplicationGroup'

validate()

class troposphere.elasticache.ReshardingConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ReshardingConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'NodeGroupId': (<class 'str'>, False), 'PreferredAvailabilityZones': ([<class'str'>], False)}

class troposphere.elasticache.SecurityGroup(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

SecurityGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>,False)}

resource_type: Optional[str] = 'AWS::ElastiCache::SecurityGroup'

class troposphere.elasticache.SecurityGroupIngress(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

326 Chapter 7. Licensing

Page 331: Release 3.1

troposphere Documentation, Release 4.0.1

SecurityGroupIngress

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CacheSecurityGroupName': (<class 'str'>, True), 'EC2SecurityGroupName': (<class'str'>, True), 'EC2SecurityGroupOwnerId': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::ElastiCache::SecurityGroupIngress'

class troposphere.elasticache.SubnetGroup(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

SubnetGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CacheSubnetGroupName': (<class 'str'>, False), 'Description': (<class 'str'>,True), 'SubnetIds': ([<class 'str'>], True), 'Tags': (<class 'troposphere.Tags'>,False)}

resource_type: Optional[str] = 'AWS::ElastiCache::SubnetGroup'

class troposphere.elasticache.User(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

User

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessString': (<class 'str'>, False), 'Engine': (<class 'str'>, True),'NoPasswordRequired': (<function boolean>, False), 'Passwords': ([<class 'str'>],False), 'UserId': (<class 'str'>, True), 'UserName': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::ElastiCache::User'

class troposphere.elasticache.UserGroup(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

UserGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Engine': (<class 'str'>, True), 'UserGroupId': (<class 'str'>, True), 'UserIds':([<class 'str'>], False)}

resource_type: Optional[str] = 'AWS::ElastiCache::UserGroup'

7.3. troposphere 327

Page 332: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.elasticbeanstalk module

class troposphere.elasticbeanstalk.Application(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Application

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationName': (<class 'str'>, False), 'Description': (<class 'str'>, False),'ResourceLifecycleConfig': (<class'troposphere.elasticbeanstalk.ApplicationResourceLifecycleConfig'>, False)}

resource_type: Optional[str] = 'AWS::ElasticBeanstalk::Application'

class troposphere.elasticbeanstalk.ApplicationResourceLifecycleConfig(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

ApplicationResourceLifecycleConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ServiceRole': (<class 'str'>, False), 'VersionLifecycleConfig': (<class'troposphere.elasticbeanstalk.ApplicationVersionLifecycleConfig'>, False)}

class troposphere.elasticbeanstalk.ApplicationVersion(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ApplicationVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationName': (<class 'str'>, True), 'Description': (<class 'str'>, False),'SourceBundle': (<class 'troposphere.elasticbeanstalk.SourceBundle'>, True)}

resource_type: Optional[str] = 'AWS::ElasticBeanstalk::ApplicationVersion'

class troposphere.elasticbeanstalk.ApplicationVersionLifecycleConfig(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

ApplicationVersionLifecycleConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxAgeRule': (<class 'troposphere.elasticbeanstalk.MaxAgeRule'>, False),'MaxCountRule': (<class 'troposphere.elasticbeanstalk.MaxCountRule'>, False)}

class troposphere.elasticbeanstalk.ConfigurationTemplate(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ConfigurationTemplate

328 Chapter 7. Licensing

Page 333: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationName': (<class 'str'>, True), 'Description': (<class 'str'>, False),'EnvironmentId': (<class 'str'>, False), 'OptionSettings': ([<class'troposphere.elasticbeanstalk.OptionSetting'>], False), 'PlatformArn': (<class'str'>, False), 'SolutionStackName': (<class 'str'>, False), 'SourceConfiguration':(<class 'troposphere.elasticbeanstalk.SourceConfiguration'>, False)}

resource_type: Optional[str] = 'AWS::ElasticBeanstalk::ConfigurationTemplate'

class troposphere.elasticbeanstalk.Environment(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Environment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationName': (<class 'str'>, True), 'CNAMEPrefix': (<class 'str'>, False),'Description': (<class 'str'>, False), 'EnvironmentName': (<class 'str'>, False),'OperationsRole': (<class 'str'>, False), 'OptionSettings': ([<class'troposphere.elasticbeanstalk.OptionSetting'>], False), 'PlatformArn': (<class'str'>, False), 'SolutionStackName': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False), 'TemplateName': (<class 'str'>, False), 'Tier':(<class 'troposphere.elasticbeanstalk.Tier'>, False), 'VersionLabel': (<class'str'>, False)}

resource_type: Optional[str] = 'AWS::ElasticBeanstalk::Environment'

class troposphere.elasticbeanstalk.MaxAgeRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MaxAgeRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeleteSourceFromS3': (<function boolean>, False), 'Enabled': (<functionboolean>, False), 'MaxAgeInDays': (<function integer>, False)}

class troposphere.elasticbeanstalk.MaxCountRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MaxCountRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeleteSourceFromS3': (<function boolean>, False), 'Enabled': (<functionboolean>, False), 'MaxCount': (<function integer>, False)}

class troposphere.elasticbeanstalk.OptionSetting(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OptionSetting

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Namespace': (<class 'str'>, True), 'OptionName': (<class 'str'>, True),'ResourceName': (<class 'str'>, False), 'Value': (<class 'str'>, False)}

7.3. troposphere 329

Page 334: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.elasticbeanstalk.SourceBundle(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SourceBundle

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'S3Bucket': (<class 'str'>, True), 'S3Key': (<class 'str'>, True)}

class troposphere.elasticbeanstalk.SourceConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SourceConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationName': (<class 'str'>, True), 'TemplateName': (<class 'str'>, True)}

class troposphere.elasticbeanstalk.Tier(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Tier

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<function validate_tier_name>, False), 'Type': (<functionvalidate_tier_type>, False), 'Version': (<class 'str'>, False)}

troposphere.elasticloadbalancing module

class troposphere.elasticloadbalancing.AccessLoggingPolicy(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

AccessLoggingPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EmitInterval': (<function integer>, False), 'Enabled': (<function boolean>,True), 'S3BucketName': (<class 'str'>, True), 'S3BucketPrefix': (<class 'str'>,False)}

class troposphere.elasticloadbalancing.AppCookieStickinessPolicy(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

AppCookieStickinessPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CookieName': (<class 'str'>, True), 'PolicyName': (<class 'str'>, True)}

class troposphere.elasticloadbalancing.ConnectionDrainingPolicy(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ConnectionDrainingPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, True), 'Timeout': (<function integer>, False)}

330 Chapter 7. Licensing

Page 335: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.elasticloadbalancing.ConnectionSettings(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

ConnectionSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'IdleTimeout': (<function integer>, True)}

class troposphere.elasticloadbalancing.HealthCheck(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HealthCheck

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HealthyThreshold': (<function validate_threshold>, True), 'Interval': (<functionvalidate_int_to_str>, True), 'Target': (<class 'str'>, True), 'Timeout':(<function validate_int_to_str>, True), 'UnhealthyThreshold': (<functionvalidate_threshold>, True)}

class troposphere.elasticloadbalancing.LBCookieStickinessPolicy(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

LBCookieStickinessPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CookieExpirationPeriod': (<class 'str'>, False), 'PolicyName': (<class 'str'>,False)}

class troposphere.elasticloadbalancing.Listener(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Listener

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InstancePort': (<function validate_network_port>, True), 'InstanceProtocol':(<class 'str'>, False), 'LoadBalancerPort': (<function validate_network_port>,True), 'PolicyNames': ([<class 'str'>], False), 'Protocol': (<class 'str'>, True),'SSLCertificateId': (<class 'str'>, False)}

class troposphere.elasticloadbalancing.LoadBalancer(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

LoadBalancer

7.3. troposphere 331

Page 336: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessLoggingPolicy': (<class'troposphere.elasticloadbalancing.AccessLoggingPolicy'>, False),'AppCookieStickinessPolicy': (<class 'list'>, False), 'AvailabilityZones': (<class'list'>, False), 'ConnectionDrainingPolicy': (<class'troposphere.elasticloadbalancing.ConnectionDrainingPolicy'>, False),'ConnectionSettings': (<class'troposphere.elasticloadbalancing.ConnectionSettings'>, False), 'CrossZone':(<function boolean>, False), 'HealthCheck': (<class'troposphere.elasticloadbalancing.HealthCheck'>, False), 'Instances': ([<class'str'>], False), 'LBCookieStickinessPolicy': (<class 'list'>, False), 'Listeners':(<class 'list'>, True), 'LoadBalancerName': (<function validate_elb_name>, False),'Policies': (<class 'list'>, False), 'Scheme': (<class 'str'>, False),'SecurityGroups': ([<class 'str'>], False), 'Subnets': ([<class 'str'>], False),'Tags': (<function validate_tags_or_list>, False)}

resource_type: Optional[str] = 'AWS::ElasticLoadBalancing::LoadBalancer'

class troposphere.elasticloadbalancing.Policy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Policy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Attributes': ([<class 'dict'>], True), 'InstancePorts': ([<class 'str'>],False), 'LoadBalancerPorts': ([<class 'str'>], False), 'PolicyName': (<class'str'>, True), 'PolicyType': (<class 'str'>, True)}

troposphere.elasticloadbalancingv2 module

class troposphere.elasticloadbalancingv2.Action(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Action

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthenticateCognitoConfig': (<class'troposphere.elasticloadbalancingv2.AuthenticateCognitoConfig'>, False),'AuthenticateOidcConfig': (<class'troposphere.elasticloadbalancingv2.AuthenticateOidcConfig'>, False),'FixedResponseConfig': (<class'troposphere.elasticloadbalancingv2.FixedResponseConfig'>, False), 'ForwardConfig':(<class 'troposphere.elasticloadbalancingv2.ForwardConfig'>, False), 'Order':(<function integer>, False), 'RedirectConfig': (<class'troposphere.elasticloadbalancingv2.RedirectConfig'>, False), 'TargetGroupArn':(<class 'str'>, False), 'Type': (<class 'str'>, True)}

validate()

class troposphere.elasticloadbalancingv2.AuthenticateCognitoConfig(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

AuthenticateCognitoConfig

332 Chapter 7. Licensing

Page 337: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthenticationRequestExtraParams': (<class 'dict'>, False),'OnUnauthenticatedRequest': (<class 'str'>, False), 'Scope': (<class 'str'>,False), 'SessionCookieName': (<class 'str'>, False), 'SessionTimeout': (<functioninteger>, False), 'UserPoolArn': (<class 'str'>, True), 'UserPoolClientId':(<class 'str'>, True), 'UserPoolDomain': (<class 'str'>, True)}

class troposphere.elasticloadbalancingv2.AuthenticateOidcConfig(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

AuthenticateOidcConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthenticationRequestExtraParams': (<class 'dict'>, False),'AuthorizationEndpoint': (<class 'str'>, True), 'ClientId': (<class 'str'>, True),'ClientSecret': (<class 'str'>, True), 'Issuer': (<class 'str'>, True),'OnUnauthenticatedRequest': (<class 'str'>, False), 'Scope': (<class 'str'>,False), 'SessionCookieName': (<class 'str'>, False), 'SessionTimeout': (<class'str'>, False), 'TokenEndpoint': (<class 'str'>, True), 'UserInfoEndpoint':(<class 'str'>, True)}

class troposphere.elasticloadbalancingv2.Certificate(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Certificate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateArn': (<class 'str'>, False)}

class troposphere.elasticloadbalancingv2.Condition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Condition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Field': (<class 'str'>, False), 'HostHeaderConfig': (<class'troposphere.elasticloadbalancingv2.HostHeaderConfig'>, False), 'HttpHeaderConfig':(<class 'troposphere.elasticloadbalancingv2.HttpHeaderConfig'>, False),'HttpRequestMethodConfig': (<class'troposphere.elasticloadbalancingv2.HttpRequestMethodConfig'>, False),'PathPatternConfig': (<class'troposphere.elasticloadbalancingv2.PathPatternConfig'>, False),'QueryStringConfig': (<class'troposphere.elasticloadbalancingv2.QueryStringConfig'>, False), 'SourceIpConfig':(<class 'troposphere.elasticloadbalancingv2.SourceIpConfig'>, False), 'Values':([<class 'str'>], False)}

class troposphere.elasticloadbalancingv2.FixedResponseConfig(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

FixedResponseConfig

7.3. troposphere 333

Page 338: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContentType': (<class 'str'>, False), 'MessageBody': (<class 'str'>, False),'StatusCode': (<class 'str'>, True)}

validate()

class troposphere.elasticloadbalancingv2.ForwardConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ForwardConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TargetGroupStickinessConfig': (<class'troposphere.elasticloadbalancingv2.TargetGroupStickinessConfig'>, False),'TargetGroups': ([<class 'troposphere.elasticloadbalancingv2.TargetGroupTuple'>],False)}

class troposphere.elasticloadbalancingv2.HostHeaderConfig(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

HostHeaderConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Values': ([<class 'str'>], False)}

class troposphere.elasticloadbalancingv2.HttpHeaderConfig(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

HttpHeaderConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HttpHeaderName': (<class 'str'>, False), 'Values': ([<class 'str'>], False)}

class troposphere.elasticloadbalancingv2.HttpRequestMethodConfig(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

HttpRequestMethodConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Values': ([<class 'str'>], False)}

class troposphere.elasticloadbalancingv2.Listener(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Listener

334 Chapter 7. Licensing

Page 339: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AlpnPolicy': ([<class 'str'>], False), 'Certificates': ([<class'troposphere.elasticloadbalancingv2.Certificate'>], False), 'DefaultActions':([<class 'troposphere.elasticloadbalancingv2.Action'>], True), 'LoadBalancerArn':(<class 'str'>, True), 'Port': (<function validate_network_port>, False),'Protocol': (<class 'str'>, False), 'SslPolicy': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::ElasticLoadBalancingV2::Listener'

class troposphere.elasticloadbalancingv2.ListenerCertificate(title: Optional[str], template:Optional[troposphere.Template] =None, validation: bool = True,**kwargs: Any)

Bases: troposphere.AWSObject

ListenerCertificate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Certificates': ([<class 'troposphere.elasticloadbalancingv2.Certificate'>],True), 'ListenerArn': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::ElasticLoadBalancingV2::ListenerCertificate'

class troposphere.elasticloadbalancingv2.ListenerRule(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ListenerRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Actions': ([<class 'troposphere.elasticloadbalancingv2.ListenerRuleAction'>],True), 'Conditions': ([<class 'troposphere.elasticloadbalancingv2.Condition'>],True), 'ListenerArn': (<class 'str'>, True), 'Priority': (<function integer>,True)}

resource_type: Optional[str] = 'AWS::ElasticLoadBalancingV2::ListenerRule'

class troposphere.elasticloadbalancingv2.ListenerRuleAction(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ListenerRuleAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthenticateCognitoConfig': (<class'troposphere.elasticloadbalancingv2.AuthenticateCognitoConfig'>, False),'AuthenticateOidcConfig': (<class'troposphere.elasticloadbalancingv2.ListenerRuleAuthenticateOidcConfig'>, False),'FixedResponseConfig': (<class'troposphere.elasticloadbalancingv2.FixedResponseConfig'>, False), 'ForwardConfig':(<class 'troposphere.elasticloadbalancingv2.ForwardConfig'>, False), 'Order':(<function integer>, False), 'RedirectConfig': (<class'troposphere.elasticloadbalancingv2.RedirectConfig'>, False), 'TargetGroupArn':(<class 'str'>, False), 'Type': (<class 'str'>, True)}

7.3. troposphere 335

Page 340: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.elasticloadbalancingv2.ListenerRuleAuthenticateOidcConfig(title:Optional[str] =None, **kwargs:Any)

Bases: troposphere.AWSProperty

ListenerRuleAuthenticateOidcConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthenticationRequestExtraParams': (<class 'dict'>, False),'AuthorizationEndpoint': (<class 'str'>, True), 'ClientId': (<class 'str'>, True),'ClientSecret': (<class 'str'>, True), 'Issuer': (<class 'str'>, True),'OnUnauthenticatedRequest': (<class 'str'>, False), 'Scope': (<class 'str'>,False), 'SessionCookieName': (<class 'str'>, False), 'SessionTimeout': (<functioninteger>, False), 'TokenEndpoint': (<class 'str'>, True),'UseExistingClientSecret': (<function boolean>, False), 'UserInfoEndpoint':(<class 'str'>, True)}

class troposphere.elasticloadbalancingv2.LoadBalancer(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

LoadBalancer

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'IpAddressType': (<class 'str'>, False), 'LoadBalancerAttributes': ([<class'troposphere.elasticloadbalancingv2.LoadBalancerAttributes'>], False), 'Name':(<function validate_elb_name>, False), 'Scheme': (<class 'str'>, False),'SecurityGroups': ([<class 'str'>], False), 'SubnetMappings': ([<class'troposphere.elasticloadbalancingv2.SubnetMapping'>], False), 'Subnets': ([<class'str'>], False), 'Tags': (<function validate_tags_or_list>, False), 'Type':(<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::ElasticLoadBalancingV2::LoadBalancer'

validate()

class troposphere.elasticloadbalancingv2.LoadBalancerAttributes(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

LoadBalancerAttributes

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, False), 'Value': (<class 'str'>, False)}

class troposphere.elasticloadbalancingv2.Matcher(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Matcher

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GrpcCode': (<class 'str'>, False), 'HttpCode': (<class 'str'>, False)}

336 Chapter 7. Licensing

Page 341: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.elasticloadbalancingv2.PathPatternConfig(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

PathPatternConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Values': ([<class 'str'>], False)}

class troposphere.elasticloadbalancingv2.QueryStringConfig(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

QueryStringConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Values': ([<class 'troposphere.elasticloadbalancingv2.QueryStringKeyValue'>],False)}

class troposphere.elasticloadbalancingv2.QueryStringKeyValue(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

QueryStringKeyValue

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, False), 'Value': (<class 'str'>, False)}

class troposphere.elasticloadbalancingv2.RedirectConfig(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

RedirectConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Host': (<class 'str'>, False), 'Path': (<class 'str'>, False), 'Port': (<class'str'>, False), 'Protocol': (<class 'str'>, False), 'Query': (<class 'str'>,False), 'StatusCode': (<class 'str'>, True)}

validate()

class troposphere.elasticloadbalancingv2.SourceIpConfig(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

SourceIpConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Values': ([<class 'str'>], False)}

class troposphere.elasticloadbalancingv2.SubnetMapping(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SubnetMapping

7.3. troposphere 337

Page 342: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllocationId': (<class 'str'>, False), 'IPv6Address': (<class 'str'>, False),'PrivateIPv4Address': (<class 'str'>, False), 'SubnetId': (<class 'str'>, True)}

class troposphere.elasticloadbalancingv2.TargetDescription(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

TargetDescription

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AvailabilityZone': (<class 'str'>, False), 'Id': (<class 'str'>, True), 'Port':(<function validate_network_port>, False)}

class troposphere.elasticloadbalancingv2.TargetGroup(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

TargetGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HealthCheckEnabled': (<function boolean>, False), 'HealthCheckIntervalSeconds':(<function integer>, False), 'HealthCheckPath': (<class 'str'>, False),'HealthCheckPort': (<function tg_healthcheck_port>, False), 'HealthCheckProtocol':(<class 'str'>, False), 'HealthCheckTimeoutSeconds': (<function integer>, False),'HealthyThresholdCount': (<function integer>, False), 'IpAddressType': (<class'str'>, False), 'Matcher': (<class 'troposphere.elasticloadbalancingv2.Matcher'>,False), 'Name': (<class 'str'>, False), 'Port': (<function validate_network_port>,False), 'Protocol': (<class 'str'>, False), 'ProtocolVersion': (<class 'str'>,False), 'Tags': (<function validate_tags_or_list>, False), 'TargetGroupAttributes':([<class 'troposphere.elasticloadbalancingv2.TargetGroupAttribute'>], False),'TargetType': (<function validate_target_type>, False), 'Targets': ([<class'troposphere.elasticloadbalancingv2.TargetDescription'>], False),'UnhealthyThresholdCount': (<function integer>, False), 'VpcId': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::ElasticLoadBalancingV2::TargetGroup'

validate()

class troposphere.elasticloadbalancingv2.TargetGroupAttribute(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

TargetGroupAttribute

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, False), 'Value': (<class 'str'>, False)}

class troposphere.elasticloadbalancingv2.TargetGroupStickinessConfig(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

TargetGroupStickinessConfig

338 Chapter 7. Licensing

Page 343: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DurationSeconds': (<function integer>, False), 'Enabled': (<function boolean>,False)}

class troposphere.elasticloadbalancingv2.TargetGroupTuple(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

TargetGroupTuple

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TargetGroupArn': (<class 'str'>, False), 'Weight': (<function integer>, False)}

troposphere.elasticsearch module

class troposphere.elasticsearch.AdvancedSecurityOptionsInput(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

AdvancedSecurityOptionsInput

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False), 'InternalUserDatabaseEnabled': (<functionboolean>, False), 'MasterUserOptions': (<class'troposphere.elasticsearch.MasterUserOptions'>, False)}

class troposphere.elasticsearch.CognitoOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CognitoOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False), 'IdentityPoolId': (<class 'str'>, False),'RoleArn': (<class 'str'>, False), 'UserPoolId': (<class 'str'>, False)}

class troposphere.elasticsearch.ColdStorageOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ColdStorageOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False)}

class troposphere.elasticsearch.Domain(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Domain

7.3. troposphere 339

Page 344: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessPolicies': (<function policytypes>, False), 'AdvancedOptions': (<class'dict'>, False), 'AdvancedSecurityOptions': (<class'troposphere.elasticsearch.AdvancedSecurityOptionsInput'>, False), 'CognitoOptions':(<class 'troposphere.elasticsearch.CognitoOptions'>, False),'DomainEndpointOptions': (<class'troposphere.elasticsearch.DomainEndpointOptions'>, False), 'DomainName': (<class'str'>, False), 'EBSOptions': (<class 'troposphere.elasticsearch.EBSOptions'>,False), 'ElasticsearchClusterConfig': (<class'troposphere.elasticsearch.ElasticsearchClusterConfig'>, False),'ElasticsearchVersion': (<class 'str'>, False), 'EncryptionAtRestOptions': (<class'troposphere.elasticsearch.EncryptionAtRestOptions'>, False),'LogPublishingOptions': (<class 'dict'>, False), 'NodeToNodeEncryptionOptions':(<class 'troposphere.elasticsearch.NodeToNodeEncryptionOptions'>, False),'SnapshotOptions': (<class 'troposphere.elasticsearch.SnapshotOptions'>, False),'Tags': (<function validate_tags_or_list>, False), 'VPCOptions': (<class'troposphere.elasticsearch.VPCOptions'>, False)}

resource_type: Optional[str] = 'AWS::Elasticsearch::Domain'

class troposphere.elasticsearch.DomainEndpointOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DomainEndpointOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CustomEndpoint': (<class 'str'>, False), 'CustomEndpointCertificateArn': (<class'str'>, False), 'CustomEndpointEnabled': (<function boolean>, False),'EnforceHTTPS': (<function boolean>, False), 'TLSSecurityPolicy': (<functionvalidate_tls_security_policy>, False)}

class troposphere.elasticsearch.EBSOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EBSOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EBSEnabled': (<function boolean>, False), 'Iops': (<function integer>, False),'VolumeSize': (<function integer>, False), 'VolumeType': (<functionvalidate_volume_type>, False)}

validate()

class troposphere.elasticsearch.ElasticsearchClusterConfig(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

ElasticsearchClusterConfig

340 Chapter 7. Licensing

Page 345: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ColdStorageOptions': (<class 'troposphere.elasticsearch.ColdStorageOptions'>,False), 'DedicatedMasterCount': (<function integer>, False),'DedicatedMasterEnabled': (<function boolean>, False), 'DedicatedMasterType':(<class 'str'>, False), 'InstanceCount': (<function integer>, False),'InstanceType': (<class 'str'>, False), 'WarmCount': (<function integer>, False),'WarmEnabled': (<function boolean>, False), 'WarmType': (<class 'str'>, False),'ZoneAwarenessConfig': (<class 'troposphere.elasticsearch.ZoneAwarenessConfig'>,False), 'ZoneAwarenessEnabled': (<function boolean>, False)}

class troposphere.elasticsearch.EncryptionAtRestOptions(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

EncryptionAtRestOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False), 'KmsKeyId': (<class 'str'>, False)}

class troposphere.elasticsearch.LogPublishingOption(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LogPublishingOption

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudWatchLogsLogGroupArn': (<class 'str'>, False), 'Enabled': (<functionboolean>, False)}

class troposphere.elasticsearch.MasterUserOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MasterUserOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MasterUserARN': (<class 'str'>, False), 'MasterUserName': (<class 'str'>, False),'MasterUserPassword': (<class 'str'>, False)}

class troposphere.elasticsearch.NodeToNodeEncryptionOptions(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

NodeToNodeEncryptionOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False)}

class troposphere.elasticsearch.SnapshotOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SnapshotOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutomatedSnapshotStartHour': (<function validate_automated_snapshot_start_hour>,False)}

7.3. troposphere 341

Page 346: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.elasticsearch.VPCOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VPCOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SecurityGroupIds': ([<class 'str'>], False), 'SubnetIds': ([<class 'str'>],False)}

class troposphere.elasticsearch.ZoneAwarenessConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ZoneAwarenessConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AvailabilityZoneCount': (<function integer>, False)}

troposphere.emr module

class troposphere.emr.Application(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Application

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AdditionalInfo': (<function additional_info_validator>, False), 'Args': ([<class'str'>], False), 'Name': (<class 'str'>, False), 'Version': (<class 'str'>,False)}

class troposphere.emr.AutoScalingPolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AutoScalingPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Constraints': (<class 'troposphere.emr.ScalingConstraints'>, True), 'Rules':([<class 'troposphere.emr.ScalingRule'>], True)}

class troposphere.emr.BootstrapActionConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BootstrapActionConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'ScriptBootstrapAction': (<class'troposphere.emr.ScriptBootstrapActionConfig'>, True)}

class troposphere.emr.CloudWatchAlarmDefinition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CloudWatchAlarmDefinition

342 Chapter 7. Licensing

Page 347: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComparisonOperator': (<class 'str'>, True), 'Dimensions': ([<class'troposphere.validators.emr.KeyValueClass'>], False), 'EvaluationPeriods':(<function integer>, False), 'MetricName': (<class 'str'>, True), 'Namespace':(<class 'str'>, False), 'Period': (<function integer>, True), 'Statistic': (<class'str'>, False), 'Threshold': (<function double>, True), 'Unit': (<class 'str'>,False)}

class troposphere.emr.Cluster(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Cluster

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AdditionalInfo': (<class 'dict'>, False), 'Applications': ([<class'troposphere.emr.Application'>], False), 'AutoScalingRole': (<class 'str'>, False),'BootstrapActions': ([<class 'troposphere.emr.BootstrapActionConfig'>], False),'Configurations': ([<class 'troposphere.emr.Configuration'>], False),'CustomAmiId': (<class 'str'>, False), 'EbsRootVolumeSize': (<function integer>,False), 'Instances': (<class 'troposphere.emr.JobFlowInstancesConfig'>, True),'JobFlowRole': (<class 'str'>, True), 'KerberosAttributes': (<class'troposphere.emr.KerberosAttributes'>, False), 'LogEncryptionKmsKeyId': (<class'str'>, False), 'LogUri': (<class 'str'>, False), 'ManagedScalingPolicy': (<class'troposphere.emr.ManagedScalingPolicy'>, False), 'Name': (<class 'str'>, True),'ReleaseLabel': (<class 'str'>, False), 'ScaleDownBehavior': (<class 'str'>,False), 'SecurityConfiguration': (<class 'str'>, False), 'ServiceRole': (<class'str'>, True), 'StepConcurrencyLevel': (<function integer>, False), 'Steps':([<class 'troposphere.emr.StepConfig'>], False), 'Tags': (<class'troposphere.Tags'>, False), 'VisibleToAllUsers': (<function boolean>, False)}

resource_type: Optional[str] = 'AWS::EMR::Cluster'

class troposphere.emr.ComputeLimits(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ComputeLimits

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaximumCapacityUnits': (<function integer>, True), 'MaximumCoreCapacityUnits':(<function integer>, False), 'MaximumOnDemandCapacityUnits': (<function integer>,False), 'MinimumCapacityUnits': (<function integer>, True), 'UnitType': (<class'str'>, True)}

class troposphere.emr.Configuration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Configuration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Classification': (<class 'str'>, False), 'ConfigurationProperties': (<functionproperties_validator>, False), 'Configurations': (<functionvalidate_configurations>, False)}

7.3. troposphere 343

Page 348: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.emr.EbsBlockDeviceConfigs(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EbsBlockDeviceConfigs

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'VolumeSpecification': (<class 'troposphere.emr.VolumeSpecification'>, True),'VolumesPerInstance': (<function integer>, False)}

class troposphere.emr.EbsConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EbsConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EbsBlockDeviceConfigs': ([<class 'troposphere.emr.EbsBlockDeviceConfigs'>],False), 'EbsOptimized': (<function boolean>, False)}

class troposphere.emr.HadoopJarStepConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HadoopJarStepConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Args': ([<class 'str'>], False), 'Jar': (<class 'str'>, True), 'MainClass':(<class 'str'>, False), 'StepProperties': ([<class'troposphere.validators.emr.KeyValueClass'>], False)}

class troposphere.emr.InstanceFleetConfig(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

InstanceFleetConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClusterId': (<class 'str'>, True), 'InstanceFleetType': (<class 'str'>, True),'InstanceTypeConfigs': ([<class 'troposphere.emr.InstanceTypeConfig'>], False),'LaunchSpecifications': (<class'troposphere.emr.InstanceFleetProvisioningSpecifications'>, False), 'Name': (<class'str'>, False), 'TargetOnDemandCapacity': (<function integer>, False),'TargetSpotCapacity': (<function integer>, False)}

resource_type: Optional[str] = 'AWS::EMR::InstanceFleetConfig'

class troposphere.emr.InstanceFleetConfigProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InstanceFleetConfigProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InstanceTypeConfigs': ([<class 'troposphere.emr.InstanceTypeConfig'>], False),'LaunchSpecifications': (<class'troposphere.emr.InstanceFleetProvisioningSpecifications'>, False), 'Name': (<class'str'>, False), 'TargetOnDemandCapacity': (<function integer>, False),'TargetSpotCapacity': (<function integer>, False)}

344 Chapter 7. Licensing

Page 349: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.emr.InstanceFleetProvisioningSpecifications(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

InstanceFleetProvisioningSpecifications

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'OnDemandSpecification': (<class'troposphere.emr.OnDemandProvisioningSpecification'>, False), 'SpotSpecification':(<class 'troposphere.emr.SpotProvisioningSpecification'>, False)}

class troposphere.emr.InstanceGroupConfig(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

InstanceGroupConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoScalingPolicy': (<class 'troposphere.emr.AutoScalingPolicy'>, False),'BidPrice': (<class 'str'>, False), 'Configurations': ([<class'troposphere.emr.Configuration'>], False), 'CustomAmiId': (<class 'str'>, False),'EbsConfiguration': (<class 'troposphere.emr.EbsConfiguration'>, False),'InstanceCount': (<function integer>, True), 'InstanceRole': (<class 'str'>,True), 'InstanceType': (<class 'str'>, True), 'JobFlowId': (<class 'str'>, True),'Market': (<function market_validator>, False), 'Name': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::EMR::InstanceGroupConfig'

class troposphere.emr.InstanceGroupConfigProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InstanceGroupConfigProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoScalingPolicy': (<class 'troposphere.emr.AutoScalingPolicy'>, False),'BidPrice': (<class 'str'>, False), 'Configurations': ([<class'troposphere.emr.Configuration'>], False), 'CustomAmiId': (<class 'str'>, False),'EbsConfiguration': (<class 'troposphere.emr.EbsConfiguration'>, False),'InstanceCount': (<function integer>, True), 'InstanceType': (<class 'str'>,True), 'Market': (<function market_validator>, False), 'Name': (<class 'str'>,False)}

class troposphere.emr.InstanceTypeConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InstanceTypeConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BidPrice': (<class 'str'>, False), 'BidPriceAsPercentageOfOnDemandPrice':(<function double>, False), 'Configurations': ([<class'troposphere.emr.Configuration'>], False), 'CustomAmiId': (<class 'str'>, False),'EbsConfiguration': (<class 'troposphere.emr.EbsConfiguration'>, False),'InstanceType': (<class 'str'>, True), 'WeightedCapacity': (<function integer>,False)}

7.3. troposphere 345

Page 350: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.emr.JobFlowInstancesConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

JobFlowInstancesConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AdditionalMasterSecurityGroups': ([<class 'str'>], False),'AdditionalSlaveSecurityGroups': ([<class 'str'>], False), 'CoreInstanceFleet':(<class 'troposphere.emr.InstanceFleetConfigProperty'>, False), 'CoreInstanceGroup':(<class 'troposphere.emr.InstanceGroupConfigProperty'>, False), 'Ec2KeyName':(<class 'str'>, False), 'Ec2SubnetId': (<class 'str'>, False), 'Ec2SubnetIds':([<class 'str'>], False), 'EmrManagedMasterSecurityGroup': (<class 'str'>, False),'EmrManagedSlaveSecurityGroup': (<class 'str'>, False), 'HadoopVersion': (<class'str'>, False), 'KeepJobFlowAliveWhenNoSteps': (<function boolean>, False),'MasterInstanceFleet': (<class 'troposphere.emr.InstanceFleetConfigProperty'>,False), 'MasterInstanceGroup': (<class'troposphere.emr.InstanceGroupConfigProperty'>, False), 'Placement': (<class'troposphere.emr.PlacementType'>, False), 'ServiceAccessSecurityGroup': (<class'str'>, False), 'TaskInstanceFleets': ([<class'troposphere.emr.InstanceFleetConfigProperty'>], False), 'TaskInstanceGroup':([<class 'troposphere.emr.InstanceGroupConfigProperty'>], False),'TerminationProtected': (<function boolean>, False)}

class troposphere.emr.KerberosAttributes(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KerberosAttributes

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ADDomainJoinPassword': (<class 'str'>, False), 'ADDomainJoinUser': (<class'str'>, False), 'CrossRealmTrustPrincipalPassword': (<class 'str'>, False),'KdcAdminPassword': (<class 'str'>, True), 'Realm': (<class 'str'>, True)}

class troposphere.emr.ManagedScalingPolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ManagedScalingPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComputeLimits': (<class 'troposphere.emr.ComputeLimits'>, False)}

class troposphere.emr.OnDemandProvisioningSpecification(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

OnDemandProvisioningSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllocationStrategy': (<class 'str'>, True)}

validate()

class troposphere.emr.PlacementType(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PlacementType

346 Chapter 7. Licensing

Page 351: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AvailabilityZone': (<class 'str'>, True)}

class troposphere.emr.ScalingAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ScalingAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Market': (<function market_validator>, False),'SimpleScalingPolicyConfiguration': (<class'troposphere.emr.SimpleScalingPolicyConfiguration'>, True)}

class troposphere.emr.ScalingConstraints(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ScalingConstraints

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxCapacity': (<function integer>, True), 'MinCapacity': (<function integer>,True)}

class troposphere.emr.ScalingRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ScalingRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Action': (<class 'troposphere.emr.ScalingAction'>, True), 'Description': (<class'str'>, False), 'Name': (<class 'str'>, True), 'Trigger': (<class'troposphere.emr.ScalingTrigger'>, True)}

class troposphere.emr.ScalingTrigger(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ScalingTrigger

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudWatchAlarmDefinition': (<class 'troposphere.emr.CloudWatchAlarmDefinition'>,True)}

class troposphere.emr.ScriptBootstrapActionConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ScriptBootstrapActionConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Args': ([<class 'str'>], False), 'Path': (<class 'str'>, True)}

class troposphere.emr.SecurityConfiguration(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

SecurityConfiguration

7.3. troposphere 347

Page 352: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'SecurityConfiguration': (<class 'dict'>, True)}

resource_type: Optional[str] = 'AWS::EMR::SecurityConfiguration'

class troposphere.emr.SimpleScalingPolicyConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SimpleScalingPolicyConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AdjustmentType': (<class 'str'>, False), 'CoolDown': (<function integer>,False), 'ScalingAdjustment': (<function validate_defer>, True)}

validate()

class troposphere.emr.SpotProvisioningSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SpotProvisioningSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllocationStrategy': (<class 'str'>, False), 'BlockDurationMinutes': (<functioninteger>, False), 'TimeoutAction': (<class 'str'>, True), 'TimeoutDurationMinutes':(<function integer>, True)}

validate()

class troposphere.emr.Step(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Step

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ActionOnFailure': (<function action_on_failure_validator>, True),'HadoopJarStep': (<class 'troposphere.emr.HadoopJarStepConfig'>, True),'JobFlowId': (<class 'str'>, True), 'Name': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EMR::Step'

class troposphere.emr.StepConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

StepConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ActionOnFailure': (<class 'str'>, False), 'HadoopJarStep': (<class'troposphere.emr.HadoopJarStepConfig'>, True), 'Name': (<class 'str'>, True)}

class troposphere.emr.Studio(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Studio

348 Chapter 7. Licensing

Page 353: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthMode': (<class 'str'>, True), 'DefaultS3Location': (<class 'str'>, True),'Description': (<class 'str'>, False), 'EngineSecurityGroupId': (<class 'str'>,True), 'IdpAuthUrl': (<class 'str'>, False), 'IdpRelayStateParameterName': (<class'str'>, False), 'Name': (<class 'str'>, True), 'ServiceRole': (<class 'str'>,True), 'SubnetIds': ([<class 'str'>], True), 'Tags': (<class 'troposphere.Tags'>,False), 'UserRole': (<class 'str'>, False), 'VpcId': (<class 'str'>, True),'WorkspaceSecurityGroupId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EMR::Studio'

class troposphere.emr.StudioSessionMapping(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

StudioSessionMapping

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'IdentityName': (<class 'str'>, True), 'IdentityType': (<class 'str'>, True),'SessionPolicyArn': (<class 'str'>, True), 'StudioId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EMR::StudioSessionMapping'

class troposphere.emr.VolumeSpecification(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VolumeSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Iops': (<function integer>, False), 'SizeInGB': (<function integer>, True),'VolumeType': (<function volume_type_validator>, True)}

troposphere.emrcontainers module

class troposphere.emrcontainers.ContainerInfo(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ContainerInfo

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EksInfo': (<class 'troposphere.emrcontainers.EksInfo'>, True)}

class troposphere.emrcontainers.ContainerProvider(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ContainerProvider

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Id':(<class 'str'>, True), 'Info': (<class 'troposphere.emrcontainers.ContainerInfo'>,True), 'Type': (<class 'str'>, True)}

class troposphere.emrcontainers.EksInfo(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 349

Page 354: Release 3.1

troposphere Documentation, Release 4.0.1

EksInfo

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Namespace': (<class 'str'>, True)}

class troposphere.emrcontainers.VirtualCluster(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VirtualCluster

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContainerProvider': (<class 'troposphere.emrcontainers.ContainerProvider'>,True), 'Name': (<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::EMRContainers::VirtualCluster'

troposphere.events module

class troposphere.events.ApiDestination(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ApiDestination

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectionArn': (<class 'str'>, True), 'Description': (<class 'str'>, False),'HttpMethod': (<class 'str'>, True), 'InvocationEndpoint': (<class 'str'>, True),'InvocationRateLimitPerSecond': (<function integer>, False), 'Name': (<class'str'>, False)}

resource_type: Optional[str] = 'AWS::Events::ApiDestination'

class troposphere.events.ApiKeyAuthParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ApiKeyAuthParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiKeyName': (<class 'str'>, True), 'ApiKeyValue': (<class 'str'>, True)}

class troposphere.events.Archive(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Archive

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ArchiveName': (<class 'str'>, False), 'Description': (<class 'str'>, False),'EventPattern': (<class 'dict'>, False), 'RetentionDays': (<function integer>,False), 'SourceArn': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::Events::Archive'

350 Chapter 7. Licensing

Page 355: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.events.AuthParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AuthParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApiKeyAuthParameters': (<class 'troposphere.events.ApiKeyAuthParameters'>,False), 'BasicAuthParameters': (<class 'troposphere.events.BasicAuthParameters'>,False), 'InvocationHttpParameters': (<class'troposphere.events.ConnectionHttpParameters'>, False), 'OAuthParameters': (<class'troposphere.events.OAuthParameters'>, False)}

class troposphere.events.AwsVpcConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AwsVpcConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssignPublicIp': (<class 'str'>, False), 'SecurityGroups': ([<class 'str'>],False), 'Subnets': ([<class 'str'>], True)}

class troposphere.events.BasicAuthParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BasicAuthParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Password': (<class 'str'>, True), 'Username': (<class 'str'>, True)}

class troposphere.events.BatchArrayProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BatchArrayProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Size': (<function integer>, False)}

class troposphere.events.BatchParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BatchParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ArrayProperties': (<class 'troposphere.events.BatchArrayProperties'>, False),'JobDefinition': (<class 'str'>, True), 'JobName': (<class 'str'>, True),'RetryStrategy': (<class 'troposphere.events.BatchRetryStrategy'>, False)}

class troposphere.events.BatchRetryStrategy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BatchRetryStrategy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Attempts': (<function integer>, False)}

7.3. troposphere 351

Page 356: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.events.CapacityProviderStrategyItem(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CapacityProviderStrategyItem

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Base': (<function integer>, False), 'CapacityProvider': (<class 'str'>, True),'Weight': (<function integer>, False)}

class troposphere.events.ClientParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ClientParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClientID': (<class 'str'>, True), 'ClientSecret': (<class 'str'>, True)}

class troposphere.events.Condition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Condition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, False), 'Type': (<class 'str'>, False), 'Value': (<class 'str'>,False)}

class troposphere.events.Connection(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Connection

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthParameters': (<class 'troposphere.events.AuthParameters'>, True),'AuthorizationType': (<class 'str'>, True), 'Description': (<class 'str'>, False),'Name': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::Events::Connection'

class troposphere.events.ConnectionHttpParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConnectionHttpParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BodyParameters': ([<class 'troposphere.events.Parameter'>], False),'HeaderParameters': ([<class 'troposphere.events.Parameter'>], False),'QueryStringParameters': ([<class 'troposphere.events.Parameter'>], False)}

class troposphere.events.DeadLetterConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DeadLetterConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Arn':(<class 'str'>, False)}

352 Chapter 7. Licensing

Page 357: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.events.EcsParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EcsParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CapacityProviderStrategy': ([<class'troposphere.events.CapacityProviderStrategyItem'>], False), 'EnableECSManagedTags':(<function boolean>, False), 'EnableExecuteCommand': (<function boolean>, False),'Group': (<class 'str'>, False), 'LaunchType': (<class 'str'>, False),'NetworkConfiguration': (<class 'troposphere.events.NetworkConfiguration'>, False),'PlacementConstraints': ([<class 'troposphere.events.PlacementConstraint'>],False), 'PlacementStrategies': ([<class 'troposphere.events.PlacementStrategy'>],False), 'PlatformVersion': (<class 'str'>, False), 'PropagateTags': (<class'str'>, False), 'ReferenceId': (<class 'str'>, False), 'TagList': (<class'troposphere.Tags'>, False), 'TaskCount': (<function integer>, False),'TaskDefinitionArn': (<class 'str'>, True)}

class troposphere.events.Endpoint(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Endpoint

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'EventBuses': ([<class'troposphere.events.EndpointEventBus'>], True), 'Name': (<class 'str'>, True),'ReplicationConfig': (<class 'troposphere.events.ReplicationConfig'>, False),'RoleArn': (<class 'str'>, False), 'RoutingConfig': (<class'troposphere.events.RoutingConfig'>, True)}

resource_type: Optional[str] = 'AWS::Events::Endpoint'

class troposphere.events.EndpointEventBus(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EndpointEventBus

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EventBusArn': (<class 'str'>, True)}

class troposphere.events.EventBus(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

EventBus

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EventSourceName': (<class 'str'>, False), 'Name': (<class 'str'>, True), 'Tags':(<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::Events::EventBus'

class troposphere.events.EventBusPolicy(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

7.3. troposphere 353

Page 358: Release 3.1

troposphere Documentation, Release 4.0.1

EventBusPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Action': (<class 'str'>, False), 'Condition': (<class'troposphere.events.Condition'>, False), 'EventBusName': (<class 'str'>, False),'Principal': (<class 'str'>, False), 'Statement': (<class 'dict'>, False),'StatementId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::Events::EventBusPolicy'

class troposphere.events.FailoverConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FailoverConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Primary': (<class 'troposphere.events.Primary'>, True), 'Secondary': (<class'troposphere.events.Secondary'>, True)}

class troposphere.events.HttpParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HeaderParameters': (<class 'dict'>, False), 'PathParameterValues': ([<class'str'>], False), 'QueryStringParameters': (<class 'dict'>, False)}

class troposphere.events.InputTransformer(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InputTransformer

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InputPathsMap': (<class 'dict'>, False), 'InputTemplate': (<class 'str'>, True)}

class troposphere.events.KinesisParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KinesisParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PartitionKeyPath': (<class 'str'>, True)}

class troposphere.events.NetworkConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NetworkConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AwsVpcConfiguration': (<class 'troposphere.events.AwsVpcConfiguration'>, False)}

class troposphere.events.OAuthParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OAuthParameters

354 Chapter 7. Licensing

Page 359: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthorizationEndpoint': (<class 'str'>, True), 'ClientParameters': (<class'troposphere.events.ClientParameters'>, True), 'HttpMethod': (<class 'str'>, True),'OAuthHttpParameters': (<class 'troposphere.events.ConnectionHttpParameters'>,False)}

class troposphere.events.Parameter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Parameter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'IsValueSecret': (<function boolean>, False), 'Key': (<class 'str'>, True),'Value': (<class 'str'>, True)}

class troposphere.events.PlacementConstraint(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PlacementConstraint

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Expression': (<class 'str'>, False), 'Type': (<class 'str'>, False)}

class troposphere.events.PlacementStrategy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PlacementStrategy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Field': (<class 'str'>, False), 'Type': (<class 'str'>, False)}

class troposphere.events.Primary(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Primary

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HealthCheck': (<class 'str'>, True)}

class troposphere.events.RedshiftDataParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RedshiftDataParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Database': (<class 'str'>, True), 'DbUser': (<class 'str'>, False),'SecretManagerArn': (<class 'str'>, False), 'Sql': (<class 'str'>, True),'StatementName': (<class 'str'>, False), 'WithEvent': (<function boolean>, False)}

class troposphere.events.ReplicationConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ReplicationConfig

7.3. troposphere 355

Page 360: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'State': (<class 'str'>, True)}

class troposphere.events.RetryPolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RetryPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaximumEventAgeInSeconds': (<function integer>, False), 'MaximumRetryAttempts':(<function integer>, False)}

class troposphere.events.RoutingConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RoutingConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FailoverConfig': (<class 'troposphere.events.FailoverConfig'>, True)}

class troposphere.events.Rule(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Rule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'EventBusName': (<class 'str'>, False),'EventPattern': (<class 'dict'>, False), 'Name': (<class 'str'>, False),'RoleArn': (<class 'str'>, False), 'ScheduleExpression': (<class 'str'>, False),'State': (<class 'str'>, False), 'Targets': ([<class'troposphere.events.Target'>], False)}

resource_type: Optional[str] = 'AWS::Events::Rule'

class troposphere.events.RunCommandParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RunCommandParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RunCommandTargets': ([<class 'troposphere.events.RunCommandTarget'>], True)}

class troposphere.events.RunCommandTarget(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RunCommandTarget

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, True), 'Values': ([<class 'str'>], True)}

class troposphere.events.SageMakerPipelineParameter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SageMakerPipelineParameter

356 Chapter 7. Licensing

Page 361: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.events.SageMakerPipelineParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SageMakerPipelineParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PipelineParameterList': ([<class'troposphere.events.SageMakerPipelineParameter'>], False)}

class troposphere.events.Secondary(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Secondary

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Route': (<class 'str'>, True)}

class troposphere.events.SqsParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SqsParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MessageGroupId': (<class 'str'>, True)}

class troposphere.events.Target(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Target

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Arn':(<class 'str'>, True), 'BatchParameters': (<class'troposphere.events.BatchParameters'>, False), 'DeadLetterConfig': (<class'troposphere.events.DeadLetterConfig'>, False), 'EcsParameters': (<class'troposphere.events.EcsParameters'>, False), 'HttpParameters': (<class'troposphere.events.HttpParameters'>, False), 'Id': (<class 'str'>, True), 'Input':(<class 'str'>, False), 'InputPath': (<class 'str'>, False), 'InputTransformer':(<class 'troposphere.events.InputTransformer'>, False), 'KinesisParameters':(<class 'troposphere.events.KinesisParameters'>, False), 'RedshiftDataParameters':(<class 'troposphere.events.RedshiftDataParameters'>, False), 'RetryPolicy':(<class 'troposphere.events.RetryPolicy'>, False), 'RoleArn': (<class 'str'>,False), 'RunCommandParameters': (<class 'troposphere.events.RunCommandParameters'>,False), 'SageMakerPipelineParameters': (<class'troposphere.events.SageMakerPipelineParameters'>, False), 'SqsParameters': (<class'troposphere.events.SqsParameters'>, False)}

7.3. troposphere 357

Page 362: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.eventschemas module

class troposphere.eventschemas.Discoverer(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

Discoverer

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CrossAccount': (<function boolean>, False), 'Description': (<class 'str'>,False), 'SourceArn': (<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>,False)}

resource_type: Optional[str] = 'AWS::EventSchemas::Discoverer'

class troposphere.eventschemas.Registry(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Registry

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'RegistryName': (<class 'str'>, False),'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::EventSchemas::Registry'

class troposphere.eventschemas.RegistryPolicy(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

RegistryPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Policy': (<class 'dict'>, True), 'RegistryName': (<class 'str'>, True),'RevisionId': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::EventSchemas::RegistryPolicy'

class troposphere.eventschemas.Schema(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Schema

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Content': (<class 'str'>, True), 'Description': (<class 'str'>, False),'RegistryName': (<class 'str'>, True), 'SchemaName': (<class 'str'>, False),'Tags': (<class 'troposphere.Tags'>, False), 'Type': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::EventSchemas::Schema'

358 Chapter 7. Licensing

Page 363: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.finspace module

class troposphere.finspace.Environment(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Environment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DataBundles': ([<class 'str'>], False), 'Description': (<class 'str'>, False),'FederationMode': (<class 'str'>, False), 'FederationParameters': (<class'troposphere.finspace.FederationParameters'>, False), 'KmsKeyId': (<class 'str'>,False), 'Name': (<class 'str'>, True), 'SuperuserParameters': (<class'troposphere.finspace.SuperuserParameters'>, False)}

resource_type: Optional[str] = 'AWS::FinSpace::Environment'

class troposphere.finspace.FederationParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FederationParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationCallBackURL': (<class 'str'>, False), 'AttributeMap': (<class 'dict'>,False), 'FederationProviderName': (<class 'str'>, False), 'FederationURN': (<class'str'>, False), 'SamlMetadataDocument': (<class 'str'>, False), 'SamlMetadataURL':(<class 'str'>, False)}

class troposphere.finspace.SuperuserParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SuperuserParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EmailAddress': (<class 'str'>, False), 'FirstName': (<class 'str'>, False),'LastName': (<class 'str'>, False)}

troposphere.firehose module

class troposphere.firehose.AmazonopensearchserviceBufferingHints(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

AmazonopensearchserviceBufferingHints

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'IntervalInSeconds': (<function integer>, False), 'SizeInMBs': (<functioninteger>, False)}

class troposphere.firehose.AmazonopensearchserviceDestinationConfiguration(title: Optional[str]= None,**kwargs: Any)

Bases: troposphere.AWSProperty

AmazonopensearchserviceDestinationConfiguration

7.3. troposphere 359

Page 364: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BufferingHints': (<class'troposphere.firehose.AmazonopensearchserviceBufferingHints'>, False),'CloudWatchLoggingOptions': (<class'troposphere.firehose.CloudWatchLoggingOptions'>, False), 'ClusterEndpoint':(<class 'str'>, False), 'DomainARN': (<class 'str'>, False), 'IndexName': (<class'str'>, True), 'IndexRotationPeriod': (<class 'str'>, False),'ProcessingConfiguration': (<class 'troposphere.firehose.ProcessingConfiguration'>,False), 'RetryOptions': (<class'troposphere.firehose.AmazonopensearchserviceRetryOptions'>, False), 'RoleARN':(<class 'str'>, True), 'S3BackupMode': (<class 'str'>, False), 'S3Configuration':(<class 'troposphere.firehose.S3DestinationConfiguration'>, True), 'TypeName':(<class 'str'>, False), 'VpcConfiguration': (<class'troposphere.firehose.VpcConfiguration'>, False)}

class troposphere.firehose.AmazonopensearchserviceRetryOptions(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

AmazonopensearchserviceRetryOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DurationInSeconds': (<function integer>, False)}

class troposphere.firehose.BufferingHints(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BufferingHints

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'IntervalInSeconds': (<function integer>, False), 'SizeInMBs': (<functioninteger>, False)}

class troposphere.firehose.CloudWatchLoggingOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CloudWatchLoggingOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False), 'LogGroupName': (<class 'str'>, False),'LogStreamName': (<class 'str'>, False)}

class troposphere.firehose.CopyCommand(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CopyCommand

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CopyOptions': (<class 'str'>, False), 'DataTableColumns': (<class 'str'>,False), 'DataTableName': (<class 'str'>, True)}

class troposphere.firehose.DataFormatConversionConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

DataFormatConversionConfiguration

360 Chapter 7. Licensing

Page 365: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False), 'InputFormatConfiguration': (<class'troposphere.firehose.InputFormatConfiguration'>, False),'OutputFormatConfiguration': (<class'troposphere.firehose.OutputFormatConfiguration'>, False), 'SchemaConfiguration':(<class 'troposphere.firehose.SchemaConfiguration'>, False)}

class troposphere.firehose.DeliveryStream(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

DeliveryStream

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AmazonopensearchserviceDestinationConfiguration': (<class'troposphere.firehose.AmazonopensearchserviceDestinationConfiguration'>, False),'DeliveryStreamEncryptionConfigurationInput': (<class'troposphere.firehose.DeliveryStreamEncryptionConfigurationInput'>, False),'DeliveryStreamName': (<class 'str'>, False), 'DeliveryStreamType': (<functiondelivery_stream_type_validator>, False), 'ElasticsearchDestinationConfiguration':(<class 'troposphere.firehose.ElasticsearchDestinationConfiguration'>, False),'ExtendedS3DestinationConfiguration': (<class'troposphere.firehose.ExtendedS3DestinationConfiguration'>, False),'HttpEndpointDestinationConfiguration': (<class'troposphere.firehose.HttpEndpointDestinationConfiguration'>, False),'KinesisStreamSourceConfiguration': (<class'troposphere.firehose.KinesisStreamSourceConfiguration'>, False),'RedshiftDestinationConfiguration': (<class'troposphere.firehose.RedshiftDestinationConfiguration'>, False),'S3DestinationConfiguration': (<class'troposphere.firehose.S3DestinationConfiguration'>, False),'SplunkDestinationConfiguration': (<class'troposphere.firehose.SplunkDestinationConfiguration'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::KinesisFirehose::DeliveryStream'

class troposphere.firehose.DeliveryStreamEncryptionConfigurationInput(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

DeliveryStreamEncryptionConfigurationInput

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KeyARN': (<class 'str'>, False), 'KeyType': (<class 'str'>, True)}

class troposphere.firehose.Deserializer(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Deserializer

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HiveJsonSerDe': (<class 'troposphere.firehose.HiveJsonSerDe'>, False),'OpenXJsonSerDe': (<class 'troposphere.firehose.OpenXJsonSerDe'>, False)}

7.3. troposphere 361

Page 366: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.firehose.DynamicPartitioningConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

DynamicPartitioningConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False), 'RetryOptions': (<class'troposphere.firehose.RetryOptions'>, False)}

class troposphere.firehose.ElasticsearchDestinationConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ElasticsearchDestinationConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BufferingHints': (<class 'troposphere.firehose.BufferingHints'>, False),'CloudWatchLoggingOptions': (<class'troposphere.firehose.CloudWatchLoggingOptions'>, False), 'ClusterEndpoint':(<class 'str'>, False), 'DomainARN': (<class 'str'>, False), 'IndexName': (<class'str'>, True), 'IndexRotationPeriod': (<function index_rotation_period_validator>,False), 'ProcessingConfiguration': (<class'troposphere.firehose.ProcessingConfiguration'>, False), 'RetryOptions': (<class'troposphere.firehose.RetryOptions'>, False), 'RoleARN': (<class 'str'>, True),'S3BackupMode': (<function s3_backup_mode_elastic_search_validator>, False),'S3Configuration': (<class 'troposphere.firehose.S3Configuration'>, True),'TypeName': (<class 'str'>, False), 'VpcConfiguration': (<class'troposphere.firehose.VpcConfiguration'>, False)}

class troposphere.firehose.EncryptionConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EncryptionConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KMSEncryptionConfig': (<class 'troposphere.firehose.KMSEncryptionConfig'>,False), 'NoEncryptionConfig': (<class 'str'>, False)}

class troposphere.firehose.ExtendedS3DestinationConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ExtendedS3DestinationConfiguration

362 Chapter 7. Licensing

Page 367: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketARN': (<class 'str'>, True), 'BufferingHints': (<class'troposphere.firehose.BufferingHints'>, False), 'CloudWatchLoggingOptions': (<class'troposphere.firehose.CloudWatchLoggingOptions'>, False), 'CompressionFormat':(<class 'str'>, False), 'DataFormatConversionConfiguration': (<class'troposphere.firehose.DataFormatConversionConfiguration'>, False),'DynamicPartitioningConfiguration': (<class'troposphere.firehose.DynamicPartitioningConfiguration'>, False),'EncryptionConfiguration': (<class 'troposphere.firehose.EncryptionConfiguration'>,False), 'ErrorOutputPrefix': (<class 'str'>, False), 'Prefix': (<class 'str'>,False), 'ProcessingConfiguration': (<class'troposphere.firehose.ProcessingConfiguration'>, False), 'RoleARN': (<class 'str'>,True), 'S3BackupConfiguration': (<class'troposphere.firehose.S3DestinationConfiguration'>, False), 'S3BackupMode':(<function s3_backup_mode_extended_s3_validator>, False)}

class troposphere.firehose.HiveJsonSerDe(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HiveJsonSerDe

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TimestampFormats': ([<class 'str'>], False)}

class troposphere.firehose.HttpEndpointCommonAttribute(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpEndpointCommonAttribute

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AttributeName': (<class 'str'>, True), 'AttributeValue': (<class 'str'>, True)}

class troposphere.firehose.HttpEndpointConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpEndpointConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessKey': (<class 'str'>, False), 'Name': (<class 'str'>, False), 'Url':(<class 'str'>, True)}

class troposphere.firehose.HttpEndpointDestinationConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

HttpEndpointDestinationConfiguration

7.3. troposphere 363

Page 368: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BufferingHints': (<class 'troposphere.firehose.BufferingHints'>, False),'CloudWatchLoggingOptions': (<class'troposphere.firehose.CloudWatchLoggingOptions'>, False), 'EndpointConfiguration':(<class 'troposphere.firehose.HttpEndpointConfiguration'>, True),'ProcessingConfiguration': (<class 'troposphere.firehose.ProcessingConfiguration'>,False), 'RequestConfiguration': (<class'troposphere.firehose.HttpEndpointRequestConfiguration'>, False), 'RetryOptions':(<class 'troposphere.firehose.RetryOptions'>, False), 'RoleARN': (<class 'str'>,False), 'S3BackupMode': (<class 'str'>, False), 'S3Configuration': (<class'troposphere.firehose.S3DestinationConfiguration'>, True)}

class troposphere.firehose.HttpEndpointRequestConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

HttpEndpointRequestConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CommonAttributes': ([<class 'troposphere.firehose.HttpEndpointCommonAttribute'>],False), 'ContentEncoding': (<class 'str'>, False)}

class troposphere.firehose.InputFormatConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InputFormatConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Deserializer': (<class 'troposphere.firehose.Deserializer'>, False)}

class troposphere.firehose.KMSEncryptionConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KMSEncryptionConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AWSKMSKeyARN': (<class 'str'>, True)}

class troposphere.firehose.KinesisStreamSourceConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

KinesisStreamSourceConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KinesisStreamARN': (<class 'str'>, True), 'RoleARN': (<class 'str'>, True)}

class troposphere.firehose.OpenXJsonSerDe(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OpenXJsonSerDe

364 Chapter 7. Licensing

Page 369: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CaseInsensitive': (<function boolean>, False), 'ColumnToJsonKeyMappings':(<class 'dict'>, False), 'ConvertDotsInJsonKeysToUnderscores': (<function boolean>,False)}

class troposphere.firehose.OrcSerDe(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OrcSerDe

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BlockSizeBytes': (<function integer>, False), 'BloomFilterColumns': ([<class'str'>], False), 'BloomFilterFalsePositiveProbability': (<function double>, False),'Compression': (<class 'str'>, False), 'DictionaryKeyThreshold': (<functiondouble>, False), 'EnablePadding': (<function boolean>, False), 'FormatVersion':(<class 'str'>, False), 'PaddingTolerance': (<function double>, False),'RowIndexStride': (<function integer>, False), 'StripeSizeBytes': (<functioninteger>, False)}

class troposphere.firehose.OutputFormatConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OutputFormatConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Serializer': (<class 'troposphere.firehose.Serializer'>, False)}

class troposphere.firehose.ParquetSerDe(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ParquetSerDe

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BlockSizeBytes': (<function integer>, False), 'Compression': (<class 'str'>,False), 'EnableDictionaryCompression': (<function boolean>, False),'MaxPaddingBytes': (<function integer>, False), 'PageSizeBytes': (<functioninteger>, False), 'WriterVersion': (<class 'str'>, False)}

class troposphere.firehose.ProcessingConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ProcessingConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False), 'Processors': ([<class'troposphere.firehose.Processor'>], False)}

class troposphere.firehose.Processor(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Processor

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Parameters': ([<class 'troposphere.firehose.ProcessorParameter'>], False),'Type': (<function processor_type_validator>, True)}

7.3. troposphere 365

Page 370: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.firehose.ProcessorParameter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ProcessorParameter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ParameterName': (<class 'str'>, True), 'ParameterValue': (<class 'str'>, True)}

class troposphere.firehose.RedshiftDestinationConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

RedshiftDestinationConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudWatchLoggingOptions': (<class'troposphere.firehose.CloudWatchLoggingOptions'>, False), 'ClusterJDBCURL': (<class'str'>, True), 'CopyCommand': (<class 'troposphere.firehose.CopyCommand'>, True),'Password': (<class 'str'>, True), 'ProcessingConfiguration': (<class'troposphere.firehose.ProcessingConfiguration'>, False), 'RetryOptions': (<class'troposphere.firehose.RedshiftRetryOptions'>, False), 'RoleARN': (<class 'str'>,True), 'S3BackupConfiguration': (<class'troposphere.firehose.S3DestinationConfiguration'>, False), 'S3BackupMode': (<class'str'>, False), 'S3Configuration': (<class 'troposphere.firehose.S3Configuration'>,True), 'Username': (<class 'str'>, True)}

class troposphere.firehose.RedshiftRetryOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RedshiftRetryOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DurationInSeconds': (<function integer>, False)}

class troposphere.firehose.RetryOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RetryOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DurationInSeconds': (<function integer>, False)}

class troposphere.firehose.S3Configuration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3Configuration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketARN': (<class 'str'>, True), 'BufferingHints': (<class'troposphere.firehose.BufferingHints'>, False), 'CloudWatchLoggingOptions': (<class'troposphere.firehose.CloudWatchLoggingOptions'>, False), 'CompressionFormat':(<class 'str'>, False), 'EncryptionConfiguration': (<class'troposphere.firehose.EncryptionConfiguration'>, False), 'ErrorOutputPrefix':(<class 'str'>, False), 'Prefix': (<class 'str'>, False), 'RoleARN': (<class'str'>, True)}

366 Chapter 7. Licensing

Page 371: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.firehose.S3DestinationConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3DestinationConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketARN': (<class 'str'>, True), 'BufferingHints': (<class'troposphere.firehose.BufferingHints'>, False), 'CloudWatchLoggingOptions': (<class'troposphere.firehose.CloudWatchLoggingOptions'>, False), 'CompressionFormat':(<class 'str'>, False), 'EncryptionConfiguration': (<class'troposphere.firehose.EncryptionConfiguration'>, False), 'ErrorOutputPrefix':(<class 'str'>, False), 'Prefix': (<class 'str'>, False), 'RoleARN': (<class'str'>, True)}

class troposphere.firehose.SchemaConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SchemaConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CatalogId': (<class 'str'>, False), 'DatabaseName': (<class 'str'>, False),'Region': (<class 'str'>, False), 'RoleARN': (<class 'str'>, False), 'TableName':(<class 'str'>, False), 'VersionId': (<class 'str'>, False)}

class troposphere.firehose.Serializer(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Serializer

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'OrcSerDe': (<class 'troposphere.firehose.OrcSerDe'>, False), 'ParquetSerDe':(<class 'troposphere.firehose.ParquetSerDe'>, False)}

class troposphere.firehose.SplunkDestinationConfiguration(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

SplunkDestinationConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudWatchLoggingOptions': (<class'troposphere.firehose.CloudWatchLoggingOptions'>, False),'HECAcknowledgmentTimeoutInSeconds': (<function integer>, False), 'HECEndpoint':(<class 'str'>, True), 'HECEndpointType': (<class 'str'>, True), 'HECToken':(<class 'str'>, True), 'ProcessingConfiguration': (<class'troposphere.firehose.ProcessingConfiguration'>, False), 'RetryOptions': (<class'troposphere.firehose.SplunkRetryOptions'>, False), 'S3BackupMode': (<class 'str'>,False), 'S3Configuration': (<class'troposphere.firehose.S3DestinationConfiguration'>, True)}

class troposphere.firehose.SplunkRetryOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SplunkRetryOptions

7.3. troposphere 367

Page 372: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DurationInSeconds': (<function integer>, False)}

class troposphere.firehose.VpcConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VpcConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RoleARN': (<class 'str'>, True), 'SecurityGroupIds': ([<class 'str'>], True),'SubnetIds': ([<class 'str'>], True)}

troposphere.fis module

class troposphere.fis.ExperimentTemplate(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ExperimentTemplate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Actions': (<class 'dict'>, False), 'Description': (<class 'str'>, True),'LogConfiguration': (<class 'troposphere.fis.ExperimentTemplateLogConfiguration'>,False), 'RoleArn': (<class 'str'>, True), 'StopConditions': ([<class'troposphere.fis.ExperimentTemplateStopCondition'>], True), 'Tags': (<class'dict'>, True), 'Targets': (<class 'dict'>, True)}

resource_type: Optional[str] = 'AWS::FIS::ExperimentTemplate'

class troposphere.fis.ExperimentTemplateAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ExperimentTemplateAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ActionId': (<class 'str'>, True), 'Description': (<class 'str'>, False),'Parameters': (<class 'dict'>, False), 'StartAfter': ([<class 'str'>], False),'Targets': (<class 'dict'>, False)}

class troposphere.fis.ExperimentTemplateLogConfiguration(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

ExperimentTemplateLogConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudWatchLogsConfiguration': (<class 'dict'>, False), 'LogSchemaVersion':(<function integer>, True), 'S3Configuration': (<class 'dict'>, False)}

class troposphere.fis.ExperimentTemplateStopCondition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ExperimentTemplateStopCondition

368 Chapter 7. Licensing

Page 373: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Source': (<class 'str'>, True), 'Value': (<class 'str'>, False)}

class troposphere.fis.ExperimentTemplateTarget(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ExperimentTemplateTarget

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Filters': ([<class 'troposphere.fis.ExperimentTemplateTargetFilter'>], False),'Parameters': (<class 'dict'>, False), 'ResourceArns': ([<class 'str'>], False),'ResourceTags': (<class 'dict'>, False), 'ResourceType': (<class 'str'>, True),'SelectionMode': (<class 'str'>, True)}

class troposphere.fis.ExperimentTemplateTargetFilter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ExperimentTemplateTargetFilter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Path': (<class 'str'>, True), 'Values': ([<class 'str'>], True)}

troposphere.fms module

class troposphere.fms.IEMap(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

IEMap

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ACCOUNT': ([<class 'str'>], False), 'ORGUNIT': ([<class 'str'>], False)}

class troposphere.fms.NotificationChannel(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

NotificationChannel

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SnsRoleName': (<class 'str'>, True), 'SnsTopicArn': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::FMS::NotificationChannel'

class troposphere.fms.Policy(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Policy

7.3. troposphere 369

Page 374: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeleteAllPolicyResources': (<function boolean>, False), 'ExcludeMap': (<class'troposphere.fms.IEMap'>, False), 'ExcludeResourceTags': (<function boolean>,True), 'IncludeMap': (<class 'troposphere.fms.IEMap'>, False), 'PolicyName':(<class 'str'>, True), 'RemediationEnabled': (<function boolean>, True),'ResourceTags': (<class 'troposphere.Tags'>, False), 'ResourceType': (<class'str'>, True), 'ResourceTypeList': ([<class 'str'>], False), 'ResourcesCleanUp':(<function boolean>, False), 'SecurityServicePolicyData': (<functionvalidate_json_checker>, True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::FMS::Policy'

troposphere.frauddetector module

class troposphere.frauddetector.Detector(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Detector

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssociatedModels': ([<class 'troposphere.frauddetector.Model'>], False),'Description': (<class 'str'>, False), 'DetectorId': (<class 'str'>, True),'DetectorVersionStatus': (<class 'str'>, False), 'EventType': (<class'troposphere.frauddetector.EventTypeProperty'>, True), 'RuleExecutionMode': (<class'str'>, False), 'Rules': ([<class 'troposphere.frauddetector.Rule'>], True),'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::FraudDetector::Detector'

class troposphere.frauddetector.EntityType(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

EntityType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'Name': (<class 'str'>, True), 'Tags':(<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::FraudDetector::EntityType'

class troposphere.frauddetector.EntityTypeProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EntityTypeProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Arn':(<class 'str'>, False), 'CreatedTime': (<class 'str'>, False), 'Description':(<class 'str'>, False), 'Inline': (<function boolean>, False), 'LastUpdatedTime':(<class 'str'>, False), 'Name': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

370 Chapter 7. Licensing

Page 375: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.frauddetector.EventType(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

EventType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'EntityTypes': ([<class'troposphere.frauddetector.EntityTypeProperty'>], True), 'EventVariables': ([<class'troposphere.frauddetector.EventVariable'>], True), 'Labels': ([<class'troposphere.frauddetector.LabelProperty'>], True), 'Name': (<class 'str'>, True),'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::FraudDetector::EventType'

class troposphere.frauddetector.EventTypeProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EventTypeProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Arn':(<class 'str'>, False), 'CreatedTime': (<class 'str'>, False), 'Description':(<class 'str'>, False), 'EntityTypes': ([<class'troposphere.frauddetector.EntityTypeProperty'>], False), 'EventVariables':([<class 'troposphere.frauddetector.EventVariable'>], False), 'Inline': (<functionboolean>, False), 'Labels': ([<class 'troposphere.frauddetector.LabelProperty'>],False), 'LastUpdatedTime': (<class 'str'>, False), 'Name': (<class 'str'>, False),'Tags': (<class 'troposphere.Tags'>, False)}

class troposphere.frauddetector.EventVariable(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EventVariable

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Arn':(<class 'str'>, False), 'CreatedTime': (<class 'str'>, False), 'DataSource':(<class 'str'>, False), 'DataType': (<class 'str'>, False), 'DefaultValue':(<class 'str'>, False), 'Description': (<class 'str'>, False), 'Inline':(<function boolean>, False), 'LastUpdatedTime': (<class 'str'>, False), 'Name':(<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>, False),'VariableType': (<class 'str'>, False)}

class troposphere.frauddetector.Label(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Label

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'Name': (<class 'str'>, True), 'Tags':(<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::FraudDetector::Label'

class troposphere.frauddetector.LabelProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 371

Page 376: Release 3.1

troposphere Documentation, Release 4.0.1

LabelProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Arn':(<class 'str'>, False), 'CreatedTime': (<class 'str'>, False), 'Description':(<class 'str'>, False), 'Inline': (<function boolean>, False), 'LastUpdatedTime':(<class 'str'>, False), 'Name': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

class troposphere.frauddetector.Model(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Model

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Arn':(<class 'str'>, False)}

class troposphere.frauddetector.Outcome(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Outcome

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'Name': (<class 'str'>, True), 'Tags':(<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::FraudDetector::Outcome'

class troposphere.frauddetector.OutcomeProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OutcomeProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Arn':(<class 'str'>, False), 'CreatedTime': (<class 'str'>, False), 'Description':(<class 'str'>, False), 'Inline': (<function boolean>, False), 'LastUpdatedTime':(<class 'str'>, False), 'Name': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

class troposphere.frauddetector.Rule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Rule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Arn':(<class 'str'>, False), 'CreatedTime': (<class 'str'>, False), 'Description':(<class 'str'>, False), 'DetectorId': (<class 'str'>, False), 'Expression':(<class 'str'>, False), 'Language': (<class 'str'>, False), 'LastUpdatedTime':(<class 'str'>, False), 'Outcomes': ([<class'troposphere.frauddetector.OutcomeProperty'>], False), 'RuleId': (<class 'str'>,False), 'RuleVersion': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

class troposphere.frauddetector.Variable(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

372 Chapter 7. Licensing

Page 377: Release 3.1

troposphere Documentation, Release 4.0.1

Variable

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DataSource': (<class 'str'>, True), 'DataType': (<class 'str'>, True),'DefaultValue': (<class 'str'>, True), 'Description': (<class 'str'>, False),'Name': (<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False),'VariableType': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::FraudDetector::Variable'

troposphere.fsx module

class troposphere.fsx.ActiveDirectoryConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ActiveDirectoryConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'NetBiosName': (<class 'str'>, False), 'SelfManagedActiveDirectoryConfiguration':(<class 'troposphere.fsx.SelfManagedActiveDirectoryConfiguration'>, False)}

class troposphere.fsx.AuditLogConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AuditLogConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuditLogDestination': (<class 'str'>, False), 'FileAccessAuditLogLevel': (<class'str'>, True), 'FileShareAccessAuditLogLevel': (<class 'str'>, True)}

class troposphere.fsx.ClientConfigurations(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ClientConfigurations

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Clients': (<class 'str'>, True), 'Options': ([<class 'str'>], True)}

class troposphere.fsx.DiskIopsConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DiskIopsConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Iops': (<function integer>, False), 'Mode': (<class 'str'>, False)}

class troposphere.fsx.FileSystem(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

FileSystem

7.3. troposphere 373

Page 378: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BackupId': (<class 'str'>, False), 'FileSystemType': (<class 'str'>, True),'FileSystemTypeVersion': (<class 'str'>, False), 'KmsKeyId': (<class 'str'>,False), 'LustreConfiguration': (<class 'troposphere.fsx.LustreConfiguration'>,False), 'OntapConfiguration': (<class 'troposphere.fsx.OntapConfiguration'>,False), 'OpenZFSConfiguration': (<class 'troposphere.fsx.OpenZFSConfiguration'>,False), 'SecurityGroupIds': ([<class 'str'>], False), 'StorageCapacity':(<function integer>, False), 'StorageType': (<function storage_type>, False),'SubnetIds': ([<class 'str'>], True), 'Tags': (<class 'troposphere.Tags'>, False),'WindowsConfiguration': (<class 'troposphere.fsx.WindowsConfiguration'>, False)}

resource_type: Optional[str] = 'AWS::FSx::FileSystem'

class troposphere.fsx.LustreConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LustreConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoImportPolicy': (<class 'str'>, False), 'AutomaticBackupRetentionDays':(<function integer>, False), 'CopyTagsToBackups': (<function boolean>, False),'DailyAutomaticBackupStartTime': (<class 'str'>, False), 'DataCompressionType':(<class 'str'>, False), 'DeploymentType': (<functionvalidate_lustreconfiguration_deploymenttype>, False), 'DriveCacheType': (<class'str'>, False), 'ExportPath': (<class 'str'>, False), 'ImportPath': (<class'str'>, False), 'ImportedFileChunkSize': (<function integer>, False),'PerUnitStorageThroughput': (<functionvalidate_lustreconfiguration_perunitstoragethroughput>, False),'WeeklyMaintenanceStartTime': (<class 'str'>, False)}

class troposphere.fsx.NfsExports(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NfsExports

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClientConfigurations': ([<class 'troposphere.fsx.ClientConfigurations'>], True)}

class troposphere.fsx.OntapConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OntapConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutomaticBackupRetentionDays': (<function integer>, False),'DailyAutomaticBackupStartTime': (<class 'str'>, False), 'DeploymentType': (<class'str'>, True), 'DiskIopsConfiguration': (<class'troposphere.fsx.DiskIopsConfiguration'>, False), 'EndpointIpAddressRange': (<class'str'>, False), 'FsxAdminPassword': (<class 'str'>, False), 'PreferredSubnetId':(<class 'str'>, False), 'RouteTableIds': ([<class 'str'>], False),'ThroughputCapacity': (<function integer>, False), 'WeeklyMaintenanceStartTime':(<class 'str'>, False)}

class troposphere.fsx.OpenZFSConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

374 Chapter 7. Licensing

Page 379: Release 3.1

troposphere Documentation, Release 4.0.1

OpenZFSConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutomaticBackupRetentionDays': (<function integer>, False), 'CopyTagsToBackups':(<function boolean>, False), 'CopyTagsToVolumes': (<function boolean>, False),'DailyAutomaticBackupStartTime': (<class 'str'>, False), 'DeploymentType': (<class'str'>, True), 'DiskIopsConfiguration': (<class'troposphere.fsx.DiskIopsConfiguration'>, False), 'Options': ([<class 'str'>],False), 'RootVolumeConfiguration': (<class'troposphere.fsx.RootVolumeConfiguration'>, False), 'ThroughputCapacity':(<function integer>, False), 'WeeklyMaintenanceStartTime': (<class 'str'>, False)}

class troposphere.fsx.OriginSnapshot(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OriginSnapshot

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CopyStrategy': (<class 'str'>, True), 'SnapshotARN': (<class 'str'>, True)}

class troposphere.fsx.RootVolumeConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RootVolumeConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CopyTagsToSnapshots': (<function boolean>, False), 'DataCompressionType':(<class 'str'>, False), 'NfsExports': ([<class 'troposphere.fsx.NfsExports'>],False), 'ReadOnly': (<function boolean>, False), 'RecordSizeKiB': (<functioninteger>, False), 'UserAndGroupQuotas': ([<class'troposphere.fsx.UserAndGroupQuotas'>], False)}

class troposphere.fsx.SelfManagedActiveDirectoryConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

SelfManagedActiveDirectoryConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DnsIps': ([<class 'str'>], False), 'DomainName': (<class 'str'>, False),'FileSystemAdministratorsGroup': (<class 'str'>, False),'OrganizationalUnitDistinguishedName': (<class 'str'>, False), 'Password': (<class'str'>, False), 'UserName': (<class 'str'>, False)}

class troposphere.fsx.Snapshot(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Snapshot

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False),'VolumeId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::FSx::Snapshot'

7.3. troposphere 375

Page 380: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.fsx.StorageVirtualMachine(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

StorageVirtualMachine

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ActiveDirectoryConfiguration': (<class'troposphere.fsx.ActiveDirectoryConfiguration'>, False), 'FileSystemId': (<class'str'>, True), 'Name': (<class 'str'>, True), 'RootVolumeSecurityStyle': (<class'str'>, False), 'SvmAdminPassword': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::FSx::StorageVirtualMachine'

class troposphere.fsx.TieringPolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TieringPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CoolingPeriod': (<function integer>, False), 'Name': (<class 'str'>, False)}

class troposphere.fsx.UserAndGroupQuotas(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

UserAndGroupQuotas

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Id':(<function integer>, True), 'StorageCapacityQuotaGiB': (<function integer>, True),'Type': (<class 'str'>, True)}

class troposphere.fsx.Volume(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Volume

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BackupId': (<class 'str'>, False), 'Name': (<class 'str'>, True),'OntapConfiguration': (<class 'troposphere.fsx.VolumeOntapConfiguration'>, False),'OpenZFSConfiguration': (<class 'troposphere.fsx.VolumeOpenZFSConfiguration'>,False), 'Tags': (<class 'troposphere.Tags'>, False), 'VolumeType': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::FSx::Volume'

class troposphere.fsx.VolumeOntapConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VolumeOntapConfiguration

376 Chapter 7. Licensing

Page 381: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'JunctionPath': (<class 'str'>, True), 'SecurityStyle': (<class 'str'>, False),'SizeInMegabytes': (<class 'str'>, True), 'StorageEfficiencyEnabled': (<class'str'>, True), 'StorageVirtualMachineId': (<class 'str'>, True), 'TieringPolicy':(<class 'troposphere.fsx.TieringPolicy'>, False)}

class troposphere.fsx.VolumeOpenZFSConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VolumeOpenZFSConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CopyTagsToSnapshots': (<function boolean>, False), 'DataCompressionType':(<class 'str'>, False), 'NfsExports': ([<class 'troposphere.fsx.NfsExports'>],False), 'Options': ([<class 'str'>], False), 'OriginSnapshot': (<class'troposphere.fsx.OriginSnapshot'>, False), 'ParentVolumeId': (<class 'str'>, True),'ReadOnly': (<function boolean>, False), 'RecordSizeKiB': (<function integer>,False), 'StorageCapacityQuotaGiB': (<function integer>, False),'StorageCapacityReservationGiB': (<function integer>, False), 'UserAndGroupQuotas':([<class 'troposphere.fsx.UserAndGroupQuotas'>], False)}

class troposphere.fsx.WindowsConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

WindowsConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ActiveDirectoryId': (<class 'str'>, False), 'Aliases': ([<class 'str'>], False),'AuditLogConfiguration': (<class 'troposphere.fsx.AuditLogConfiguration'>, False),'AutomaticBackupRetentionDays': (<function integer>, False), 'CopyTagsToBackups':(<function boolean>, False), 'DailyAutomaticBackupStartTime': (<class 'str'>,False), 'DeploymentType': (<class 'str'>, False), 'PreferredSubnetId': (<class'str'>, False), 'SelfManagedActiveDirectoryConfiguration': (<class'troposphere.fsx.SelfManagedActiveDirectoryConfiguration'>, False),'ThroughputCapacity': (<function integer>, True), 'WeeklyMaintenanceStartTime':(<class 'str'>, False)}

troposphere.gamelift module

class troposphere.gamelift.Alias(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Alias

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'Name': (<class 'str'>, True),'RoutingStrategy': (<class 'troposphere.gamelift.RoutingStrategy'>, True)}

resource_type: Optional[str] = 'AWS::GameLift::Alias'

class troposphere.gamelift.AutoScalingPolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 377

Page 382: Release 3.1

troposphere Documentation, Release 4.0.1

AutoScalingPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EstimatedInstanceWarmup': (<function double>, False),'TargetTrackingConfiguration': (<class'troposphere.gamelift.TargetTrackingConfiguration'>, True)}

class troposphere.gamelift.Build(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Build

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'OperatingSystem': (<class 'str'>, False),'StorageLocation': (<class 'troposphere.gamelift.S3Location'>, False), 'Version':(<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::GameLift::Build'

class troposphere.gamelift.CertificateConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CertificateConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateType': (<class 'str'>, True)}

class troposphere.gamelift.Destination(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Destination

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DestinationArn': (<class 'str'>, False)}

class troposphere.gamelift.FilterConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FilterConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllowedLocations': ([<class 'str'>], False)}

class troposphere.gamelift.Fleet(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Fleet

378 Chapter 7. Licensing

Page 383: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BuildId': (<class 'str'>, False), 'CertificateConfiguration': (<class'troposphere.gamelift.CertificateConfiguration'>, False), 'Description': (<class'str'>, False), 'DesiredEC2Instances': (<function integer>, False),'EC2InboundPermissions': ([<class 'troposphere.gamelift.IpPermission'>], False),'EC2InstanceType': (<class 'str'>, False), 'FleetType': (<class 'str'>, False),'InstanceRoleARN': (<class 'str'>, False), 'Locations': ([<class'troposphere.gamelift.LocationConfiguration'>], False), 'MaxSize': (<functioninteger>, False), 'MetricGroups': ([<class 'str'>], False), 'MinSize': (<functioninteger>, False), 'Name': (<class 'str'>, False), 'NewGameSessionProtectionPolicy':(<class 'str'>, False), 'PeerVpcAwsAccountId': (<class 'str'>, False), 'PeerVpcId':(<class 'str'>, False), 'ResourceCreationLimitPolicy': (<class'troposphere.gamelift.ResourceCreationLimitPolicy'>, False), 'RuntimeConfiguration':(<class 'troposphere.gamelift.RuntimeConfiguration'>, False), 'ScriptId': (<class'str'>, False)}

resource_type: Optional[str] = 'AWS::GameLift::Fleet'

class troposphere.gamelift.GameProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GameProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.gamelift.GameServerGroup(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

GameServerGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoScalingPolicy': (<class 'troposphere.gamelift.AutoScalingPolicy'>, False),'BalancingStrategy': (<class 'str'>, False), 'DeleteOption': (<class 'str'>,False), 'GameServerGroupName': (<class 'str'>, True), 'GameServerProtectionPolicy':(<class 'str'>, False), 'InstanceDefinitions': ([<class'troposphere.gamelift.InstanceDefinition'>], True), 'LaunchTemplate': (<class'troposphere.gamelift.LaunchTemplate'>, True), 'MaxSize': (<function double>,False), 'MinSize': (<function double>, False), 'RoleArn': (<class 'str'>, True),'Tags': (<class 'troposphere.Tags'>, False), 'VpcSubnets': ([<class 'str'>],False)}

resource_type: Optional[str] = 'AWS::GameLift::GameServerGroup'

class troposphere.gamelift.GameSessionQueue(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

GameSessionQueue

7.3. troposphere 379

Page 384: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CustomEventData': (<class 'str'>, False), 'Destinations': ([<class'troposphere.gamelift.Destination'>], False), 'FilterConfiguration': (<class'troposphere.gamelift.FilterConfiguration'>, False), 'Name': (<class 'str'>, True),'NotificationTarget': (<class 'str'>, False), 'PlayerLatencyPolicies': ([<class'troposphere.gamelift.PlayerLatencyPolicy'>], False), 'PriorityConfiguration':(<class 'troposphere.gamelift.PriorityConfiguration'>, False), 'Tags': (<class'troposphere.Tags'>, False), 'TimeoutInSeconds': (<function integer>, False)}

resource_type: Optional[str] = 'AWS::GameLift::GameSessionQueue'

class troposphere.gamelift.InstanceDefinition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InstanceDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InstanceType': (<class 'str'>, True), 'WeightedCapacity': (<class 'str'>,False)}

class troposphere.gamelift.IpPermission(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

IpPermission

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FromPort': (<function integer>, True), 'IpRange': (<class 'str'>, True),'Protocol': (<class 'str'>, True), 'ToPort': (<function integer>, True)}

class troposphere.gamelift.LaunchTemplate(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LaunchTemplate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LaunchTemplateId': (<class 'str'>, False), 'LaunchTemplateName': (<class 'str'>,False), 'Version': (<class 'str'>, False)}

class troposphere.gamelift.LocationCapacity(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LocationCapacity

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DesiredEC2Instances': (<function integer>, True), 'MaxSize': (<functioninteger>, True), 'MinSize': (<function integer>, True)}

class troposphere.gamelift.LocationConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LocationConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Location': (<class 'str'>, True), 'LocationCapacity': (<class'troposphere.gamelift.LocationCapacity'>, False)}

380 Chapter 7. Licensing

Page 385: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.gamelift.MatchmakingConfiguration(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

MatchmakingConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AcceptanceRequired': (<function boolean>, True), 'AcceptanceTimeoutSeconds':(<function integer>, False), 'AdditionalPlayerCount': (<function integer>, False),'BackfillMode': (<class 'str'>, False), 'CustomEventData': (<class 'str'>, False),'Description': (<class 'str'>, False), 'FlexMatchMode': (<class 'str'>, False),'GameProperties': ([<class 'troposphere.gamelift.GameProperty'>], False),'GameSessionData': (<class 'str'>, False), 'GameSessionQueueArns': ([<class'str'>], False), 'Name': (<class 'str'>, True), 'NotificationTarget': (<class'str'>, False), 'RequestTimeoutSeconds': (<function integer>, True), 'RuleSetName':(<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::GameLift::MatchmakingConfiguration'

class troposphere.gamelift.MatchmakingRuleSet(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

MatchmakingRuleSet

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'RuleSetBody': (<class 'str'>, True), 'Tags':(<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::GameLift::MatchmakingRuleSet'

class troposphere.gamelift.PlayerLatencyPolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PlayerLatencyPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaximumIndividualPlayerLatencyMilliseconds': (<function integer>, False),'PolicyDurationSeconds': (<function integer>, False)}

class troposphere.gamelift.PriorityConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PriorityConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LocationOrder': ([<class 'str'>], False), 'PriorityOrder': ([<class 'str'>],False)}

class troposphere.gamelift.ResourceCreationLimitPolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ResourceCreationLimitPolicy

7.3. troposphere 381

Page 386: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'NewGameSessionsPerCreator': (<function integer>, False), 'PolicyPeriodInMinutes':(<function integer>, False)}

class troposphere.gamelift.RoutingStrategy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RoutingStrategy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FleetId': (<class 'str'>, False), 'Message': (<class 'str'>, False), 'Type':(<class 'str'>, True)}

class troposphere.gamelift.RuntimeConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RuntimeConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GameSessionActivationTimeoutSeconds': (<function integer>, False),'MaxConcurrentGameSessionActivations': (<function integer>, False),'ServerProcesses': ([<class 'troposphere.gamelift.ServerProcess'>], False)}

class troposphere.gamelift.S3Location(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3Location

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Bucket': (<class 'str'>, True), 'Key': (<class 'str'>, True), 'ObjectVersion':(<class 'str'>, False), 'RoleArn': (<class 'str'>, True)}

class troposphere.gamelift.Script(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Script

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'StorageLocation': (<class'troposphere.gamelift.S3Location'>, True), 'Tags': (<class 'troposphere.Tags'>,False), 'Version': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::GameLift::Script'

class troposphere.gamelift.ServerProcess(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ServerProcess

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConcurrentExecutions': (<function integer>, True), 'LaunchPath': (<class 'str'>,True), 'Parameters': (<class 'str'>, False)}

class troposphere.gamelift.TargetTrackingConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

382 Chapter 7. Licensing

Page 387: Release 3.1

troposphere Documentation, Release 4.0.1

TargetTrackingConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TargetValue': (<function double>, True)}

troposphere.globalaccelerator module

class troposphere.globalaccelerator.Accelerator(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Accelerator

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False), 'IpAddressType': (<functionaccelerator_ipaddresstype>, False), 'IpAddresses': ([<class 'str'>], False),'Name': (<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::GlobalAccelerator::Accelerator'

class troposphere.globalaccelerator.EndpointConfiguration(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

EndpointConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClientIPPreservationEnabled': (<function boolean>, False), 'EndpointId': (<class'str'>, True), 'Weight': (<function integer>, False)}

class troposphere.globalaccelerator.EndpointGroup(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

EndpointGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EndpointConfigurations': ([<class'troposphere.globalaccelerator.EndpointConfiguration'>], False),'EndpointGroupRegion': (<class 'str'>, True), 'HealthCheckIntervalSeconds':(<function integer>, False), 'HealthCheckPath': (<class 'str'>, False),'HealthCheckPort': (<function integer>, False), 'HealthCheckProtocol': (<functionendpointgroup_healthcheckprotocol>, False), 'ListenerArn': (<class 'str'>, True),'PortOverrides': ([<class 'troposphere.globalaccelerator.PortOverride'>], False),'ThresholdCount': (<function integer>, False), 'TrafficDialPercentage': (<functiondouble>, False)}

resource_type: Optional[str] = 'AWS::GlobalAccelerator::EndpointGroup'

class troposphere.globalaccelerator.Listener(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

7.3. troposphere 383

Page 388: Release 3.1

troposphere Documentation, Release 4.0.1

Listener

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AcceleratorArn': (<class 'str'>, True), 'ClientAffinity': (<functionlistener_clientaffinity>, False), 'PortRanges': ([<class'troposphere.globalaccelerator.PortRange'>], True), 'Protocol': (<functionlistener_protocol>, True)}

resource_type: Optional[str] = 'AWS::GlobalAccelerator::Listener'

class troposphere.globalaccelerator.PortOverride(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PortOverride

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EndpointPort': (<function integer>, True), 'ListenerPort': (<function integer>,True)}

class troposphere.globalaccelerator.PortRange(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PortRange

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FromPort': (<function integer>, True), 'ToPort': (<function integer>, True)}

troposphere.glue module

class troposphere.glue.Action(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Action

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Arguments': (<class 'dict'>, False), 'CrawlerName': (<class 'str'>, False),'JobName': (<class 'str'>, False), 'NotificationProperty': (<class'troposphere.glue.NotificationProperty'>, False), 'SecurityConfiguration': (<class'str'>, False), 'Timeout': (<function integer>, False)}

class troposphere.glue.CatalogTarget(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CatalogTarget

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DatabaseName': (<class 'str'>, False), 'Tables': ([<class 'str'>], False)}

class troposphere.glue.Classifier(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Classifier

384 Chapter 7. Licensing

Page 389: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CsvClassifier': (<class 'troposphere.glue.CsvClassifier'>, False),'GrokClassifier': (<class 'troposphere.glue.GrokClassifier'>, False),'JsonClassifier': (<class 'troposphere.glue.JsonClassifier'>, False),'XMLClassifier': (<class 'troposphere.glue.XMLClassifier'>, False)}

resource_type: Optional[str] = 'AWS::Glue::Classifier'

class troposphere.glue.CloudWatchEncryption(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CloudWatchEncryption

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudWatchEncryptionMode': (<class 'str'>, False), 'KmsKeyArn': (<class 'str'>,False)}

class troposphere.glue.Column(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Column

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Comment': (<class 'str'>, False), 'Name': (<class 'str'>, True), 'Type':(<class 'str'>, False)}

class troposphere.glue.Condition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Condition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CrawlState': (<class 'str'>, False), 'CrawlerName': (<class 'str'>, False),'JobName': (<class 'str'>, False), 'LogicalOperator': (<class 'str'>, False),'State': (<class 'str'>, False)}

class troposphere.glue.Connection(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Connection

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CatalogId': (<class 'str'>, True), 'ConnectionInput': (<class'troposphere.glue.ConnectionInput'>, True)}

resource_type: Optional[str] = 'AWS::Glue::Connection'

class troposphere.glue.ConnectionInput(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConnectionInput

7.3. troposphere 385

Page 390: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectionProperties': (<class 'dict'>, False), 'ConnectionType': (<functionconnection_type_validator>, True), 'Description': (<class 'str'>, False),'MatchCriteria': ([<class 'str'>], False), 'Name': (<class 'str'>, False),'PhysicalConnectionRequirements': (<class'troposphere.glue.PhysicalConnectionRequirements'>, False)}

class troposphere.glue.ConnectionPasswordEncryption(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConnectionPasswordEncryption

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KmsKeyId': (<class 'str'>, False), 'ReturnConnectionPasswordEncrypted':(<function boolean>, False)}

class troposphere.glue.ConnectionsList(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConnectionsList

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Connections': ([<class 'str'>], False)}

class troposphere.glue.Crawler(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Crawler

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Classifiers': ([<class 'str'>], False), 'Configuration': (<class 'str'>, False),'CrawlerSecurityConfiguration': (<class 'str'>, False), 'DatabaseName': (<class'str'>, False), 'Description': (<class 'str'>, False), 'Name': (<class 'str'>,False), 'RecrawlPolicy': (<class 'troposphere.glue.RecrawlPolicy'>, False), 'Role':(<class 'str'>, True), 'Schedule': (<class 'troposphere.glue.Schedule'>, False),'SchemaChangePolicy': (<class 'troposphere.glue.SchemaChangePolicy'>, False),'TablePrefix': (<class 'str'>, False), 'Tags': (<class 'dict'>, False), 'Targets':(<class 'troposphere.glue.Targets'>, True)}

resource_type: Optional[str] = 'AWS::Glue::Crawler'

class troposphere.glue.CsvClassifier(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CsvClassifier

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllowSingleColumn': (<function boolean>, False), 'ContainsHeader': (<class'str'>, False), 'Delimiter': (<class 'str'>, False), 'DisableValueTrimming':(<function boolean>, False), 'Header': ([<class 'str'>], False), 'Name': (<class'str'>, False), 'QuoteSymbol': (<class 'str'>, False)}

386 Chapter 7. Licensing

Page 391: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.glue.DataCatalogEncryptionSettings(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DataCatalogEncryptionSettings

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CatalogId': (<class 'str'>, True), 'DataCatalogEncryptionSettings': (<class'troposphere.glue.DataCatalogEncryptionSettingsProperty'>, True)}

resource_type: Optional[str] = 'AWS::Glue::DataCatalogEncryptionSettings'

class troposphere.glue.DataCatalogEncryptionSettingsProperty(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

DataCatalogEncryptionSettingsProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectionPasswordEncryption': (<class'troposphere.glue.ConnectionPasswordEncryption'>, False), 'EncryptionAtRest':(<class 'troposphere.glue.EncryptionAtRest'>, False)}

class troposphere.glue.DataLakePrincipal(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DataLakePrincipal

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DataLakePrincipalIdentifier': (<class 'str'>, False)}

class troposphere.glue.Database(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Database

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CatalogId': (<class 'str'>, True), 'DatabaseInput': (<class'troposphere.glue.DatabaseInput'>, True)}

resource_type: Optional[str] = 'AWS::Glue::Database'

class troposphere.glue.DatabaseIdentifier(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DatabaseIdentifier

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CatalogId': (<class 'str'>, False), 'DatabaseName': (<class 'str'>, False)}

class troposphere.glue.DatabaseInput(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DatabaseInput

7.3. troposphere 387

Page 392: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CreateTableDefaultPermissions': ([<class'troposphere.glue.PrincipalPrivileges'>], False), 'Description': (<class 'str'>,False), 'LocationUri': (<class 'str'>, False), 'Name': (<class 'str'>, False),'Parameters': (<class 'dict'>, False), 'TargetDatabase': (<class'troposphere.glue.DatabaseIdentifier'>, False)}

class troposphere.glue.DevEndpoint(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DevEndpoint

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Arguments': (<class 'dict'>, False), 'EndpointName': (<class 'str'>, False),'ExtraJarsS3Path': (<class 'str'>, False), 'ExtraPythonLibsS3Path': (<class'str'>, False), 'GlueVersion': (<class 'str'>, False), 'NumberOfNodes': (<functioninteger>, False), 'NumberOfWorkers': (<function integer>, False), 'PublicKey':(<class 'str'>, False), 'PublicKeys': ([<class 'str'>], False), 'RoleArn': (<class'str'>, True), 'SecurityConfiguration': (<class 'str'>, False), 'SecurityGroupIds':([<class 'str'>], False), 'SubnetId': (<class 'str'>, False), 'Tags': (<class'dict'>, False), 'WorkerType': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::Glue::DevEndpoint'

class troposphere.glue.DynamoDBTarget(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DynamoDBTarget

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Path': (<class 'str'>, False)}

class troposphere.glue.EncryptionAtRest(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EncryptionAtRest

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CatalogEncryptionMode': (<class 'str'>, False), 'SseAwsKmsKeyId': (<class'str'>, False)}

class troposphere.glue.EncryptionConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EncryptionConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudWatchEncryption': (<class 'troposphere.glue.CloudWatchEncryption'>, False),'JobBookmarksEncryption': (<class 'troposphere.glue.JobBookmarksEncryption'>,False), 'S3Encryptions': ([<class 'troposphere.glue.S3Encryption'>], False)}

class troposphere.glue.ExecutionProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ExecutionProperty

388 Chapter 7. Licensing

Page 393: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxConcurrentRuns': (<function double>, False)}

class troposphere.glue.FindMatchesParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FindMatchesParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccuracyCostTradeoff': (<function double>, False), 'EnforceProvidedLabels':(<function boolean>, False), 'PrecisionRecallTradeoff': (<function double>, False),'PrimaryKeyColumnName': (<class 'str'>, True)}

class troposphere.glue.GlueTables(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GlueTables

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CatalogId': (<class 'str'>, False), 'ConnectionName': (<class 'str'>, False),'DatabaseName': (<class 'str'>, True), 'TableName': (<class 'str'>, True)}

class troposphere.glue.GrokClassifier(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GrokClassifier

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Classification': (<class 'str'>, True), 'CustomPatterns': (<class 'str'>,False), 'GrokPattern': (<class 'str'>, True), 'Name': (<class 'str'>, False)}

class troposphere.glue.InputRecordTables(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InputRecordTables

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GlueTables': ([<class 'troposphere.glue.GlueTables'>], False)}

class troposphere.glue.JdbcTarget(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

JdbcTarget

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectionName': (<class 'str'>, False), 'Exclusions': ([<class 'str'>], False),'Path': (<class 'str'>, False)}

class troposphere.glue.Job(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Job

7.3. troposphere 389

Page 394: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllocatedCapacity': (<function double>, False), 'Command': (<class'troposphere.glue.JobCommand'>, True), 'Connections': (<class'troposphere.glue.ConnectionsList'>, False), 'DefaultArguments': (<class 'dict'>,False), 'Description': (<class 'str'>, False), 'ExecutionProperty': (<class'troposphere.glue.ExecutionProperty'>, False), 'GlueVersion': (<class 'str'>,False), 'LogUri': (<class 'str'>, False), 'MaxCapacity': (<function double>,False), 'MaxRetries': (<function double>, False), 'Name': (<class 'str'>, False),'NotificationProperty': (<class 'troposphere.glue.NotificationProperty'>, False),'NumberOfWorkers': (<function integer>, False), 'Role': (<class 'str'>, True),'SecurityConfiguration': (<class 'str'>, False), 'Tags': (<class 'dict'>, False),'Timeout': (<function integer>, False), 'WorkerType': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::Glue::Job'

class troposphere.glue.JobBookmarksEncryption(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

JobBookmarksEncryption

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'JobBookmarksEncryptionMode': (<class 'str'>, False), 'KmsKeyArn': (<class'str'>, False)}

class troposphere.glue.JobCommand(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

JobCommand

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'PythonVersion': (<class 'str'>, False),'ScriptLocation': (<class 'str'>, False)}

class troposphere.glue.JsonClassifier(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

JsonClassifier

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'JsonPath': (<class 'str'>, True), 'Name': (<class 'str'>, False)}

class troposphere.glue.MLTransform(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

MLTransform

390 Chapter 7. Licensing

Page 395: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'GlueVersion': (<class 'str'>, False),'InputRecordTables': (<class 'troposphere.glue.InputRecordTables'>, True),'MaxCapacity': (<function double>, False), 'MaxRetries': (<function integer>,False), 'Name': (<class 'str'>, False), 'NumberOfWorkers': (<function integer>,False), 'Role': (<class 'str'>, True), 'Tags': (<class 'dict'>, False), 'Timeout':(<function integer>, False), 'TransformEncryption': (<class'troposphere.glue.TransformEncryption'>, False), 'TransformParameters': (<class'troposphere.glue.TransformParameters'>, True), 'WorkerType': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::Glue::MLTransform'

class troposphere.glue.MLUserDataEncryption(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MLUserDataEncryption

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KmsKeyId': (<class 'str'>, False), 'MLUserDataEncryptionMode': (<class 'str'>,True)}

class troposphere.glue.MongoDBTarget(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MongoDBTarget

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectionName': (<class 'str'>, False), 'Path': (<class 'str'>, False)}

class troposphere.glue.NotificationProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

NotificationProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'NotifyDelayAfter': (<function integer>, False)}

class troposphere.glue.Order(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Order

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Column': (<class 'str'>, True), 'SortOrder': (<function validate_sortorder>,True)}

class troposphere.glue.Partition(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Partition

7.3. troposphere 391

Page 396: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CatalogId': (<class 'str'>, True), 'DatabaseName': (<class 'str'>, True),'PartitionInput': (<class 'troposphere.glue.PartitionInput'>, True), 'TableName':(<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::Glue::Partition'

class troposphere.glue.PartitionInput(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PartitionInput

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Parameters': (<class 'dict'>, False), 'StorageDescriptor': (<class'troposphere.glue.StorageDescriptor'>, False), 'Values': ([<class 'str'>], True)}

class troposphere.glue.PhysicalConnectionRequirements(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PhysicalConnectionRequirements

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AvailabilityZone': (<class 'str'>, False), 'SecurityGroupIdList': ([<class'str'>], False), 'SubnetId': (<class 'str'>, False)}

class troposphere.glue.Predicate(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Predicate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Conditions': ([<class 'troposphere.glue.Condition'>], False), 'Logical': (<class'str'>, False)}

class troposphere.glue.PrincipalPrivileges(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PrincipalPrivileges

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Permissions': ([<class 'str'>], False), 'Principal': (<class'troposphere.glue.DataLakePrincipal'>, False)}

class troposphere.glue.RecrawlPolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RecrawlPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RecrawlBehavior': (<class 'str'>, False)}

class troposphere.glue.Registry(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Registry

392 Chapter 7. Licensing

Page 397: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'Name': (<class 'str'>, True), 'Tags':(<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::Glue::Registry'

class troposphere.glue.RegistryProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RegistryProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Arn':(<class 'str'>, False), 'Name': (<class 'str'>, False)}

class troposphere.glue.S3Encryption(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3Encryption

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KmsKeyArn': (<class 'str'>, False), 'S3EncryptionMode': (<class 'str'>, False)}

class troposphere.glue.S3Target(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3Target

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectionName': (<class 'str'>, False), 'DlqEventQueueArn': (<class 'str'>,False), 'EventQueueArn': (<class 'str'>, False), 'Exclusions': ([<class 'str'>],False), 'Path': (<class 'str'>, False), 'SampleSize': (<function integer>, False)}

class troposphere.glue.Schedule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Schedule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ScheduleExpression': (<class 'str'>, False)}

class troposphere.glue.Schema(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Schema

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CheckpointVersion': (<class 'troposphere.glue.SchemaVersionProperty'>, False),'Compatibility': (<class 'str'>, True), 'DataFormat': (<class 'str'>, True),'Description': (<class 'str'>, False), 'Name': (<class 'str'>, True), 'Registry':(<class 'troposphere.glue.RegistryProperty'>, False), 'SchemaDefinition': (<class'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::Glue::Schema'

7.3. troposphere 393

Page 398: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.glue.SchemaChangePolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SchemaChangePolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeleteBehavior': (<function delete_behavior_validator>, False), 'UpdateBehavior':(<function update_behavior_validator>, False)}

class troposphere.glue.SchemaId(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SchemaId

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RegistryName': (<class 'str'>, False), 'SchemaArn': (<class 'str'>, False),'SchemaName': (<class 'str'>, False)}

class troposphere.glue.SchemaProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SchemaProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RegistryName': (<class 'str'>, False), 'SchemaArn': (<class 'str'>, False),'SchemaName': (<class 'str'>, False)}

class troposphere.glue.SchemaReference(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SchemaReference

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SchemaId': (<class 'troposphere.glue.SchemaId'>, False), 'SchemaVersionId':(<class 'str'>, False), 'SchemaVersionNumber': (<function integer>, False)}

class troposphere.glue.SchemaVersion(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

SchemaVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Schema': (<class 'troposphere.glue.SchemaProperty'>, True), 'SchemaDefinition':(<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::Glue::SchemaVersion'

class troposphere.glue.SchemaVersionMetadata(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

SchemaVersionMetadata

394 Chapter 7. Licensing

Page 399: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, True), 'SchemaVersionId': (<class 'str'>, True), 'Value': (<class'str'>, True)}

resource_type: Optional[str] = 'AWS::Glue::SchemaVersionMetadata'

class troposphere.glue.SchemaVersionProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SchemaVersionProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'IsLatest': (<function boolean>, False), 'VersionNumber': (<function integer>,False)}

class troposphere.glue.SecurityConfiguration(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

SecurityConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EncryptionConfiguration': (<class 'troposphere.glue.EncryptionConfiguration'>,True), 'Name': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::Glue::SecurityConfiguration'

class troposphere.glue.SerdeInfo(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SerdeInfo

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'Parameters': (<class 'dict'>, False),'SerializationLibrary': (<class 'str'>, False)}

class troposphere.glue.SkewedInfo(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SkewedInfo

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SkewedColumnNames': ([<class 'str'>], False), 'SkewedColumnValueLocationMaps':(<class 'dict'>, False), 'SkewedColumnValues': ([<class 'str'>], False)}

class troposphere.glue.StorageDescriptor(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

StorageDescriptor

7.3. troposphere 395

Page 400: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketColumns': ([<class 'str'>], False), 'Columns': ([<class'troposphere.glue.Column'>], False), 'Compressed': (<function boolean>, False),'InputFormat': (<class 'str'>, False), 'Location': (<class 'str'>, False),'NumberOfBuckets': (<function integer>, False), 'OutputFormat': (<class 'str'>,False), 'Parameters': (<class 'dict'>, False), 'SchemaReference': (<class'troposphere.glue.SchemaReference'>, False), 'SerdeInfo': (<class'troposphere.glue.SerdeInfo'>, False), 'SkewedInfo': (<class'troposphere.glue.SkewedInfo'>, False), 'SortColumns': ([<class'troposphere.glue.Order'>], False), 'StoredAsSubDirectories': (<function boolean>,False)}

class troposphere.glue.Table(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Table

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CatalogId': (<class 'str'>, True), 'DatabaseName': (<class 'str'>, True),'TableInput': (<class 'troposphere.glue.TableInput'>, True)}

resource_type: Optional[str] = 'AWS::Glue::Table'

class troposphere.glue.TableIdentifier(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TableIdentifier

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CatalogId': (<class 'str'>, False), 'DatabaseName': (<class 'str'>, False),'Name': (<class 'str'>, False)}

class troposphere.glue.TableInput(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TableInput

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'Name': (<class 'str'>, False), 'Owner':(<class 'str'>, False), 'Parameters': (<class 'dict'>, False), 'PartitionKeys':([<class 'troposphere.glue.Column'>], False), 'Retention': (<function integer>,False), 'StorageDescriptor': (<class 'troposphere.glue.StorageDescriptor'>, False),'TableType': (<function table_type_validator>, False), 'TargetTable': (<class'troposphere.glue.TableIdentifier'>, False), 'ViewExpandedText': (<class 'str'>,False), 'ViewOriginalText': (<class 'str'>, False)}

class troposphere.glue.Targets(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Targets

396 Chapter 7. Licensing

Page 401: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CatalogTargets': ([<class 'troposphere.glue.CatalogTarget'>], False),'DynamoDBTargets': ([<class 'troposphere.glue.DynamoDBTarget'>], False),'JdbcTargets': ([<class 'troposphere.glue.JdbcTarget'>], False), 'MongoDBTargets':([<class 'troposphere.glue.MongoDBTarget'>], False), 'S3Targets': ([<class'troposphere.glue.S3Target'>], False)}

class troposphere.glue.TransformEncryption(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TransformEncryption

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MLUserDataEncryption': (<class 'troposphere.glue.MLUserDataEncryption'>, False),'TaskRunSecurityConfigurationName': (<class 'str'>, False)}

class troposphere.glue.TransformParameters(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TransformParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FindMatchesParameters': (<class 'troposphere.glue.FindMatchesParameters'>,False), 'TransformType': (<class 'str'>, True)}

class troposphere.glue.Trigger(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Trigger

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Actions': ([<class 'troposphere.glue.Action'>], True), 'Description': (<class'str'>, False), 'Name': (<class 'str'>, False), 'Predicate': (<class'troposphere.glue.Predicate'>, False), 'Schedule': (<class 'str'>, False),'StartOnCreation': (<function boolean>, False), 'Tags': (<class 'dict'>, False),'Type': (<function trigger_type_validator>, True), 'WorkflowName': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::Glue::Trigger'

class troposphere.glue.Workflow(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Workflow

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DefaultRunProperties': (<class 'dict'>, False), 'Description': (<class 'str'>,False), 'Name': (<class 'str'>, False), 'Tags': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::Glue::Workflow'

class troposphere.glue.XMLClassifier(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

XMLClassifier

7.3. troposphere 397

Page 402: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Classification': (<class 'str'>, True), 'Name': (<class 'str'>, False),'RowTag': (<class 'str'>, True)}

troposphere.greengrass module

class troposphere.greengrass.Connector(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Connector

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectorArn': (<class 'str'>, True), 'Id': (<class 'str'>, True), 'Parameters':(<class 'dict'>, False)}

class troposphere.greengrass.ConnectorDefinition(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ConnectorDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InitialVersion': (<class'troposphere.greengrass.ConnectorDefinitionVersionProperty'>, False), 'Name':(<class 'str'>, True), 'Tags': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::Greengrass::ConnectorDefinition'

class troposphere.greengrass.ConnectorDefinitionVersion(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ConnectorDefinitionVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectorDefinitionId': (<class 'str'>, True), 'Connectors': ([<class'troposphere.greengrass.Connector'>], True)}

resource_type: Optional[str] = 'AWS::Greengrass::ConnectorDefinitionVersion'

class troposphere.greengrass.ConnectorDefinitionVersionProperty(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ConnectorDefinitionVersionProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Connectors': ([<class 'troposphere.greengrass.Connector'>], True)}

class troposphere.greengrass.Core(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Core

398 Chapter 7. Licensing

Page 403: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateArn': (<class 'str'>, True), 'Id': (<class 'str'>, True),'SyncShadow': (<function boolean>, False), 'ThingArn': (<class 'str'>, True)}

class troposphere.greengrass.CoreDefinition(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

CoreDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InitialVersion': (<class 'troposphere.greengrass.CoreDefinitionVersionProperty'>,False), 'Name': (<class 'str'>, True), 'Tags': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::Greengrass::CoreDefinition'

class troposphere.greengrass.CoreDefinitionVersion(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

CoreDefinitionVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CoreDefinitionId': (<class 'str'>, True), 'Cores': ([<class'troposphere.greengrass.Core'>], True)}

resource_type: Optional[str] = 'AWS::Greengrass::CoreDefinitionVersion'

class troposphere.greengrass.CoreDefinitionVersionProperty(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

CoreDefinitionVersionProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Cores': ([<class 'troposphere.greengrass.Core'>], True)}

class troposphere.greengrass.DefaultConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DefaultConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Execution': (<class 'troposphere.greengrass.Execution'>, True)}

class troposphere.greengrass.Device(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Device

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateArn': (<class 'str'>, True), 'Id': (<class 'str'>, True),'SyncShadow': (<function boolean>, False), 'ThingArn': (<class 'str'>, True)}

7.3. troposphere 399

Page 404: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.greengrass.DeviceDefinition(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DeviceDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InitialVersion': (<class'troposphere.greengrass.DeviceDefinitionVersionProperty'>, False), 'Name': (<class'str'>, True), 'Tags': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::Greengrass::DeviceDefinition'

class troposphere.greengrass.DeviceDefinitionVersion(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DeviceDefinitionVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeviceDefinitionId': (<class 'str'>, True), 'Devices': ([<class'troposphere.greengrass.Device'>], True)}

resource_type: Optional[str] = 'AWS::Greengrass::DeviceDefinitionVersion'

class troposphere.greengrass.DeviceDefinitionVersionProperty(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

DeviceDefinitionVersionProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Devices': ([<class 'troposphere.greengrass.Device'>], True)}

class troposphere.greengrass.Environment(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Environment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessSysfs': (<function boolean>, False), 'Execution': (<class'troposphere.greengrass.Execution'>, False), 'ResourceAccessPolicies': ([<class'troposphere.greengrass.ResourceAccessPolicy'>], False), 'Variables': (<class'dict'>, False)}

class troposphere.greengrass.Execution(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Execution

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'IsolationMode': (<class 'str'>, False), 'RunAs': (<class'troposphere.greengrass.RunAs'>, False)}

400 Chapter 7. Licensing

Page 405: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.greengrass.Function(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Function

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FunctionArn': (<class 'str'>, True), 'FunctionConfiguration': (<class'troposphere.greengrass.FunctionConfiguration'>, True), 'Id': (<class 'str'>,True)}

class troposphere.greengrass.FunctionConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FunctionConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EncodingType': (<class 'str'>, False), 'Environment': (<class'troposphere.greengrass.Environment'>, False), 'ExecArgs': (<class 'str'>, False),'Executable': (<class 'str'>, False), 'MemorySize': (<function integer>, False),'Pinned': (<function boolean>, False), 'Timeout': (<function integer>, False)}

class troposphere.greengrass.FunctionDefinition(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

FunctionDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InitialVersion': (<class'troposphere.greengrass.FunctionDefinitionVersionProperty'>, False), 'Name':(<class 'str'>, True), 'Tags': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::Greengrass::FunctionDefinition'

class troposphere.greengrass.FunctionDefinitionVersion(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

FunctionDefinitionVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DefaultConfig': (<class 'troposphere.greengrass.DefaultConfig'>, False),'FunctionDefinitionId': (<class 'str'>, True), 'Functions': ([<class'troposphere.greengrass.Function'>], True)}

resource_type: Optional[str] = 'AWS::Greengrass::FunctionDefinitionVersion'

class troposphere.greengrass.FunctionDefinitionVersionProperty(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

FunctionDefinitionVersionProperty

7.3. troposphere 401

Page 406: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DefaultConfig': (<class 'troposphere.greengrass.DefaultConfig'>, False),'Functions': ([<class 'troposphere.greengrass.Function'>], True)}

class troposphere.greengrass.Group(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Group

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InitialVersion': (<class 'troposphere.greengrass.GroupVersionProperty'>, False),'Name': (<class 'str'>, True), 'RoleArn': (<class 'str'>, False), 'Tags': (<class'dict'>, False)}

resource_type: Optional[str] = 'AWS::Greengrass::Group'

class troposphere.greengrass.GroupOwnerSetting(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GroupOwnerSetting

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoAddGroupOwner': (<function boolean>, True), 'GroupOwner': (<class 'str'>,False)}

class troposphere.greengrass.GroupVersion(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

GroupVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectorDefinitionVersionArn': (<class 'str'>, False),'CoreDefinitionVersionArn': (<class 'str'>, False), 'DeviceDefinitionVersionArn':(<class 'str'>, False), 'FunctionDefinitionVersionArn': (<class 'str'>, False),'GroupId': (<class 'str'>, True), 'LoggerDefinitionVersionArn': (<class 'str'>,False), 'ResourceDefinitionVersionArn': (<class 'str'>, False),'SubscriptionDefinitionVersionArn': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::Greengrass::GroupVersion'

class troposphere.greengrass.GroupVersionProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GroupVersionProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConnectorDefinitionVersionArn': (<class 'str'>, False),'CoreDefinitionVersionArn': (<class 'str'>, False), 'DeviceDefinitionVersionArn':(<class 'str'>, False), 'FunctionDefinitionVersionArn': (<class 'str'>, False),'LoggerDefinitionVersionArn': (<class 'str'>, False),'ResourceDefinitionVersionArn': (<class 'str'>, False),'SubscriptionDefinitionVersionArn': (<class 'str'>, False)}

402 Chapter 7. Licensing

Page 407: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.greengrass.LocalDeviceResourceData(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LocalDeviceResourceData

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GroupOwnerSetting': (<class 'troposphere.greengrass.GroupOwnerSetting'>, False),'SourcePath': (<class 'str'>, True)}

class troposphere.greengrass.LocalVolumeResourceData(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LocalVolumeResourceData

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DestinationPath': (<class 'str'>, True), 'GroupOwnerSetting': (<class'troposphere.greengrass.GroupOwnerSetting'>, False), 'SourcePath': (<class 'str'>,True)}

class troposphere.greengrass.Logger(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Logger

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Component': (<class 'str'>, True), 'Id': (<class 'str'>, True), 'Level':(<class 'str'>, True), 'Space': (<function integer>, False), 'Type': (<class'str'>, True)}

class troposphere.greengrass.LoggerDefinition(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

LoggerDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InitialVersion': (<class'troposphere.greengrass.LoggerDefinitionVersionProperty'>, False), 'Name': (<class'str'>, True), 'Tags': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::Greengrass::LoggerDefinition'

class troposphere.greengrass.LoggerDefinitionVersion(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

LoggerDefinitionVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LoggerDefinitionId': (<class 'str'>, True), 'Loggers': ([<class'troposphere.greengrass.Logger'>], True)}

resource_type: Optional[str] = 'AWS::Greengrass::LoggerDefinitionVersion'

7.3. troposphere 403

Page 408: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.greengrass.LoggerDefinitionVersionProperty(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

LoggerDefinitionVersionProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Loggers': ([<class 'troposphere.greengrass.Logger'>], True)}

class troposphere.greengrass.ResourceAccessPolicy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ResourceAccessPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Permission': (<class 'str'>, False), 'ResourceId': (<class 'str'>, True)}

class troposphere.greengrass.ResourceDataContainer(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ResourceDataContainer

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LocalDeviceResourceData': (<class'troposphere.greengrass.LocalDeviceResourceData'>, False),'LocalVolumeResourceData': (<class'troposphere.greengrass.LocalVolumeResourceData'>, False),'S3MachineLearningModelResourceData': (<class'troposphere.greengrass.S3MachineLearningModelResourceData'>, False),'SageMakerMachineLearningModelResourceData': (<class'troposphere.greengrass.SageMakerMachineLearningModelResourceData'>, False),'SecretsManagerSecretResourceData': (<class'troposphere.greengrass.SecretsManagerSecretResourceData'>, False)}

class troposphere.greengrass.ResourceDefinition(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ResourceDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InitialVersion': (<class'troposphere.greengrass.ResourceDefinitionVersionProperty'>, False), 'Name':(<class 'str'>, True), 'Tags': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::Greengrass::ResourceDefinition'

class troposphere.greengrass.ResourceDefinitionVersion(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ResourceDefinitionVersion

404 Chapter 7. Licensing

Page 409: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ResourceDefinitionId': (<class 'str'>, True), 'Resources': ([<class'troposphere.greengrass.ResourceInstance'>], True)}

resource_type: Optional[str] = 'AWS::Greengrass::ResourceDefinitionVersion'

class troposphere.greengrass.ResourceDefinitionVersionProperty(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ResourceDefinitionVersionProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Resources': ([<class 'troposphere.greengrass.ResourceInstance'>], True)}

class troposphere.greengrass.ResourceDownloadOwnerSetting(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

ResourceDownloadOwnerSetting

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GroupOwner': (<class 'str'>, True), 'GroupPermission': (<class 'str'>, True)}

class troposphere.greengrass.ResourceInstance(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ResourceInstance

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Id':(<class 'str'>, True), 'Name': (<class 'str'>, True), 'ResourceDataContainer':(<class 'troposphere.greengrass.ResourceDataContainer'>, True)}

class troposphere.greengrass.RunAs(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RunAs

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Gid':(<function integer>, False), 'Uid': (<function integer>, False)}

class troposphere.greengrass.S3MachineLearningModelResourceData(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

S3MachineLearningModelResourceData

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DestinationPath': (<class 'str'>, True), 'OwnerSetting': (<class'troposphere.greengrass.ResourceDownloadOwnerSetting'>, False), 'S3Uri': (<class'str'>, True)}

class troposphere.greengrass.SageMakerMachineLearningModelResourceData(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

SageMakerMachineLearningModelResourceData

7.3. troposphere 405

Page 410: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DestinationPath': (<class 'str'>, True), 'OwnerSetting': (<class'troposphere.greengrass.ResourceDownloadOwnerSetting'>, False), 'SageMakerJobArn':(<class 'str'>, True)}

class troposphere.greengrass.SecretsManagerSecretResourceData(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

SecretsManagerSecretResourceData

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'ARN':(<class 'str'>, True), 'AdditionalStagingLabelsToDownload': ([<class 'str'>],False)}

class troposphere.greengrass.Subscription(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Subscription

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Id':(<class 'str'>, True), 'Source': (<class 'str'>, True), 'Subject': (<class 'str'>,True), 'Target': (<class 'str'>, True)}

class troposphere.greengrass.SubscriptionDefinition(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

SubscriptionDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InitialVersion': (<class'troposphere.greengrass.SubscriptionDefinitionVersionProperty'>, False), 'Name':(<class 'str'>, True), 'Tags': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::Greengrass::SubscriptionDefinition'

class troposphere.greengrass.SubscriptionDefinitionVersion(title: Optional[str], template:Optional[troposphere.Template] =None, validation: bool = True,**kwargs: Any)

Bases: troposphere.AWSObject

SubscriptionDefinitionVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SubscriptionDefinitionId': (<class 'str'>, True), 'Subscriptions': ([<class'troposphere.greengrass.Subscription'>], True)}

resource_type: Optional[str] = 'AWS::Greengrass::SubscriptionDefinitionVersion'

class troposphere.greengrass.SubscriptionDefinitionVersionProperty(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

SubscriptionDefinitionVersionProperty

406 Chapter 7. Licensing

Page 411: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Subscriptions': ([<class 'troposphere.greengrass.Subscription'>], True)}

troposphere.greengrassv2 module

class troposphere.greengrassv2.ComponentDependencyRequirement(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ComponentDependencyRequirement

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DependencyType': (<class 'str'>, False), 'VersionRequirement': (<class 'str'>,False)}

class troposphere.greengrassv2.ComponentPlatform(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ComponentPlatform

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Attributes': (<class 'dict'>, False), 'Name': (<class 'str'>, False)}

class troposphere.greengrassv2.ComponentVersion(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ComponentVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InlineRecipe': (<class 'str'>, False), 'LambdaFunction': (<class'troposphere.greengrassv2.LambdaFunctionRecipeSource'>, False), 'Tags': (<class'dict'>, False)}

resource_type: Optional[str] = 'AWS::GreengrassV2::ComponentVersion'

class troposphere.greengrassv2.LambdaContainerParams(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LambdaContainerParams

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Devices': ([<class 'troposphere.greengrassv2.LambdaDeviceMount'>], False),'MemorySizeInKB': (<function integer>, False), 'MountROSysfs': (<function boolean>,False), 'Volumes': ([<class 'troposphere.greengrassv2.LambdaVolumeMount'>], False)}

class troposphere.greengrassv2.LambdaDeviceMount(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LambdaDeviceMount

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AddGroupOwner': (<function boolean>, False), 'Path': (<class 'str'>, False),'Permission': (<class 'str'>, False)}

7.3. troposphere 407

Page 412: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.greengrassv2.LambdaEventSource(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LambdaEventSource

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Topic': (<class 'str'>, False), 'Type': (<class 'str'>, False)}

class troposphere.greengrassv2.LambdaExecutionParameters(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

LambdaExecutionParameters

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EnvironmentVariables': (<class 'dict'>, False), 'EventSources': ([<class'troposphere.greengrassv2.LambdaEventSource'>], False), 'ExecArgs': ([<class'str'>], False), 'InputPayloadEncodingType': (<class 'str'>, False),'LinuxProcessParams': (<class 'troposphere.greengrassv2.LambdaLinuxProcessParams'>,False), 'MaxIdleTimeInSeconds': (<function integer>, False), 'MaxInstancesCount':(<function integer>, False), 'MaxQueueSize': (<function integer>, False), 'Pinned':(<function boolean>, False), 'StatusTimeoutInSeconds': (<function integer>, False),'TimeoutInSeconds': (<function integer>, False)}

class troposphere.greengrassv2.LambdaFunctionRecipeSource(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

LambdaFunctionRecipeSource

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComponentDependencies': (<class 'dict'>, False), 'ComponentLambdaParameters':(<class 'troposphere.greengrassv2.LambdaExecutionParameters'>, False),'ComponentName': (<class 'str'>, False), 'ComponentPlatforms': ([<class'troposphere.greengrassv2.ComponentPlatform'>], False), 'ComponentVersion': (<class'str'>, False), 'LambdaArn': (<class 'str'>, False)}

class troposphere.greengrassv2.LambdaLinuxProcessParams(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

LambdaLinuxProcessParams

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContainerParams': (<class 'troposphere.greengrassv2.LambdaContainerParams'>,False), 'IsolationMode': (<class 'str'>, False)}

class troposphere.greengrassv2.LambdaVolumeMount(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LambdaVolumeMount

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AddGroupOwner': (<function boolean>, False), 'DestinationPath': (<class 'str'>,False), 'Permission': (<class 'str'>, False), 'SourcePath': (<class 'str'>,False)}

408 Chapter 7. Licensing

Page 413: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.groundstation module

class troposphere.groundstation.AntennaDownlinkConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AntennaDownlinkConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SpectrumConfig': (<class 'troposphere.groundstation.SpectrumConfig'>, False)}

class troposphere.groundstation.AntennaDownlinkDemodDecodeConfig(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

AntennaDownlinkDemodDecodeConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DecodeConfig': (<class 'troposphere.groundstation.DecodeConfig'>, False),'DemodulationConfig': (<class 'troposphere.groundstation.DemodulationConfig'>,False), 'SpectrumConfig': (<class 'troposphere.groundstation.SpectrumConfig'>,False)}

class troposphere.groundstation.AntennaUplinkConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AntennaUplinkConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SpectrumConfig': (<class 'troposphere.groundstation.SpectrumConfig'>, False),'TargetEirp': (<class 'troposphere.groundstation.Eirp'>, False),'TransmitDisabled': (<function boolean>, False)}

class troposphere.groundstation.Bandwidth(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Bandwidth

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Units': (<class 'str'>, False), 'Value': (<function double>, False)}

class troposphere.groundstation.Config(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Config

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConfigData': (<class 'troposphere.groundstation.ConfigData'>, True), 'Name':(<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::GroundStation::Config'

class troposphere.groundstation.ConfigData(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConfigData

7.3. troposphere 409

Page 414: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AntennaDownlinkConfig': (<class'troposphere.groundstation.AntennaDownlinkConfig'>, False),'AntennaDownlinkDemodDecodeConfig': (<class'troposphere.groundstation.AntennaDownlinkDemodDecodeConfig'>, False),'AntennaUplinkConfig': (<class 'troposphere.groundstation.AntennaUplinkConfig'>,False), 'DataflowEndpointConfig': (<class'troposphere.groundstation.DataflowEndpointConfig'>, False), 'S3RecordingConfig':(<class 'troposphere.groundstation.S3RecordingConfig'>, False), 'TrackingConfig':(<class 'troposphere.groundstation.TrackingConfig'>, False), 'UplinkEchoConfig':(<class 'troposphere.groundstation.UplinkEchoConfig'>, False)}

class troposphere.groundstation.DataflowEdge(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DataflowEdge

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Destination': (<class 'str'>, False), 'Source': (<class 'str'>, False)}

class troposphere.groundstation.DataflowEndpoint(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DataflowEndpoint

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Address': (<class 'troposphere.groundstation.SocketAddress'>, False), 'Mtu':(<function integer>, False), 'Name': (<class 'str'>, False)}

class troposphere.groundstation.DataflowEndpointConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DataflowEndpointConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DataflowEndpointName': (<class 'str'>, False), 'DataflowEndpointRegion': (<class'str'>, False)}

class troposphere.groundstation.DataflowEndpointGroup(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DataflowEndpointGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'EndpointDetails': ([<class 'troposphere.groundstation.EndpointDetails'>], True),'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::GroundStation::DataflowEndpointGroup'

class troposphere.groundstation.DecodeConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DecodeConfig

410 Chapter 7. Licensing

Page 415: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'UnvalidatedJSON': (<function validate_json_checker>, False)}

class troposphere.groundstation.DemodulationConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DemodulationConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'UnvalidatedJSON': (<function validate_json_checker>, False)}

class troposphere.groundstation.Eirp(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Eirp

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Units': (<class 'str'>, False), 'Value': (<function double>, False)}

class troposphere.groundstation.EndpointDetails(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EndpointDetails

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Endpoint': (<class 'troposphere.groundstation.DataflowEndpoint'>, False),'SecurityDetails': (<class 'troposphere.groundstation.SecurityDetails'>, False)}

class troposphere.groundstation.Frequency(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Frequency

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Units': (<class 'str'>, False), 'Value': (<function double>, False)}

class troposphere.groundstation.MissionProfile(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

MissionProfile

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContactPostPassDurationSeconds': (<function integer>, False),'ContactPrePassDurationSeconds': (<function integer>, False), 'DataflowEdges':([<class 'troposphere.groundstation.DataflowEdge'>], True),'MinimumViableContactDurationSeconds': (<function integer>, True), 'Name': (<class'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False), 'TrackingConfigArn':(<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::GroundStation::MissionProfile'

class troposphere.groundstation.S3RecordingConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 411

Page 416: Release 3.1

troposphere Documentation, Release 4.0.1

S3RecordingConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketArn': (<class 'str'>, False), 'Prefix': (<class 'str'>, False), 'RoleArn':(<class 'str'>, False)}

class troposphere.groundstation.SecurityDetails(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SecurityDetails

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RoleArn': (<class 'str'>, False), 'SecurityGroupIds': ([<class 'str'>], False),'SubnetIds': ([<class 'str'>], False)}

class troposphere.groundstation.SocketAddress(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SocketAddress

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'Port': (<function integer>, False)}

class troposphere.groundstation.SpectrumConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SpectrumConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Bandwidth': (<class 'troposphere.groundstation.Bandwidth'>, False),'CenterFrequency': (<class 'troposphere.groundstation.Frequency'>, False),'Polarization': (<class 'str'>, False)}

class troposphere.groundstation.TrackingConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TrackingConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Autotrack': (<class 'str'>, False)}

class troposphere.groundstation.UplinkEchoConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

UplinkEchoConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AntennaUplinkConfigArn': (<class 'str'>, False), 'Enabled': (<function boolean>,False)}

412 Chapter 7. Licensing

Page 417: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.guardduty module

class troposphere.guardduty.CFNDataSourceConfigurations(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

CFNDataSourceConfigurations

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Kubernetes': (<class 'troposphere.guardduty.CFNKubernetesConfiguration'>, False),'S3Logs': (<class 'troposphere.guardduty.CFNS3LogsConfiguration'>, False)}

class troposphere.guardduty.CFNKubernetesAuditLogsConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

CFNKubernetesAuditLogsConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enable': (<function boolean>, False)}

class troposphere.guardduty.CFNKubernetesConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CFNKubernetesConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuditLogs': (<class 'troposphere.guardduty.CFNKubernetesAuditLogsConfiguration'>,False)}

class troposphere.guardduty.CFNS3LogsConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CFNS3LogsConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enable': (<function boolean>, False)}

class troposphere.guardduty.Condition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Condition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Eq':([<class 'str'>], False), 'Gte': (<function integer>, False), 'Lt': (<functioninteger>, False), 'Lte': (<function integer>, False), 'Neq': ([<class 'str'>],False)}

class troposphere.guardduty.Detector(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Detector

7.3. troposphere 413

Page 418: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DataSources': (<class 'troposphere.guardduty.CFNDataSourceConfigurations'>,False), 'Enable': (<function boolean>, True), 'FindingPublishingFrequency':(<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::GuardDuty::Detector'

class troposphere.guardduty.Filter(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Filter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Action': (<class 'str'>, True), 'Description': (<class 'str'>, True),'DetectorId': (<class 'str'>, True), 'FindingCriteria': (<class'troposphere.guardduty.FindingCriteria'>, True), 'Name': (<class 'str'>, True),'Rank': (<function integer>, True)}

resource_type: Optional[str] = 'AWS::GuardDuty::Filter'

class troposphere.guardduty.FindingCriteria(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FindingCriteria

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Criterion': (<class 'dict'>, False), 'ItemType': (<class'troposphere.guardduty.Condition'>, False)}

class troposphere.guardduty.IPSet(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

IPSet

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Activate': (<function boolean>, True), 'DetectorId': (<class 'str'>, True),'Format': (<class 'str'>, True), 'Location': (<class 'str'>, True), 'Name':(<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::GuardDuty::IPSet'

class troposphere.guardduty.Master(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Master

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DetectorId': (<class 'str'>, True), 'InvitationId': (<class 'str'>, False),'MasterId': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::GuardDuty::Master'

414 Chapter 7. Licensing

Page 419: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.guardduty.Member(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Member

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DetectorId': (<class 'str'>, True), 'DisableEmailNotification': (<functionboolean>, False), 'Email': (<class 'str'>, True), 'MemberId': (<class 'str'>,True), 'Message': (<class 'str'>, False), 'Status': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::GuardDuty::Member'

class troposphere.guardduty.ThreatIntelSet(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

ThreatIntelSet

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Activate': (<function boolean>, True), 'DetectorId': (<class 'str'>, True),'Format': (<class 'str'>, True), 'Location': (<class 'str'>, True), 'Name':(<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::GuardDuty::ThreatIntelSet'

troposphere.healthlake module

class troposphere.healthlake.FHIRDatastore(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

FHIRDatastore

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DatastoreName': (<class 'str'>, False), 'DatastoreTypeVersion': (<class 'str'>,True), 'PreloadDataConfig': (<class 'troposphere.healthlake.PreloadDataConfig'>,False), 'SseConfiguration': (<class 'troposphere.healthlake.SseConfiguration'>,False), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::HealthLake::FHIRDatastore'

class troposphere.healthlake.KmsEncryptionConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KmsEncryptionConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CmkType': (<class 'str'>, True), 'KmsKeyId': (<class 'str'>, False)}

class troposphere.healthlake.PreloadDataConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PreloadDataConfig

7.3. troposphere 415

Page 420: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PreloadDataType': (<class 'str'>, True)}

class troposphere.healthlake.SseConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SseConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KmsEncryptionConfig': (<class 'troposphere.healthlake.KmsEncryptionConfig'>,True)}

troposphere.iam module

class troposphere.iam.AccessKey(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

AccessKey

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Serial': (<function integer>, False), 'Status': (<function status>, False),'UserName': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::IAM::AccessKey'

class troposphere.iam.Group(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Group

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GroupName': (<function iam_group_name>, False), 'ManagedPolicyArns': ([<class'str'>], False), 'Path': (<function iam_path>, False), 'Policies': ([<class'troposphere.iam.Policy'>], False)}

resource_type: Optional[str] = 'AWS::IAM::Group'

class troposphere.iam.InstanceProfile(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

InstanceProfile

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InstanceProfileName': (<class 'str'>, False), 'Path': (<function iam_path>,False), 'Roles': ([<class 'str'>], True)}

resource_type: Optional[str] = 'AWS::IAM::InstanceProfile'

class troposphere.iam.LoginProfile(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LoginProfile

416 Chapter 7. Licensing

Page 421: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Password': (<class 'str'>, True), 'PasswordResetRequired': (<function boolean>,False)}

class troposphere.iam.ManagedPolicy(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ManagedPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'Groups': ([<class 'str'>], False),'ManagedPolicyName': (<class 'str'>, False), 'Path': (<function iam_path>, False),'PolicyDocument': (<function policytypes>, True), 'Roles': ([<class 'str'>],False), 'Users': ([<class 'str'>], False)}

resource_type: Optional[str] = 'AWS::IAM::ManagedPolicy'

class troposphere.iam.OIDCProvider(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

OIDCProvider

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClientIdList': ([<class 'str'>], False), 'Tags': (<class 'troposphere.Tags'>,False), 'ThumbprintList': ([<class 'str'>], True), 'Url': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::IAM::OIDCProvider'

class troposphere.iam.Policy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Policy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PolicyDocument': (<function policytypes>, True), 'PolicyName': (<class 'str'>,True)}

class troposphere.iam.PolicyType(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

PolicyType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Groups': ([<class 'str'>], False), 'PolicyDocument': (<function policytypes>,True), 'PolicyName': (<class 'str'>, True), 'Roles': ([<class 'str'>], False),'Users': ([<class 'str'>], False)}

resource_type: Optional[str] = 'AWS::IAM::Policy'

class troposphere.iam.Role(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Role

7.3. troposphere 417

Page 422: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssumeRolePolicyDocument': (<function policytypes>, True), 'Description':(<class 'str'>, False), 'ManagedPolicyArns': ([<class 'str'>], False),'MaxSessionDuration': (<function integer>, False), 'Path': (<function iam_path>,False), 'PermissionsBoundary': (<class 'str'>, False), 'Policies': ([<class'troposphere.iam.Policy'>], False), 'RoleName': (<function iam_role_name>, False),'Tags': (<function validate_tags_or_list>, False)}

resource_type: Optional[str] = 'AWS::IAM::Role'

class troposphere.iam.SAMLProvider(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

SAMLProvider

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'SamlMetadataDocument': (<class 'str'>, True),'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IAM::SAMLProvider'

class troposphere.iam.ServerCertificate(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ServerCertificate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CertificateBody': (<class 'str'>, False), 'CertificateChain': (<class 'str'>,False), 'Path': (<class 'str'>, False), 'PrivateKey': (<class 'str'>, False),'ServerCertificateName': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IAM::ServerCertificate'

class troposphere.iam.ServiceLinkedRole(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ServiceLinkedRole

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AWSServiceName': (<class 'str'>, True), 'CustomSuffix': (<class 'str'>, False),'Description': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::IAM::ServiceLinkedRole'

class troposphere.iam.User(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

User

418 Chapter 7. Licensing

Page 423: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Groups': ([<class 'str'>], False), 'LoginProfile': (<class'troposphere.iam.LoginProfile'>, False), 'ManagedPolicyArns': ([<class 'str'>],False), 'Path': (<function iam_path>, False), 'PermissionsBoundary': (<class'str'>, False), 'Policies': ([<class 'troposphere.iam.Policy'>], False), 'Tags':(<class 'troposphere.Tags'>, False), 'UserName': (<function iam_user_name>, False)}

resource_type: Optional[str] = 'AWS::IAM::User'

class troposphere.iam.UserToGroupAddition(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

UserToGroupAddition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GroupName': (<class 'str'>, True), 'Users': ([<class 'str'>], True)}

resource_type: Optional[str] = 'AWS::IAM::UserToGroupAddition'

class troposphere.iam.VirtualMFADevice(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

VirtualMFADevice

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Path': (<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>, False),'Users': ([<class 'str'>], True), 'VirtualMfaDeviceName': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::IAM::VirtualMFADevice'

troposphere.imagebuilder module

class troposphere.imagebuilder.AdditionalInstanceConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

AdditionalInstanceConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SystemsManagerAgent': (<class 'troposphere.imagebuilder.SystemsManagerAgent'>,False), 'UserDataOverride': (<class 'str'>, False)}

class troposphere.imagebuilder.AmiDistributionConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

AmiDistributionConfiguration

7.3. troposphere 419

Page 424: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AmiTags': (<class 'dict'>, False), 'Description': (<class 'str'>, False),'KmsKeyId': (<class 'str'>, False), 'LaunchPermissionConfiguration': (<class'troposphere.imagebuilder.LaunchPermissionConfiguration'>, False), 'Name': (<class'str'>, False), 'TargetAccountIds': ([<class 'str'>], False)}

class troposphere.imagebuilder.Component(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Component

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ChangeDescription': (<class 'str'>, False), 'Data': (<class 'str'>, False),'Description': (<class 'str'>, False), 'KmsKeyId': (<class 'str'>, False), 'Name':(<class 'str'>, True), 'Platform': (<function component_platforms>, True),'SupportedOsVersions': ([<class 'str'>], False), 'Tags': (<class 'dict'>, False),'Uri': (<class 'str'>, False), 'Version': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::ImageBuilder::Component'

class troposphere.imagebuilder.ComponentConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ComponentConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComponentArn': (<class 'str'>, False), 'Parameters': ([<class'troposphere.imagebuilder.ComponentParameter'>], False)}

class troposphere.imagebuilder.ComponentParameter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ComponentParameter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'Value': ([<class 'str'>], True)}

class troposphere.imagebuilder.ContainerComponentConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ContainerComponentConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComponentArn': (<class 'str'>, False)}

class troposphere.imagebuilder.ContainerDistributionConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ContainerDistributionConfiguration

420 Chapter 7. Licensing

Page 425: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContainerTags': ([<class 'str'>], False), 'Description': (<class 'str'>, False),'TargetRepository': (<class 'troposphere.imagebuilder.TargetContainerRepository'>,False)}

class troposphere.imagebuilder.ContainerRecipe(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ContainerRecipe

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Components': ([<class'troposphere.imagebuilder.ContainerComponentConfiguration'>], True),'ContainerType': (<class 'str'>, True), 'Description': (<class 'str'>, False),'DockerfileTemplateData': (<class 'str'>, False), 'DockerfileTemplateUri': (<class'str'>, False), 'ImageOsVersionOverride': (<class 'str'>, False),'InstanceConfiguration': (<class 'troposphere.imagebuilder.InstanceConfiguration'>,False), 'KmsKeyId': (<class 'str'>, False), 'Name': (<class 'str'>, True),'ParentImage': (<class 'str'>, True), 'PlatformOverride': (<class 'str'>, False),'Tags': (<class 'dict'>, False), 'TargetRepository': (<class'troposphere.imagebuilder.TargetContainerRepository'>, True), 'Version': (<class'str'>, True), 'WorkingDirectory': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::ImageBuilder::ContainerRecipe'

class troposphere.imagebuilder.Distribution(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Distribution

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AmiDistributionConfiguration': (<class'troposphere.imagebuilder.AmiDistributionConfiguration'>, False),'ContainerDistributionConfiguration': (<class'troposphere.imagebuilder.ContainerDistributionConfiguration'>, False),'LaunchTemplateConfigurations': ([<class'troposphere.imagebuilder.LaunchTemplateConfiguration'>], False),'LicenseConfigurationArns': ([<class 'str'>], False), 'Region': (<class 'str'>,True)}

class troposphere.imagebuilder.DistributionConfiguration(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DistributionConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'Distributions': ([<class'troposphere.imagebuilder.Distribution'>], True), 'Name': (<class 'str'>, True),'Tags': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::ImageBuilder::DistributionConfiguration'

7.3. troposphere 421

Page 426: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.imagebuilder.EbsInstanceBlockDeviceSpecification(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

EbsInstanceBlockDeviceSpecification

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeleteOnTermination': (<function boolean>, False), 'Encrypted': (<functionboolean>, False), 'Iops': (<function integer>, False), 'KmsKeyId': (<class 'str'>,False), 'SnapshotId': (<class 'str'>, False), 'Throughput': (<function integer>,False), 'VolumeSize': (<function integer>, False), 'VolumeType': (<functionebsinstanceblockdevicespecification_volume_type>, False)}

class troposphere.imagebuilder.Image(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Image

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContainerRecipeArn': (<class 'str'>, False), 'DistributionConfigurationArn':(<class 'str'>, False), 'EnhancedImageMetadataEnabled': (<function boolean>,False), 'ImageRecipeArn': (<class 'str'>, False), 'ImageTestsConfiguration':(<class 'troposphere.imagebuilder.ImageTestsConfiguration'>, False),'InfrastructureConfigurationArn': (<class 'str'>, True), 'Tags': (<class 'dict'>,False)}

resource_type: Optional[str] = 'AWS::ImageBuilder::Image'

class troposphere.imagebuilder.ImagePipeline(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

ImagePipeline

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContainerRecipeArn': (<class 'str'>, False), 'Description': (<class 'str'>,False), 'DistributionConfigurationArn': (<class 'str'>, False),'EnhancedImageMetadataEnabled': (<function boolean>, False), 'ImageRecipeArn':(<class 'str'>, False), 'ImageTestsConfiguration': (<class'troposphere.imagebuilder.ImageTestsConfiguration'>, False),'InfrastructureConfigurationArn': (<class 'str'>, True), 'Name': (<class 'str'>,True), 'Schedule': (<class 'troposphere.imagebuilder.Schedule'>, False), 'Status':(<function imagepipeline_status>, False), 'Tags': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::ImageBuilder::ImagePipeline'

class troposphere.imagebuilder.ImageRecipe(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

ImageRecipe

422 Chapter 7. Licensing

Page 427: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AdditionalInstanceConfiguration': (<class'troposphere.imagebuilder.AdditionalInstanceConfiguration'>, False),'BlockDeviceMappings': ([<class'troposphere.imagebuilder.InstanceBlockDeviceMapping'>], False), 'Components':([<class 'troposphere.imagebuilder.ComponentConfiguration'>], True), 'Description':(<class 'str'>, False), 'Name': (<class 'str'>, True), 'ParentImage': (<class'str'>, True), 'Tags': (<class 'dict'>, False), 'Version': (<class 'str'>, True),'WorkingDirectory': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::ImageBuilder::ImageRecipe'

class troposphere.imagebuilder.ImageTestsConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ImageTestsConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ImageTestsEnabled': (<function boolean>, False), 'TimeoutMinutes': (<functioninteger>, False)}

class troposphere.imagebuilder.InfrastructureConfiguration(title: Optional[str], template:Optional[troposphere.Template] =None, validation: bool = True,**kwargs: Any)

Bases: troposphere.AWSObject

InfrastructureConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'InstanceMetadataOptions': (<class'troposphere.imagebuilder.InstanceMetadataOptions'>, False), 'InstanceProfileName':(<class 'str'>, True), 'InstanceTypes': ([<class 'str'>], False), 'KeyPair':(<class 'str'>, False), 'Logging': (<class 'troposphere.imagebuilder.Logging'>,False), 'Name': (<class 'str'>, True), 'ResourceTags': (<class 'dict'>, False),'SecurityGroupIds': ([<class 'str'>], False), 'SnsTopicArn': (<class 'str'>,False), 'SubnetId': (<class 'str'>, False), 'Tags': (<class 'dict'>, False),'TerminateInstanceOnFailure': (<function boolean>, False)}

resource_type: Optional[str] = 'AWS::ImageBuilder::InfrastructureConfiguration'

class troposphere.imagebuilder.InstanceBlockDeviceMapping(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

InstanceBlockDeviceMapping

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeviceName': (<class 'str'>, False), 'Ebs': (<class'troposphere.imagebuilder.EbsInstanceBlockDeviceSpecification'>, False), 'NoDevice':(<class 'str'>, False), 'VirtualName': (<class 'str'>, False)}

class troposphere.imagebuilder.InstanceConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InstanceConfiguration

7.3. troposphere 423

Page 428: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BlockDeviceMappings': ([<class'troposphere.imagebuilder.InstanceBlockDeviceMapping'>], False), 'Image': (<class'str'>, False)}

class troposphere.imagebuilder.InstanceMetadataOptions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InstanceMetadataOptions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HttpPutResponseHopLimit': (<function integer>, False), 'HttpTokens': (<class'str'>, False)}

class troposphere.imagebuilder.LaunchPermissionConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

LaunchPermissionConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'OrganizationArns': ([<class 'str'>], False), 'OrganizationalUnitArns': ([<class'str'>], False), 'UserGroups': ([<class 'str'>], False), 'UserIds': ([<class'str'>], False)}

class troposphere.imagebuilder.LaunchTemplateConfiguration(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

LaunchTemplateConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccountId': (<class 'str'>, False), 'LaunchTemplateId': (<class 'str'>, False),'SetDefaultVersion': (<function boolean>, False)}

class troposphere.imagebuilder.Logging(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Logging

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'S3Logs': (<class 'troposphere.imagebuilder.S3Logs'>, False)}

class troposphere.imagebuilder.S3Logs(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3Logs

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'S3BucketName': (<class 'str'>, False), 'S3KeyPrefix': (<class 'str'>, False)}

class troposphere.imagebuilder.Schedule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Schedule

424 Chapter 7. Licensing

Page 429: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PipelineExecutionStartCondition': (<functionschedule_pipelineexecutionstartcondition>, False), 'ScheduleExpression': (<class'str'>, False)}

class troposphere.imagebuilder.SystemsManagerAgent(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SystemsManagerAgent

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'UninstallAfterBuild': (<function boolean>, False)}

class troposphere.imagebuilder.TargetContainerRepository(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

TargetContainerRepository

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RepositoryName': (<class 'str'>, False), 'Service': (<class 'str'>, False)}

troposphere.inspector module

class troposphere.inspector.AssessmentTarget(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

AssessmentTarget

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssessmentTargetName': (<class 'str'>, False), 'ResourceGroupArn': (<class'str'>, False)}

resource_type: Optional[str] = 'AWS::Inspector::AssessmentTarget'

class troposphere.inspector.AssessmentTemplate(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

AssessmentTemplate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssessmentTargetArn': (<class 'str'>, True), 'AssessmentTemplateName': (<class'str'>, False), 'DurationInSeconds': (<function integer>, True),'RulesPackageArns': ([<class 'str'>], True), 'UserAttributesForFindings': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::Inspector::AssessmentTemplate'

7.3. troposphere 425

Page 430: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.inspector.ResourceGroup(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

ResourceGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ResourceGroupTags': (<class 'troposphere.Tags'>, True)}

resource_type: Optional[str] = 'AWS::Inspector::ResourceGroup'

troposphere.iot module

class troposphere.iot.AccountAuditConfiguration(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

AccountAuditConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccountId': (<class 'str'>, True), 'AuditCheckConfigurations': (<class'troposphere.iot.AuditCheckConfigurations'>, True),'AuditNotificationTargetConfigurations': (<class'troposphere.iot.AuditNotificationTargetConfigurations'>, False), 'RoleArn':(<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::IoT::AccountAuditConfiguration'

class troposphere.iot.Action(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Action

426 Chapter 7. Licensing

Page 431: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CloudwatchAlarm': (<class 'troposphere.iot.CloudwatchAlarmAction'>, False),'CloudwatchLogs': (<class 'troposphere.iot.CloudwatchLogsAction'>, False),'CloudwatchMetric': (<class 'troposphere.iot.CloudwatchMetricAction'>, False),'DynamoDB': (<class 'troposphere.iot.DynamoDBAction'>, False), 'DynamoDBv2':(<class 'troposphere.iot.DynamoDBv2Action'>, False), 'Elasticsearch': (<class'troposphere.iot.ElasticsearchAction'>, False), 'Firehose': (<class'troposphere.iot.FirehoseAction'>, False), 'Http': (<class'troposphere.iot.HttpAction'>, False), 'IotAnalytics': (<class'troposphere.iot.IotAnalyticsAction'>, False), 'IotEvents': (<class'troposphere.iot.IotEventsAction'>, False), 'IotSiteWise': (<class'troposphere.iot.IotSiteWiseAction'>, False), 'Kafka': (<class'troposphere.iot.KafkaAction'>, False), 'Kinesis': (<class'troposphere.iot.KinesisAction'>, False), 'Lambda': (<class'troposphere.iot.LambdaAction'>, False), 'OpenSearch': (<class'troposphere.iot.OpenSearchAction'>, False), 'Republish': (<class'troposphere.iot.RepublishAction'>, False), 'S3': (<class'troposphere.iot.S3Action'>, False), 'Sns': (<class 'troposphere.iot.SnsAction'>,False), 'Sqs': (<class 'troposphere.iot.SqsAction'>, False), 'StepFunctions':(<class 'troposphere.iot.StepFunctionsAction'>, False), 'Timestream': (<class'troposphere.iot.TimestreamAction'>, False)}

class troposphere.iot.ActionParams(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ActionParams

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AddThingsToThingGroupParams': (<class'troposphere.iot.AddThingsToThingGroupParams'>, False), 'EnableIoTLoggingParams':(<class 'troposphere.iot.EnableIoTLoggingParams'>, False),'PublishFindingToSnsParams': (<class 'troposphere.iot.PublishFindingToSnsParams'>,False), 'ReplaceDefaultPolicyVersionParams': (<class'troposphere.iot.ReplaceDefaultPolicyVersionParams'>, False),'UpdateCACertificateParams': (<class 'troposphere.iot.UpdateCACertificateParams'>,False), 'UpdateDeviceCertificateParams': (<class'troposphere.iot.UpdateDeviceCertificateParams'>, False)}

class troposphere.iot.AddThingsToThingGroupParams(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AddThingsToThingGroupParams

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'OverrideDynamicGroups': (<function boolean>, False), 'ThingGroupNames': ([<class'str'>], True)}

class troposphere.iot.AggregationType(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AggregationType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'Values': ([<class 'str'>], True)}

7.3. troposphere 427

Page 432: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.iot.AlertTarget(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AlertTarget

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AlertTargetArn': (<class 'str'>, True), 'RoleArn': (<class 'str'>, True)}

class troposphere.iot.AssetPropertyTimestamp(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AssetPropertyTimestamp

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'OffsetInNanos': (<class 'str'>, False), 'TimeInSeconds': (<class 'str'>, True)}

class troposphere.iot.AssetPropertyValue(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AssetPropertyValue

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Quality': (<class 'str'>, False), 'Timestamp': (<class'troposphere.iot.AssetPropertyTimestamp'>, True), 'Value': (<class'troposphere.iot.AssetPropertyVariant'>, True)}

class troposphere.iot.AssetPropertyVariant(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AssetPropertyVariant

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BooleanValue': (<class 'str'>, False), 'DoubleValue': (<class 'str'>, False),'IntegerValue': (<class 'str'>, False), 'StringValue': (<class 'str'>, False)}

class troposphere.iot.AttributePayload(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AttributePayload

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Attributes': (<class 'dict'>, False)}

class troposphere.iot.AuditCheckConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AuditCheckConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False)}

class troposphere.iot.AuditCheckConfigurations(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AuditCheckConfigurations

428 Chapter 7. Licensing

Page 433: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthenticatedCognitoRoleOverlyPermissiveCheck': (<class'troposphere.iot.AuditCheckConfiguration'>, False), 'CaCertificateExpiringCheck':(<class 'troposphere.iot.AuditCheckConfiguration'>, False),'CaCertificateKeyQualityCheck': (<class 'troposphere.iot.AuditCheckConfiguration'>,False), 'ConflictingClientIdsCheck': (<class'troposphere.iot.AuditCheckConfiguration'>, False),'DeviceCertificateExpiringCheck': (<class'troposphere.iot.AuditCheckConfiguration'>, False),'DeviceCertificateKeyQualityCheck': (<class'troposphere.iot.AuditCheckConfiguration'>, False), 'DeviceCertificateSharedCheck':(<class 'troposphere.iot.AuditCheckConfiguration'>, False),'IotPolicyOverlyPermissiveCheck': (<class'troposphere.iot.AuditCheckConfiguration'>, False),'IotRoleAliasAllowsAccessToUnusedServicesCheck': (<class'troposphere.iot.AuditCheckConfiguration'>, False),'IotRoleAliasOverlyPermissiveCheck': (<class'troposphere.iot.AuditCheckConfiguration'>, False), 'LoggingDisabledCheck': (<class'troposphere.iot.AuditCheckConfiguration'>, False),'RevokedCaCertificateStillActiveCheck': (<class'troposphere.iot.AuditCheckConfiguration'>, False),'RevokedDeviceCertificateStillActiveCheck': (<class'troposphere.iot.AuditCheckConfiguration'>, False),'UnauthenticatedCognitoRoleOverlyPermissiveCheck': (<class'troposphere.iot.AuditCheckConfiguration'>, False)}

class troposphere.iot.AuditNotificationTarget(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AuditNotificationTarget

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False), 'RoleArn': (<class 'str'>, False),'TargetArn': (<class 'str'>, False)}

class troposphere.iot.AuditNotificationTargetConfigurations(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

AuditNotificationTargetConfigurations

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Sns':(<class 'troposphere.iot.AuditNotificationTarget'>, False)}

class troposphere.iot.Authorizer(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Authorizer

7.3. troposphere 429

Page 434: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthorizerFunctionArn': (<class 'str'>, True), 'AuthorizerName': (<class 'str'>,False), 'EnableCachingForHttp': (<function boolean>, False), 'SigningDisabled':(<function boolean>, False), 'Status': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False), 'TokenKeyName': (<class 'str'>, False),'TokenSigningPublicKeys': (<class 'dict'>, False)}

resource_type: Optional[str] = 'AWS::IoT::Authorizer'

class troposphere.iot.AuthorizerConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AuthorizerConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllowAuthorizerOverride': (<function boolean>, False), 'DefaultAuthorizerName':(<class 'str'>, False)}

class troposphere.iot.Behavior(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Behavior

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Criteria': (<class 'troposphere.iot.BehaviorCriteria'>, False), 'Metric':(<class 'str'>, False), 'MetricDimension': (<class'troposphere.iot.MetricDimension'>, False), 'Name': (<class 'str'>, True),'SuppressAlerts': (<function boolean>, False)}

class troposphere.iot.BehaviorCriteria(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

BehaviorCriteria

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComparisonOperator': (<class 'str'>, False), 'ConsecutiveDatapointsToAlarm':(<function integer>, False), 'ConsecutiveDatapointsToClear': (<function integer>,False), 'DurationSeconds': (<function integer>, False), 'MlDetectionConfig':(<class 'troposphere.iot.MachineLearningDetectionConfig'>, False),'StatisticalThreshold': (<class 'troposphere.iot.StatisticalThreshold'>, False),'Value': (<class 'troposphere.iot.MetricValue'>, False)}

class troposphere.iot.Certificate(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Certificate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CACertificatePem': (<class 'str'>, False), 'CertificateMode': (<class 'str'>,False), 'CertificatePem': (<class 'str'>, False), 'CertificateSigningRequest':(<class 'str'>, False), 'Status': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::IoT::Certificate'

430 Chapter 7. Licensing

Page 435: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.iot.CloudwatchAlarmAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CloudwatchAlarmAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AlarmName': (<class 'str'>, True), 'RoleArn': (<class 'str'>, True),'StateReason': (<class 'str'>, True), 'StateValue': (<class 'str'>, True)}

class troposphere.iot.CloudwatchLogsAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CloudwatchLogsAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LogGroupName': (<class 'str'>, True), 'RoleArn': (<class 'str'>, True)}

class troposphere.iot.CloudwatchMetricAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CloudwatchMetricAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MetricName': (<class 'str'>, True), 'MetricNamespace': (<class 'str'>, True),'MetricTimestamp': (<class 'str'>, False), 'MetricUnit': (<class 'str'>, True),'MetricValue': (<class 'str'>, True), 'RoleArn': (<class 'str'>, True)}

class troposphere.iot.CustomMetric(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

CustomMetric

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DisplayName': (<class 'str'>, False), 'MetricName': (<class 'str'>, False),'MetricType': (<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoT::CustomMetric'

class troposphere.iot.Dimension(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Dimension

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'StringValues': ([<class 'str'>], True), 'Tags':(<class 'troposphere.Tags'>, False), 'Type': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::IoT::Dimension'

class troposphere.iot.DomainConfiguration(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

DomainConfiguration

7.3. troposphere 431

Page 436: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AuthorizerConfig': (<class 'troposphere.iot.AuthorizerConfig'>, False),'DomainConfigurationName': (<class 'str'>, False), 'DomainConfigurationStatus':(<class 'str'>, False), 'DomainName': (<class 'str'>, False),'ServerCertificateArns': ([<class 'str'>], False), 'ServiceType': (<class 'str'>,False), 'Tags': (<class 'troposphere.Tags'>, False), 'ValidationCertificateArn':(<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::IoT::DomainConfiguration'

class troposphere.iot.DynamoDBAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DynamoDBAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HashKeyField': (<class 'str'>, True), 'HashKeyType': (<class 'str'>, False),'HashKeyValue': (<class 'str'>, True), 'PayloadField': (<class 'str'>, False),'RangeKeyField': (<class 'str'>, False), 'RangeKeyType': (<class 'str'>, False),'RangeKeyValue': (<class 'str'>, False), 'RoleArn': (<class 'str'>, True),'TableName': (<class 'str'>, True)}

class troposphere.iot.DynamoDBv2Action(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DynamoDBv2Action

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PutItem': (<class 'troposphere.iot.PutItemInput'>, False), 'RoleArn': (<class'str'>, False)}

class troposphere.iot.ElasticsearchAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ElasticsearchAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Endpoint': (<class 'str'>, True), 'Id': (<class 'str'>, True), 'Index': (<class'str'>, True), 'RoleArn': (<class 'str'>, True), 'Type': (<class 'str'>, True)}

class troposphere.iot.EnableIoTLoggingParams(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

EnableIoTLoggingParams

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LogLevel': (<class 'str'>, True), 'RoleArnForLogging': (<class 'str'>, True)}

class troposphere.iot.FirehoseAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FirehoseAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BatchMode': (<function boolean>, False), 'DeliveryStreamName': (<class 'str'>,True), 'RoleArn': (<class 'str'>, True), 'Separator': (<class 'str'>, False)}

432 Chapter 7. Licensing

Page 437: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.iot.FleetMetric(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

FleetMetric

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AggregationField': (<class 'str'>, False), 'AggregationType': (<class'troposphere.iot.AggregationType'>, False), 'Description': (<class 'str'>, False),'IndexName': (<class 'str'>, False), 'MetricName': (<class 'str'>, True),'Period': (<function integer>, False), 'QueryString': (<class 'str'>, False),'QueryVersion': (<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>,False), 'Unit': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::IoT::FleetMetric'

class troposphere.iot.HttpAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Auth': (<class 'troposphere.iot.HttpAuthorization'>, False), 'ConfirmationUrl':(<class 'str'>, False), 'Headers': ([<class 'troposphere.iot.HttpActionHeader'>],False), 'Url': (<class 'str'>, True)}

class troposphere.iot.HttpActionHeader(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpActionHeader

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Key':(<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.iot.HttpAuthorization(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpAuthorization

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Sigv4': (<class 'troposphere.iot.SigV4Authorization'>, False)}

class troposphere.iot.HttpUrlDestinationSummary(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

HttpUrlDestinationSummary

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConfirmationUrl': (<class 'str'>, False)}

class troposphere.iot.IotAnalyticsAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

IotAnalyticsAction

7.3. troposphere 433

Page 438: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BatchMode': (<function boolean>, False), 'ChannelName': (<class 'str'>, True),'RoleArn': (<class 'str'>, True)}

class troposphere.iot.IotEventsAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

IotEventsAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BatchMode': (<function boolean>, False), 'InputName': (<class 'str'>, True),'MessageId': (<class 'str'>, False), 'RoleArn': (<class 'str'>, True)}

class troposphere.iot.IotSiteWiseAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

IotSiteWiseAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PutAssetPropertyValueEntries': ([<class'troposphere.iot.PutAssetPropertyValueEntry'>], True), 'RoleArn': (<class 'str'>,True)}

class troposphere.iot.JobTemplate(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

JobTemplate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AbortConfig': (<function validate_json_checker>, False), 'Description': (<class'str'>, True), 'Document': (<class 'str'>, False), 'DocumentSource': (<class'str'>, False), 'JobArn': (<class 'str'>, False), 'JobExecutionsRetryConfig':(<class 'dict'>, False), 'JobExecutionsRolloutConfig': (<functionvalidate_json_checker>, False), 'JobTemplateId': (<class 'str'>, True),'PresignedUrlConfig': (<class 'dict'>, False), 'Tags': (<class'troposphere.Tags'>, False), 'TimeoutConfig': (<function validate_json_checker>,False)}

resource_type: Optional[str] = 'AWS::IoT::JobTemplate'

class troposphere.iot.KafkaAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KafkaAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClientProperties': (<class 'dict'>, True), 'DestinationArn': (<class 'str'>,True), 'Key': (<class 'str'>, False), 'Partition': (<class 'str'>, False),'Topic': (<class 'str'>, True)}

class troposphere.iot.KinesisAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

KinesisAction

434 Chapter 7. Licensing

Page 439: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PartitionKey': (<class 'str'>, False), 'RoleArn': (<class 'str'>, True),'StreamName': (<class 'str'>, True)}

class troposphere.iot.LambdaAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LambdaAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FunctionArn': (<class 'str'>, False)}

class troposphere.iot.Logging(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Logging

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccountId': (<class 'str'>, True), 'DefaultLogLevel': (<class 'str'>, True),'RoleArn': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::IoT::Logging'

class troposphere.iot.MachineLearningDetectionConfig(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MachineLearningDetectionConfig

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConfidenceLevel': (<class 'str'>, False)}

class troposphere.iot.MetricDimension(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MetricDimension

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DimensionName': (<class 'str'>, True), 'Operator': (<class 'str'>, False)}

class troposphere.iot.MetricToRetain(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MetricToRetain

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Metric': (<class 'str'>, True), 'MetricDimension': (<class'troposphere.iot.MetricDimension'>, False)}

class troposphere.iot.MetricValue(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MetricValue

7.3. troposphere 435

Page 440: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Cidrs': ([<class 'str'>], False), 'Count': (<class 'str'>, False), 'Number':(<function double>, False), 'Numbers': ([<function double>], False), 'Ports':([<function integer>], False), 'Strings': ([<class 'str'>], False)}

class troposphere.iot.MitigationAction(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

MitigationAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ActionName': (<class 'str'>, False), 'ActionParams': (<class'troposphere.iot.ActionParams'>, True), 'RoleArn': (<class 'str'>, True), 'Tags':(<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoT::MitigationAction'

class troposphere.iot.OpenSearchAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OpenSearchAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Endpoint': (<class 'str'>, True), 'Id': (<class 'str'>, True), 'Index': (<class'str'>, True), 'RoleArn': (<class 'str'>, True), 'Type': (<class 'str'>, True)}

class troposphere.iot.Policy(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Policy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PolicyDocument': (<function policytypes>, True), 'PolicyName': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::IoT::Policy'

class troposphere.iot.PolicyPrincipalAttachment(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

PolicyPrincipalAttachment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PolicyName': (<class 'str'>, True), 'Principal': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::IoT::PolicyPrincipalAttachment'

class troposphere.iot.ProvisioningHook(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ProvisioningHook

436 Chapter 7. Licensing

Page 441: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PayloadVersion': (<class 'str'>, False), 'TargetArn': (<class 'str'>, False)}

class troposphere.iot.ProvisioningTemplate(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

ProvisioningTemplate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'Enabled': (<function boolean>, False),'PreProvisioningHook': (<class 'troposphere.iot.ProvisioningHook'>, False),'ProvisioningRoleArn': (<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>,False), 'TemplateBody': (<class 'str'>, True), 'TemplateName': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::IoT::ProvisioningTemplate'

class troposphere.iot.PublishFindingToSnsParams(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PublishFindingToSnsParams

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TopicArn': (<class 'str'>, True)}

class troposphere.iot.PutAssetPropertyValueEntry(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PutAssetPropertyValueEntry

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssetId': (<class 'str'>, False), 'EntryId': (<class 'str'>, False),'PropertyAlias': (<class 'str'>, False), 'PropertyId': (<class 'str'>, False),'PropertyValues': ([<class 'troposphere.iot.AssetPropertyValue'>], True)}

class troposphere.iot.PutItemInput(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PutItemInput

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TableName': (<class 'str'>, True)}

class troposphere.iot.ReplaceDefaultPolicyVersionParams(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

ReplaceDefaultPolicyVersionParams

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TemplateName': (<class 'str'>, True)}

class troposphere.iot.RepublishAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 437

Page 442: Release 3.1

troposphere Documentation, Release 4.0.1

RepublishAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'Qos':(<function integer>, False), 'RoleArn': (<class 'str'>, True), 'Topic': (<class'str'>, True)}

class troposphere.iot.ResourceSpecificLogging(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ResourceSpecificLogging

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LogLevel': (<class 'str'>, True), 'TargetName': (<class 'str'>, True),'TargetType': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::IoT::ResourceSpecificLogging'

class troposphere.iot.S3Action(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3Action

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketName': (<class 'str'>, True), 'CannedAcl': (<class 'str'>, False), 'Key':(<class 'str'>, True), 'RoleArn': (<class 'str'>, True)}

class troposphere.iot.ScheduledAudit(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ScheduledAudit

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DayOfMonth': (<class 'str'>, False), 'DayOfWeek': (<class 'str'>, False),'Frequency': (<class 'str'>, True), 'ScheduledAuditName': (<class 'str'>, False),'Tags': (<class 'troposphere.Tags'>, False), 'TargetCheckNames': ([<class 'str'>],True)}

resource_type: Optional[str] = 'AWS::IoT::ScheduledAudit'

class troposphere.iot.SecurityProfile(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

SecurityProfile

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AdditionalMetricsToRetainV2': ([<class 'troposphere.iot.MetricToRetain'>],False), 'AlertTargets': (<class 'dict'>, False), 'Behaviors': ([<class'troposphere.iot.Behavior'>], False), 'SecurityProfileDescription': (<class 'str'>,False), 'SecurityProfileName': (<class 'str'>, False), 'Tags': (<class'troposphere.Tags'>, False), 'TargetArns': ([<class 'str'>], False)}

resource_type: Optional[str] = 'AWS::IoT::SecurityProfile'

438 Chapter 7. Licensing

Page 443: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.iot.ServerCertificateSummary(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ServerCertificateSummary

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ServerCertificateArn': (<class 'str'>, False), 'ServerCertificateStatus':(<class 'str'>, False), 'ServerCertificateStatusDetail': (<class 'str'>, False)}

class troposphere.iot.SigV4Authorization(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SigV4Authorization

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RoleArn': (<class 'str'>, True), 'ServiceName': (<class 'str'>, True),'SigningRegion': (<class 'str'>, True)}

class troposphere.iot.SnsAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SnsAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MessageFormat': (<class 'str'>, False), 'RoleArn': (<class 'str'>, True),'TargetArn': (<class 'str'>, True)}

class troposphere.iot.SqsAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SqsAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'QueueUrl': (<class 'str'>, True), 'RoleArn': (<class 'str'>, True), 'UseBase64':(<function boolean>, False)}

class troposphere.iot.StatisticalThreshold(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

StatisticalThreshold

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Statistic': (<class 'str'>, False)}

class troposphere.iot.StepFunctionsAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

StepFunctionsAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ExecutionNamePrefix': (<class 'str'>, False), 'RoleArn': (<class 'str'>, True),'StateMachineName': (<class 'str'>, True)}

class troposphere.iot.Thing(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

7.3. troposphere 439

Page 444: Release 3.1

troposphere Documentation, Release 4.0.1

Thing

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AttributePayload': (<class 'troposphere.iot.AttributePayload'>, False),'ThingName': (<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::IoT::Thing'

class troposphere.iot.ThingPrincipalAttachment(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

ThingPrincipalAttachment

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Principal': (<class 'str'>, True), 'ThingName': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::IoT::ThingPrincipalAttachment'

class troposphere.iot.TimestreamAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TimestreamAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BatchMode': (<function boolean>, False), 'DatabaseName': (<class 'str'>, True),'Dimensions': ([<class 'troposphere.iot.TimestreamDimension'>], True), 'RoleArn':(<class 'str'>, True), 'TableName': (<class 'str'>, True), 'Timestamp': (<class'troposphere.iot.TimestreamTimestamp'>, False)}

class troposphere.iot.TimestreamDimension(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TimestreamDimension

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.iot.TimestreamTimestamp(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TimestreamTimestamp

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Unit': (<class 'str'>, True), 'Value': (<class 'str'>, True)}

class troposphere.iot.TopicRule(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

TopicRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RuleName': (<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>, False),'TopicRulePayload': (<class 'troposphere.iot.TopicRulePayload'>, True)}

440 Chapter 7. Licensing

Page 445: Release 3.1

troposphere Documentation, Release 4.0.1

resource_type: Optional[str] = 'AWS::IoT::TopicRule'

class troposphere.iot.TopicRuleDestination(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

TopicRuleDestination

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HttpUrlProperties': (<class 'troposphere.iot.HttpUrlDestinationSummary'>, False),'Status': (<class 'str'>, False), 'VpcProperties': (<class'troposphere.iot.VpcDestinationProperties'>, False)}

resource_type: Optional[str] = 'AWS::IoT::TopicRuleDestination'

class troposphere.iot.TopicRulePayload(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TopicRulePayload

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Actions': ([<class 'troposphere.iot.Action'>], True), 'AwsIotSqlVersion':(<class 'str'>, False), 'Description': (<class 'str'>, False), 'ErrorAction':(<class 'troposphere.iot.Action'>, False), 'RuleDisabled': (<function boolean>,False), 'Sql': (<class 'str'>, True)}

class troposphere.iot.UpdateCACertificateParams(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

UpdateCACertificateParams

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Action': (<class 'str'>, True)}

class troposphere.iot.UpdateDeviceCertificateParams(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

UpdateDeviceCertificateParams

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Action': (<class 'str'>, True)}

class troposphere.iot.VpcDestinationProperties(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VpcDestinationProperties

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RoleArn': (<class 'str'>, False), 'SecurityGroups': ([<class 'str'>], False),'SubnetIds': ([<class 'str'>], False), 'VpcId': (<class 'str'>, False)}

7.3. troposphere 441

Page 446: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.iot1click module

class troposphere.iot1click.Device(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Device

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeviceId': (<class 'str'>, True), 'Enabled': (<function boolean>, True)}

resource_type: Optional[str] = 'AWS::IoT1Click::Device'

class troposphere.iot1click.DeviceTemplate(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DeviceTemplate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CallbackOverrides': (<class 'dict'>, False), 'DeviceType': (<class 'str'>,False)}

class troposphere.iot1click.Placement(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Placement

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssociatedDevices': (<function validate_json_checker>, False), 'Attributes':(<function validate_json_checker>, False), 'PlacementName': (<class 'str'>, False),'ProjectName': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::IoT1Click::Placement'

class troposphere.iot1click.PlacementTemplate(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PlacementTemplate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DefaultAttributes': (<function validate_json_checker>, False), 'DeviceTemplates':(<function validate_json_checker>, False)}

class troposphere.iot1click.Project(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Project

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'PlacementTemplate': (<class'troposphere.iot1click.PlacementTemplate'>, True), 'ProjectName': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::IoT1Click::Project'

442 Chapter 7. Licensing

Page 447: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.iotanalytics module

class troposphere.iotanalytics.Action(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Action

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ActionName': (<class 'str'>, True), 'ContainerAction': (<class'troposphere.iotanalytics.ContainerAction'>, False), 'QueryAction': (<class'troposphere.iotanalytics.QueryAction'>, False)}

class troposphere.iotanalytics.Activity(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Activity

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AddAttributes': (<class 'troposphere.iotanalytics.AddAttributes'>, False),'Channel': (<class 'troposphere.iotanalytics.ActivityChannel'>, False),'Datastore': (<class 'troposphere.iotanalytics.ActivityDatastore'>, False),'DeviceRegistryEnrich': (<class 'troposphere.iotanalytics.DeviceRegistryEnrich'>,False), 'DeviceShadowEnrich': (<class'troposphere.iotanalytics.DeviceShadowEnrich'>, False), 'Filter': (<class'troposphere.iotanalytics.Filter'>, False), 'Lambda': (<class'troposphere.iotanalytics.Lambda'>, False), 'Math': (<class'troposphere.iotanalytics.Math'>, False), 'RemoveAttributes': (<class'troposphere.iotanalytics.RemoveAttributes'>, False), 'SelectAttributes': (<class'troposphere.iotanalytics.SelectAttributes'>, False)}

class troposphere.iotanalytics.ActivityChannel(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ActivityChannel

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ChannelName': (<class 'str'>, True), 'Name': (<class 'str'>, True), 'Next':(<class 'str'>, False)}

class troposphere.iotanalytics.ActivityDatastore(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ActivityDatastore

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DatastoreName': (<class 'str'>, True), 'Name': (<class 'str'>, True)}

class troposphere.iotanalytics.AddAttributes(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AddAttributes

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Attributes': (<class 'dict'>, True), 'Name': (<class 'str'>, True), 'Next':(<class 'str'>, False)}

7.3. troposphere 443

Page 448: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.iotanalytics.Channel(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Channel

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ChannelName': (<class 'str'>, False), 'ChannelStorage': (<class'troposphere.iotanalytics.ChannelStorage'>, False), 'RetentionPeriod': (<class'troposphere.iotanalytics.RetentionPeriod'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTAnalytics::Channel'

class troposphere.iotanalytics.ChannelStorage(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ChannelStorage

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CustomerManagedS3': (<class 'troposphere.iotanalytics.CustomerManagedS3'>,False), 'ServiceManagedS3': (<class 'dict'>, False)}

class troposphere.iotanalytics.Column(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Column

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'Type': (<class 'str'>, True)}

class troposphere.iotanalytics.ContainerAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ContainerAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ExecutionRoleArn': (<class 'str'>, True), 'Image': (<class 'str'>, True),'ResourceConfiguration': (<class 'troposphere.iotanalytics.ResourceConfiguration'>,True), 'Variables': ([<class 'troposphere.iotanalytics.Variable'>], False)}

class troposphere.iotanalytics.CustomerManagedS3(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CustomerManagedS3

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Bucket': (<class 'str'>, True), 'KeyPrefix': (<class 'str'>, False), 'RoleArn':(<class 'str'>, True)}

class troposphere.iotanalytics.CustomerManagedS3Storage(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

CustomerManagedS3Storage

444 Chapter 7. Licensing

Page 449: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Bucket': (<class 'str'>, True), 'KeyPrefix': (<class 'str'>, False)}

class troposphere.iotanalytics.Dataset(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Dataset

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Actions': ([<class 'troposphere.iotanalytics.Action'>], True),'ContentDeliveryRules': ([<class'troposphere.iotanalytics.DatasetContentDeliveryRule'>], False), 'DatasetName':(<class 'str'>, False), 'LateDataRules': ([<class'troposphere.iotanalytics.LateDataRule'>], False), 'RetentionPeriod': (<class'troposphere.iotanalytics.RetentionPeriod'>, False), 'Tags': (<class'troposphere.Tags'>, False), 'Triggers': ([<class'troposphere.iotanalytics.Trigger'>], False), 'VersioningConfiguration': (<class'troposphere.iotanalytics.VersioningConfiguration'>, False)}

resource_type: Optional[str] = 'AWS::IoTAnalytics::Dataset'

class troposphere.iotanalytics.DatasetContentDeliveryRule(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

DatasetContentDeliveryRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Destination': (<class'troposphere.iotanalytics.DatasetContentDeliveryRuleDestination'>, True),'EntryName': (<class 'str'>, False)}

class troposphere.iotanalytics.DatasetContentDeliveryRuleDestination(title: Optional[str] =None, **kwargs: Any)

Bases: troposphere.AWSProperty

DatasetContentDeliveryRuleDestination

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'IotEventsDestinationConfiguration': (<class'troposphere.iotanalytics.IotEventsDestinationConfiguration'>, False),'S3DestinationConfiguration': (<class'troposphere.iotanalytics.S3DestinationConfiguration'>, False)}

class troposphere.iotanalytics.DatasetContentVersionValue(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

DatasetContentVersionValue

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DatasetName': (<class 'str'>, True)}

7.3. troposphere 445

Page 450: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.iotanalytics.Datastore(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Datastore

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DatastoreName': (<class 'str'>, False), 'DatastorePartitions': (<class'troposphere.iotanalytics.DatastorePartitions'>, False), 'DatastoreStorage':(<class 'troposphere.iotanalytics.DatastoreStorage'>, False),'FileFormatConfiguration': (<class'troposphere.iotanalytics.FileFormatConfiguration'>, False), 'RetentionPeriod':(<class 'troposphere.iotanalytics.RetentionPeriod'>, False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTAnalytics::Datastore'

class troposphere.iotanalytics.DatastorePartition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DatastorePartition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Partition': (<class 'troposphere.iotanalytics.Partition'>, False),'TimestampPartition': (<class 'troposphere.iotanalytics.TimestampPartition'>,False)}

class troposphere.iotanalytics.DatastorePartitions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DatastorePartitions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Partitions': ([<class 'troposphere.iotanalytics.DatastorePartition'>], False)}

class troposphere.iotanalytics.DatastoreStorage(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DatastoreStorage

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CustomerManagedS3': (<class 'troposphere.iotanalytics.CustomerManagedS3'>,False), 'IotSiteWiseMultiLayerStorage': (<class'troposphere.iotanalytics.IotSiteWiseMultiLayerStorage'>, False),'ServiceManagedS3': (<class 'dict'>, False)}

class troposphere.iotanalytics.DeltaTime(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DeltaTime

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'OffsetSeconds': (<function integer>, True), 'TimeExpression': (<class 'str'>,True)}

446 Chapter 7. Licensing

Page 451: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.iotanalytics.DeltaTimeSessionWindowConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

DeltaTimeSessionWindowConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TimeoutInMinutes': (<function integer>, True)}

class troposphere.iotanalytics.DeviceRegistryEnrich(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DeviceRegistryEnrich

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Attribute': (<class 'str'>, True), 'Name': (<class 'str'>, True), 'Next':(<class 'str'>, False), 'RoleArn': (<class 'str'>, True), 'ThingName': (<class'str'>, True)}

class troposphere.iotanalytics.DeviceShadowEnrich(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DeviceShadowEnrich

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Attribute': (<class 'str'>, True), 'Name': (<class 'str'>, True), 'Next':(<class 'str'>, False), 'RoleArn': (<class 'str'>, True), 'ThingName': (<class'str'>, True)}

class troposphere.iotanalytics.FileFormatConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FileFormatConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'JsonConfiguration': (<class 'dict'>, False), 'ParquetConfiguration': (<class'troposphere.iotanalytics.ParquetConfiguration'>, False)}

class troposphere.iotanalytics.Filter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Filter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Filter': (<class 'str'>, True), 'Name': (<class 'str'>, True), 'Next': (<class'str'>, False)}

class troposphere.iotanalytics.GlueConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GlueConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DatabaseName': (<class 'str'>, True), 'TableName': (<class 'str'>, True)}

7.3. troposphere 447

Page 452: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.iotanalytics.IotEventsDestinationConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

IotEventsDestinationConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InputName': (<class 'str'>, True), 'RoleArn': (<class 'str'>, True)}

class troposphere.iotanalytics.IotSiteWiseMultiLayerStorage(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

IotSiteWiseMultiLayerStorage

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CustomerManagedS3Storage': (<class'troposphere.iotanalytics.CustomerManagedS3Storage'>, False)}

class troposphere.iotanalytics.Lambda(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Lambda

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BatchSize': (<function integer>, True), 'LambdaName': (<class 'str'>, True),'Name': (<class 'str'>, True), 'Next': (<class 'str'>, False)}

class troposphere.iotanalytics.LateDataRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LateDataRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RuleConfiguration': (<class'troposphere.iotanalytics.LateDataRuleConfiguration'>, True), 'RuleName': (<class'str'>, False)}

class troposphere.iotanalytics.LateDataRuleConfiguration(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

LateDataRuleConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeltaTimeSessionWindowConfiguration': (<class'troposphere.iotanalytics.DeltaTimeSessionWindowConfiguration'>, False)}

class troposphere.iotanalytics.Math(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Math

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Attribute': (<class 'str'>, True), 'Math': (<class 'str'>, True), 'Name':(<class 'str'>, True), 'Next': (<class 'str'>, False)}

448 Chapter 7. Licensing

Page 453: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.iotanalytics.OutputFileUriValue(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OutputFileUriValue

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FileName': (<class 'str'>, True)}

class troposphere.iotanalytics.ParquetConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ParquetConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SchemaDefinition': (<class 'troposphere.iotanalytics.SchemaDefinition'>, False)}

class troposphere.iotanalytics.Partition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Partition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AttributeName': (<class 'str'>, True)}

class troposphere.iotanalytics.Pipeline(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Pipeline

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PipelineActivities': ([<class 'troposphere.iotanalytics.Activity'>], True),'PipelineName': (<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>,False)}

resource_type: Optional[str] = 'AWS::IoTAnalytics::Pipeline'

class troposphere.iotanalytics.QueryAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

QueryAction

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Filters': ([<class 'troposphere.iotanalytics.QueryActionFilter'>], False),'SqlQuery': (<class 'str'>, True)}

class troposphere.iotanalytics.QueryActionFilter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

QueryActionFilter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeltaTime': (<class 'troposphere.iotanalytics.DeltaTime'>, False)}

class troposphere.iotanalytics.RemoveAttributes(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RemoveAttributes

7.3. troposphere 449

Page 454: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Attributes': ([<class 'str'>], True), 'Name': (<class 'str'>, True), 'Next':(<class 'str'>, False)}

class troposphere.iotanalytics.ResourceConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ResourceConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComputeType': (<class 'str'>, True), 'VolumeSizeInGB': (<function integer>,True)}

class troposphere.iotanalytics.RetentionPeriod(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

RetentionPeriod

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'NumberOfDays': (<function integer>, False), 'Unlimited': (<function boolean>,False)}

class troposphere.iotanalytics.S3DestinationConfiguration(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

S3DestinationConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Bucket': (<class 'str'>, True), 'GlueConfiguration': (<class'troposphere.iotanalytics.GlueConfiguration'>, False), 'Key': (<class 'str'>,True), 'RoleArn': (<class 'str'>, True)}

class troposphere.iotanalytics.Schedule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Schedule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ScheduleExpression': (<class 'str'>, True)}

class troposphere.iotanalytics.SchemaDefinition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SchemaDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Columns': ([<class 'troposphere.iotanalytics.Column'>], False)}

class troposphere.iotanalytics.SelectAttributes(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SelectAttributes

450 Chapter 7. Licensing

Page 455: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Attributes': ([<class 'str'>], True), 'Name': (<class 'str'>, True), 'Next':(<class 'str'>, False)}

class troposphere.iotanalytics.TimestampPartition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TimestampPartition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AttributeName': (<class 'str'>, True), 'TimestampFormat': (<class 'str'>,False)}

class troposphere.iotanalytics.Trigger(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Trigger

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Schedule': (<class 'troposphere.iotanalytics.Schedule'>, False),'TriggeringDataset': (<class 'troposphere.iotanalytics.TriggeringDataset'>, False)}

class troposphere.iotanalytics.TriggeringDataset(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TriggeringDataset

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DatasetName': (<class 'str'>, True)}

class troposphere.iotanalytics.Variable(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Variable

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DatasetContentVersionValue': (<class'troposphere.iotanalytics.DatasetContentVersionValue'>, False), 'DoubleValue':(<function double>, False), 'OutputFileUriValue': (<class'troposphere.iotanalytics.OutputFileUriValue'>, False), 'StringValue': (<class'str'>, False), 'VariableName': (<class 'str'>, True)}

class troposphere.iotanalytics.VersioningConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VersioningConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MaxVersions': (<function integer>, False), 'Unlimited': (<function boolean>,False)}

7.3. troposphere 451

Page 456: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.iotcoredeviceadvisor module

class troposphere.iotcoredeviceadvisor.SuiteDefinition(title: Optional[str], template:Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

SuiteDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SuiteDefinitionConfiguration': (<class 'dict'>, True), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTCoreDeviceAdvisor::SuiteDefinition'

troposphere.iotevents module

class troposphere.iotevents.AcknowledgeFlow(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AcknowledgeFlow

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Enabled': (<function boolean>, False)}

class troposphere.iotevents.Action(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Action

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClearTimer': (<class 'troposphere.iotevents.ClearTimer'>, False), 'DynamoDB':(<class 'troposphere.iotevents.DynamoDB'>, False), 'DynamoDBv2': (<class'troposphere.iotevents.DynamoDBv2'>, False), 'Firehose': (<class'troposphere.iotevents.Firehose'>, False), 'IotEvents': (<class'troposphere.iotevents.IotEvents'>, False), 'IotSiteWise': (<class'troposphere.iotevents.IotSiteWise'>, False), 'IotTopicPublish': (<class'troposphere.iotevents.IotTopicPublish'>, False), 'Lambda': (<class'troposphere.iotevents.Lambda'>, False), 'ResetTimer': (<class'troposphere.iotevents.ResetTimer'>, False), 'SetTimer': (<class'troposphere.iotevents.SetTimer'>, False), 'SetVariable': (<class'troposphere.iotevents.SetVariable'>, False), 'Sns': (<class'troposphere.iotevents.Sns'>, False), 'Sqs': (<class 'troposphere.iotevents.Sqs'>,False)}

class troposphere.iotevents.AlarmAction(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AlarmAction

452 Chapter 7. Licensing

Page 457: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DynamoDB': (<class 'troposphere.iotevents.DynamoDB'>, False), 'DynamoDBv2':(<class 'troposphere.iotevents.DynamoDBv2'>, False), 'Firehose': (<class'troposphere.iotevents.Firehose'>, False), 'IotEvents': (<class'troposphere.iotevents.IotEvents'>, False), 'IotSiteWise': (<class'troposphere.iotevents.IotSiteWise'>, False), 'IotTopicPublish': (<class'troposphere.iotevents.IotTopicPublish'>, False), 'Lambda': (<class'troposphere.iotevents.Lambda'>, False), 'Sns': (<class'troposphere.iotevents.Sns'>, False), 'Sqs': (<class 'troposphere.iotevents.Sqs'>,False)}

class troposphere.iotevents.AlarmCapabilities(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AlarmCapabilities

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AcknowledgeFlow': (<class 'troposphere.iotevents.AcknowledgeFlow'>, False),'InitializationConfiguration': (<class'troposphere.iotevents.InitializationConfiguration'>, False)}

class troposphere.iotevents.AlarmEventActions(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AlarmEventActions

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AlarmActions': ([<class 'troposphere.iotevents.AlarmAction'>], False)}

class troposphere.iotevents.AlarmModel(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

AlarmModel

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AlarmCapabilities': (<class 'troposphere.iotevents.AlarmCapabilities'>, False),'AlarmEventActions': (<class 'troposphere.iotevents.AlarmEventActions'>, False),'AlarmModelDescription': (<class 'str'>, False), 'AlarmModelName': (<class 'str'>,False), 'AlarmRule': (<class 'troposphere.iotevents.AlarmRule'>, True), 'Key':(<class 'str'>, False), 'RoleArn': (<class 'str'>, True), 'Severity': (<functioninteger>, False), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTEvents::AlarmModel'

class troposphere.iotevents.AlarmRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AlarmRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'SimpleRule': (<class 'troposphere.iotevents.SimpleRule'>, False)}

class troposphere.iotevents.AssetPropertyTimestamp(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 453

Page 458: Release 3.1

troposphere Documentation, Release 4.0.1

AssetPropertyTimestamp

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'OffsetInNanos': (<class 'str'>, False), 'TimeInSeconds': (<class 'str'>, True)}

class troposphere.iotevents.AssetPropertyValue(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AssetPropertyValue

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Quality': (<class 'str'>, False), 'Timestamp': (<class'troposphere.iotevents.AssetPropertyTimestamp'>, False), 'Value': (<class'troposphere.iotevents.AssetPropertyVariant'>, True)}

class troposphere.iotevents.AssetPropertyVariant(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AssetPropertyVariant

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BooleanValue': (<class 'str'>, False), 'DoubleValue': (<class 'str'>, False),'IntegerValue': (<class 'str'>, False), 'StringValue': (<class 'str'>, False)}

class troposphere.iotevents.Attribute(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Attribute

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'JsonPath': (<class 'str'>, True)}

class troposphere.iotevents.ClearTimer(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ClearTimer

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TimerName': (<class 'str'>, True)}

class troposphere.iotevents.DetectorModel(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

DetectorModel

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DetectorModelDefinition': (<class'troposphere.iotevents.DetectorModelDefinition'>, True), 'DetectorModelDescription':(<class 'str'>, False), 'DetectorModelName': (<class 'str'>, False),'EvaluationMethod': (<class 'str'>, False), 'Key': (<class 'str'>, False),'RoleArn': (<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTEvents::DetectorModel'

454 Chapter 7. Licensing

Page 459: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.iotevents.DetectorModelDefinition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DetectorModelDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InitialStateName': (<class 'str'>, True), 'States': ([<class'troposphere.iotevents.State'>], True)}

class troposphere.iotevents.DynamoDB(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DynamoDB

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HashKeyField': (<class 'str'>, True), 'HashKeyType': (<class 'str'>, False),'HashKeyValue': (<class 'str'>, True), 'Operation': (<class 'str'>, False),'Payload': (<class 'troposphere.iotevents.Payload'>, False), 'PayloadField':(<class 'str'>, False), 'RangeKeyField': (<class 'str'>, False), 'RangeKeyType':(<class 'str'>, False), 'RangeKeyValue': (<class 'str'>, False), 'TableName':(<class 'str'>, True)}

class troposphere.iotevents.DynamoDBv2(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DynamoDBv2

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Payload': (<class 'troposphere.iotevents.Payload'>, False), 'TableName': (<class'str'>, True)}

class troposphere.iotevents.Event(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Event

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Actions': ([<class 'troposphere.iotevents.Action'>], False), 'Condition':(<class 'str'>, False), 'EventName': (<class 'str'>, True)}

class troposphere.iotevents.Firehose(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Firehose

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DeliveryStreamName': (<class 'str'>, True), 'Payload': (<class'troposphere.iotevents.Payload'>, False), 'Separator': (<class 'str'>, False)}

class troposphere.iotevents.InitializationConfiguration(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

InitializationConfiguration

7.3. troposphere 455

Page 460: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DisabledOnInitialization': (<function boolean>, True)}

class troposphere.iotevents.Input(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Input

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InputDefinition': (<class 'troposphere.iotevents.InputDefinition'>, True),'InputDescription': (<class 'str'>, False), 'InputName': (<class 'str'>, False),'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTEvents::Input'

class troposphere.iotevents.InputDefinition(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

InputDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Attributes': ([<class 'troposphere.iotevents.Attribute'>], True)}

class troposphere.iotevents.IotEvents(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

IotEvents

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InputName': (<class 'str'>, True), 'Payload': (<class'troposphere.iotevents.Payload'>, False)}

class troposphere.iotevents.IotSiteWise(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

IotSiteWise

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssetId': (<class 'str'>, False), 'EntryId': (<class 'str'>, False),'PropertyAlias': (<class 'str'>, False), 'PropertyId': (<class 'str'>, False),'PropertyValue': (<class 'troposphere.iotevents.AssetPropertyValue'>, True)}

class troposphere.iotevents.IotTopicPublish(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

IotTopicPublish

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'MqttTopic': (<class 'str'>, True), 'Payload': (<class'troposphere.iotevents.Payload'>, False)}

class troposphere.iotevents.Lambda(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Lambda

456 Chapter 7. Licensing

Page 461: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'FunctionArn': (<class 'str'>, True), 'Payload': (<class'troposphere.iotevents.Payload'>, False)}

class troposphere.iotevents.OnEnter(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OnEnter

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Events': ([<class 'troposphere.iotevents.Event'>], False)}

class troposphere.iotevents.OnExit(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OnExit

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Events': ([<class 'troposphere.iotevents.Event'>], False)}

class troposphere.iotevents.OnInput(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OnInput

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Events': ([<class 'troposphere.iotevents.Event'>], False), 'TransitionEvents':([<class 'troposphere.iotevents.TransitionEvent'>], False)}

class troposphere.iotevents.Payload(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Payload

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ContentExpression': (<class 'str'>, True), 'Type': (<class 'str'>, True)}

class troposphere.iotevents.ResetTimer(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ResetTimer

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'TimerName': (<class 'str'>, True)}

class troposphere.iotevents.SetTimer(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SetTimer

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DurationExpression': (<class 'str'>, False), 'Seconds': (<function integer>,False), 'TimerName': (<class 'str'>, True)}

class troposphere.iotevents.SetVariable(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

7.3. troposphere 457

Page 462: Release 3.1

troposphere Documentation, Release 4.0.1

SetVariable

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Value': (<class 'str'>, True), 'VariableName': (<class 'str'>, True)}

class troposphere.iotevents.SimpleRule(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SimpleRule

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ComparisonOperator': (<class 'str'>, True), 'InputProperty': (<class 'str'>,True), 'Threshold': (<class 'str'>, True)}

class troposphere.iotevents.Sns(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Sns

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Payload': (<class 'troposphere.iotevents.Payload'>, False), 'TargetArn': (<class'str'>, True)}

class troposphere.iotevents.Sqs(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Sqs

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Payload': (<class 'troposphere.iotevents.Payload'>, False), 'QueueUrl': (<class'str'>, True), 'UseBase64': (<function boolean>, False)}

class troposphere.iotevents.State(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

State

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'OnEnter': (<class 'troposphere.iotevents.OnEnter'>, False), 'OnExit': (<class'troposphere.iotevents.OnExit'>, False), 'OnInput': (<class'troposphere.iotevents.OnInput'>, False), 'StateName': (<class 'str'>, True)}

class troposphere.iotevents.TransitionEvent(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TransitionEvent

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Actions': ([<class 'troposphere.iotevents.Action'>], False), 'Condition':(<class 'str'>, True), 'EventName': (<class 'str'>, True), 'NextState': (<class'str'>, True)}

458 Chapter 7. Licensing

Page 463: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.iotfleethub module

class troposphere.iotfleethub.Application(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

Application

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ApplicationDescription': (<class 'str'>, False), 'ApplicationName': (<class'str'>, True), 'RoleArn': (<class 'str'>, True), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTFleetHub::Application'

troposphere.iotsitewise module

class troposphere.iotsitewise.AccessPolicy(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

AccessPolicy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccessPolicyIdentity': (<class 'troposphere.iotsitewise.AccessPolicyIdentity'>,True), 'AccessPolicyPermission': (<class 'str'>, True), 'AccessPolicyResource':(<class 'troposphere.iotsitewise.AccessPolicyResource'>, True)}

resource_type: Optional[str] = 'AWS::IoTSiteWise::AccessPolicy'

class troposphere.iotsitewise.AccessPolicyIdentity(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AccessPolicyIdentity

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'IamRole': (<class 'troposphere.iotsitewise.IamRole'>, False), 'IamUser': (<class'troposphere.iotsitewise.IamUser'>, False), 'User': (<class'troposphere.iotsitewise.User'>, False)}

class troposphere.iotsitewise.AccessPolicyResource(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AccessPolicyResource

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Portal': (<class 'troposphere.iotsitewise.PortalProperty'>, False), 'Project':(<class 'troposphere.iotsitewise.ProjectProperty'>, False)}

class troposphere.iotsitewise.Asset(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Asset

7.3. troposphere 459

Page 464: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssetHierarchies': ([<class 'troposphere.iotsitewise.AssetHierarchy'>], False),'AssetModelId': (<class 'str'>, True), 'AssetName': (<class 'str'>, True),'AssetProperties': ([<class 'troposphere.iotsitewise.AssetProperty'>], False),'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTSiteWise::Asset'

class troposphere.iotsitewise.AssetHierarchy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AssetHierarchy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ChildAssetId': (<class 'str'>, True), 'LogicalId': (<class 'str'>, True)}

class troposphere.iotsitewise.AssetModel(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

AssetModel

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssetModelCompositeModels': ([<class'troposphere.iotsitewise.AssetModelCompositeModel'>], False),'AssetModelDescription': (<class 'str'>, False), 'AssetModelHierarchies': ([<class'troposphere.iotsitewise.AssetModelHierarchy'>], False), 'AssetModelName': (<class'str'>, True), 'AssetModelProperties': ([<class'troposphere.iotsitewise.AssetModelProperty'>], False), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTSiteWise::AssetModel'

class troposphere.iotsitewise.AssetModelCompositeModel(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AssetModelCompositeModel

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CompositeModelProperties': ([<class'troposphere.iotsitewise.AssetModelProperty'>], False), 'Description': (<class'str'>, False), 'Name': (<class 'str'>, True), 'Type': (<class 'str'>, True)}

class troposphere.iotsitewise.AssetModelHierarchy(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AssetModelHierarchy

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ChildAssetModelId': (<class 'str'>, True), 'LogicalId': (<class 'str'>, True),'Name': (<class 'str'>, True)}

class troposphere.iotsitewise.AssetModelProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AssetModelProperty

460 Chapter 7. Licensing

Page 465: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DataType': (<class 'str'>, True), 'DataTypeSpec': (<class 'str'>, False),'LogicalId': (<class 'str'>, True), 'Name': (<class 'str'>, True), 'Type':(<class 'troposphere.iotsitewise.PropertyType'>, True), 'Unit': (<class 'str'>,False)}

class troposphere.iotsitewise.AssetProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AssetProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Alias': (<class 'str'>, False), 'LogicalId': (<class 'str'>, True),'NotificationState': (<class 'str'>, False)}

class troposphere.iotsitewise.Attribute(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Attribute

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DefaultValue': (<class 'str'>, False)}

class troposphere.iotsitewise.Dashboard(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Dashboard

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DashboardDefinition': (<class 'str'>, True), 'DashboardDescription': (<class'str'>, True), 'DashboardName': (<class 'str'>, True), 'ProjectId': (<class'str'>, False), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTSiteWise::Dashboard'

class troposphere.iotsitewise.ExpressionVariable(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ExpressionVariable

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, True), 'Value': (<class'troposphere.iotsitewise.VariableValue'>, True)}

class troposphere.iotsitewise.Gateway(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Gateway

7.3. troposphere 461

Page 466: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GatewayCapabilitySummaries': ([<class'troposphere.iotsitewise.GatewayCapabilitySummary'>], False), 'GatewayName':(<class 'str'>, True), 'GatewayPlatform': (<class'troposphere.iotsitewise.GatewayPlatform'>, True), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTSiteWise::Gateway'

class troposphere.iotsitewise.GatewayCapabilitySummary(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GatewayCapabilitySummary

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CapabilityConfiguration': (<class 'str'>, False), 'CapabilityNamespace': (<class'str'>, True)}

class troposphere.iotsitewise.GatewayPlatform(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GatewayPlatform

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Greengrass': (<class 'troposphere.iotsitewise.Greengrass'>, False),'GreengrassV2': (<class 'troposphere.iotsitewise.GreengrassV2'>, False)}

class troposphere.iotsitewise.Greengrass(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Greengrass

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GroupArn': (<class 'str'>, True)}

class troposphere.iotsitewise.GreengrassV2(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

GreengrassV2

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CoreDeviceThingName': (<class 'str'>, True)}

class troposphere.iotsitewise.IamRole(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

IamRole

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'arn':(<class 'str'>, False)}

class troposphere.iotsitewise.IamUser(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

IamUser

462 Chapter 7. Licensing

Page 467: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'arn':(<class 'str'>, False)}

class troposphere.iotsitewise.Metric(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Metric

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Expression': (<class 'str'>, True), 'Variables': ([<class'troposphere.iotsitewise.ExpressionVariable'>], True), 'Window': (<class'troposphere.iotsitewise.MetricWindow'>, True)}

class troposphere.iotsitewise.MetricWindow(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

MetricWindow

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Tumbling': (<class 'troposphere.iotsitewise.TumblingWindow'>, False)}

class troposphere.iotsitewise.Portal(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Portal

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Alarms': (<class 'dict'>, False), 'NotificationSenderEmail': (<class 'str'>,False), 'PortalAuthMode': (<class 'str'>, False), 'PortalContactEmail': (<class'str'>, True), 'PortalDescription': (<class 'str'>, False), 'PortalName': (<class'str'>, True), 'RoleArn': (<class 'str'>, True), 'Tags': (<class'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTSiteWise::Portal'

class troposphere.iotsitewise.PortalProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PortalProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'id':(<class 'str'>, False)}

class troposphere.iotsitewise.Project(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Project

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssetIds': ([<class 'str'>], False), 'PortalId': (<class 'str'>, True),'ProjectDescription': (<class 'str'>, False), 'ProjectName': (<class 'str'>,True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTSiteWise::Project'

7.3. troposphere 463

Page 468: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.iotsitewise.ProjectProperty(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ProjectProperty

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'id':(<class 'str'>, False)}

class troposphere.iotsitewise.PropertyType(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

PropertyType

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Attribute': (<class 'troposphere.iotsitewise.Attribute'>, False), 'Metric':(<class 'troposphere.iotsitewise.Metric'>, False), 'Transform': (<class'troposphere.iotsitewise.Transform'>, False), 'TypeName': (<class 'str'>, True)}

class troposphere.iotsitewise.Transform(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

Transform

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Expression': (<class 'str'>, True), 'Variables': ([<class'troposphere.iotsitewise.ExpressionVariable'>], True)}

class troposphere.iotsitewise.TumblingWindow(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

TumblingWindow

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Interval': (<class 'str'>, True), 'Offset': (<class 'str'>, False)}

class troposphere.iotsitewise.User(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

User

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'id':(<class 'str'>, False)}

class troposphere.iotsitewise.VariableValue(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

VariableValue

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'HierarchyLogicalId': (<class 'str'>, False), 'PropertyLogicalId': (<class'str'>, True)}

464 Chapter 7. Licensing

Page 469: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.iotwireless module

class troposphere.iotwireless.AbpV10x(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AbpV10x

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DevAddr': (<class 'str'>, True), 'SessionKeys': (<class'troposphere.iotwireless.SessionKeysAbpV10x'>, True)}

class troposphere.iotwireless.AbpV11(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AbpV11

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DevAddr': (<class 'str'>, True), 'SessionKeys': (<class'troposphere.iotwireless.SessionKeysAbpV11'>, True)}

class troposphere.iotwireless.Destination(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool =True, **kwargs: Any)

Bases: troposphere.AWSObject

Destination

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'Expression': (<class 'str'>, True),'ExpressionType': (<class 'str'>, True), 'Name': (<class 'str'>, True), 'RoleArn':(<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTWireless::Destination'

class troposphere.iotwireless.DeviceProfile(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

DeviceProfile

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LoRaWAN': (<class 'troposphere.iotwireless.LoRaWANDeviceProfile'>, False), 'Name':(<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTWireless::DeviceProfile'

class troposphere.iotwireless.FuotaTask(title: Optional[str], template: Optional[troposphere.Template]= None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

FuotaTask

7.3. troposphere 465

Page 470: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssociateMulticastGroup': (<class 'str'>, False), 'AssociateWirelessDevice':(<class 'str'>, False), 'Description': (<class 'str'>, False),'DisassociateMulticastGroup': (<class 'str'>, False), 'DisassociateWirelessDevice':(<class 'str'>, False), 'FirmwareUpdateImage': (<class 'str'>, True),'FirmwareUpdateRole': (<class 'str'>, True), 'LoRaWAN': (<class'troposphere.iotwireless.FuotaTaskLoRaWAN'>, True), 'Name': (<class 'str'>, False),'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTWireless::FuotaTask'

class troposphere.iotwireless.FuotaTaskLoRaWAN(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

FuotaTaskLoRaWAN

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RfRegion': (<class 'str'>, True), 'StartTime': (<class 'str'>, False)}

class troposphere.iotwireless.LoRaWAN(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LoRaWAN

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DlClass': (<class 'str'>, True), 'NumberOfDevicesInGroup': (<function integer>,False), 'NumberOfDevicesRequested': (<function integer>, False), 'RfRegion':(<class 'str'>, True)}

class troposphere.iotwireless.LoRaWANDevice(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LoRaWANDevice

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AbpV10x': (<class 'troposphere.iotwireless.AbpV10x'>, False), 'AbpV11': (<class'troposphere.iotwireless.AbpV11'>, False), 'DevEui': (<class 'str'>, False),'DeviceProfileId': (<class 'str'>, False), 'OtaaV10x': (<class'troposphere.iotwireless.OtaaV10x'>, False), 'OtaaV11': (<class'troposphere.iotwireless.OtaaV11'>, False), 'ServiceProfileId': (<class 'str'>,False)}

class troposphere.iotwireless.LoRaWANDeviceProfile(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LoRaWANDeviceProfile

466 Chapter 7. Licensing

Page 471: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ClassBTimeout': (<function integer>, False), 'ClassCTimeout': (<functioninteger>, False), 'MacVersion': (<class 'str'>, False), 'MaxDutyCycle': (<functioninteger>, False), 'MaxEirp': (<function integer>, False), 'PingSlotDr': (<functioninteger>, False), 'PingSlotFreq': (<function integer>, False), 'PingSlotPeriod':(<function integer>, False), 'RegParamsRevision': (<class 'str'>, False),'RfRegion': (<class 'str'>, False), 'Supports32BitFCnt': (<function boolean>,False), 'SupportsClassB': (<function boolean>, False), 'SupportsClassC': (<functionboolean>, False), 'SupportsJoin': (<function boolean>, False)}

class troposphere.iotwireless.LoRaWANGateway(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LoRaWANGateway

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'GatewayEui': (<class 'str'>, True), 'RfRegion': (<class 'str'>, True)}

class troposphere.iotwireless.LoRaWANGatewayVersion(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LoRaWANGatewayVersion

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Model': (<class 'str'>, False), 'PackageVersion': (<class 'str'>, False),'Station': (<class 'str'>, False)}

class troposphere.iotwireless.LoRaWANServiceProfile(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

LoRaWANServiceProfile

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AddGwMetadata': (<function boolean>, False), 'ChannelMask': (<class 'str'>,False), 'DevStatusReqFreq': (<function integer>, False), 'DlBucketSize':(<function integer>, False), 'DlRate': (<function integer>, False), 'DlRatePolicy':(<class 'str'>, False), 'DrMax': (<function integer>, False), 'DrMin': (<functioninteger>, False), 'HrAllowed': (<function boolean>, False), 'MinGwDiversity':(<function integer>, False), 'NwkGeoLoc': (<function boolean>, False), 'PrAllowed':(<function boolean>, False), 'RaAllowed': (<function boolean>, False),'ReportDevStatusBattery': (<function boolean>, False), 'ReportDevStatusMargin':(<function boolean>, False), 'TargetPer': (<function integer>, False),'UlBucketSize': (<function integer>, False), 'UlRate': (<function integer>,False), 'UlRatePolicy': (<class 'str'>, False)}

class troposphere.iotwireless.LoRaWANUpdateGatewayTaskCreate(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

LoRaWANUpdateGatewayTaskCreate

7.3. troposphere 467

Page 472: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CurrentVersion': (<class 'troposphere.iotwireless.LoRaWANGatewayVersion'>,False), 'SigKeyCrc': (<function integer>, False), 'UpdateSignature': (<class'str'>, False), 'UpdateVersion': (<class'troposphere.iotwireless.LoRaWANGatewayVersion'>, False)}

class troposphere.iotwireless.LoRaWANUpdateGatewayTaskEntry(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

LoRaWANUpdateGatewayTaskEntry

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CurrentVersion': (<class 'troposphere.iotwireless.LoRaWANGatewayVersion'>,False), 'UpdateVersion': (<class 'troposphere.iotwireless.LoRaWANGatewayVersion'>,False)}

class troposphere.iotwireless.MulticastGroup(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

MulticastGroup

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AssociateWirelessDevice': (<class 'str'>, False), 'Description': (<class 'str'>,False), 'DisassociateWirelessDevice': (<class 'str'>, False), 'LoRaWAN': (<class'troposphere.iotwireless.LoRaWAN'>, True), 'Name': (<class 'str'>, False), 'Tags':(<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTWireless::MulticastGroup'

class troposphere.iotwireless.OtaaV10x(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OtaaV10x

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AppEui': (<class 'str'>, True), 'AppKey': (<class 'str'>, True)}

class troposphere.iotwireless.OtaaV11(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

OtaaV11

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AppKey': (<class 'str'>, True), 'JoinEui': (<class 'str'>, True), 'NwkKey':(<class 'str'>, True)}

class troposphere.iotwireless.PartnerAccount(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

PartnerAccount

468 Chapter 7. Licensing

Page 473: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AccountLinked': (<function boolean>, False), 'Fingerprint': (<class 'str'>,False), 'PartnerAccountId': (<class 'str'>, False), 'PartnerType': (<class 'str'>,False), 'Sidewalk': (<class 'troposphere.iotwireless.SidewalkAccountInfo'>, False),'SidewalkUpdate': (<class 'troposphere.iotwireless.SidewalkUpdateAccount'>, False),'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTWireless::PartnerAccount'

class troposphere.iotwireless.ServiceProfile(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

ServiceProfile

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LoRaWAN': (<class 'troposphere.iotwireless.LoRaWANServiceProfile'>, False),'Name': (<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IoTWireless::ServiceProfile'

class troposphere.iotwireless.SessionKeysAbpV10x(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SessionKeysAbpV10x

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AppSKey': (<class 'str'>, True), 'NwkSKey': (<class 'str'>, True)}

class troposphere.iotwireless.SessionKeysAbpV11(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SessionKeysAbpV11

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AppSKey': (<class 'str'>, True), 'FNwkSIntKey': (<class 'str'>, True),'NwkSEncKey': (<class 'str'>, True), 'SNwkSIntKey': (<class 'str'>, True)}

class troposphere.iotwireless.SidewalkAccountInfo(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SidewalkAccountInfo

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AppServerPrivateKey': (<class 'str'>, True)}

class troposphere.iotwireless.SidewalkUpdateAccount(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

SidewalkUpdateAccount

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AppServerPrivateKey': (<class 'str'>, False)}

7.3. troposphere 469

Page 474: Release 3.1

troposphere Documentation, Release 4.0.1

class troposphere.iotwireless.TaskDefinition(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

TaskDefinition

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AutoCreateTasks': (<function boolean>, True), 'LoRaWANUpdateGatewayTaskEntry':(<class 'troposphere.iotwireless.LoRaWANUpdateGatewayTaskEntry'>, False), 'Name':(<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>, False),'TaskDefinitionType': (<class 'str'>, False), 'Update': (<class'troposphere.iotwireless.UpdateWirelessGatewayTaskCreate'>, False)}

resource_type: Optional[str] = 'AWS::IoTWireless::TaskDefinition'

class troposphere.iotwireless.UpdateWirelessGatewayTaskCreate(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

UpdateWirelessGatewayTaskCreate

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'LoRaWAN': (<class 'troposphere.iotwireless.LoRaWANUpdateGatewayTaskCreate'>,False), 'UpdateDataRole': (<class 'str'>, False), 'UpdateDataSource': (<class'str'>, False)}

class troposphere.iotwireless.WirelessDevice(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

WirelessDevice

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'DestinationName': (<class 'str'>, True),'LastUplinkReceivedAt': (<class 'str'>, False), 'LoRaWAN': (<class'troposphere.iotwireless.LoRaWANDevice'>, False), 'Name': (<class 'str'>, False),'Tags': (<class 'troposphere.Tags'>, False), 'ThingArn': (<class 'str'>, False),'Type': (<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::IoTWireless::WirelessDevice'

class troposphere.iotwireless.WirelessGateway(title: Optional[str], template:Optional[troposphere.Template] = None, validation:bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

WirelessGateway

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Description': (<class 'str'>, False), 'LastUplinkReceivedAt': (<class 'str'>,False), 'LoRaWAN': (<class 'troposphere.iotwireless.LoRaWANGateway'>, True), 'Name':(<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>, False), 'ThingArn':(<class 'str'>, False)}

resource_type: Optional[str] = 'AWS::IoTWireless::WirelessGateway'

470 Chapter 7. Licensing

Page 475: Release 3.1

troposphere Documentation, Release 4.0.1

troposphere.ivs module

class troposphere.ivs.Channel(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

Channel

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Authorized': (<function boolean>, False), 'LatencyMode': (<class 'str'>, False),'Name': (<class 'str'>, False), 'RecordingConfigurationArn': (<class 'str'>,False), 'Tags': (<class 'troposphere.Tags'>, False), 'Type': (<class 'str'>,False)}

resource_type: Optional[str] = 'AWS::IVS::Channel'

class troposphere.ivs.DestinationConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DestinationConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] = {'S3':(<class 'troposphere.ivs.S3DestinationConfiguration'>, True)}

class troposphere.ivs.PlaybackKeyPair(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

PlaybackKeyPair

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'Name': (<class 'str'>, False), 'PublicKeyMaterial': (<class 'str'>, True),'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IVS::PlaybackKeyPair'

class troposphere.ivs.RecordingConfiguration(title: Optional[str], template:Optional[troposphere.Template] = None, validation: bool= True, **kwargs: Any)

Bases: troposphere.AWSObject

RecordingConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DestinationConfiguration': (<class 'troposphere.ivs.DestinationConfiguration'>,True), 'Name': (<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>,False), 'ThumbnailConfiguration': (<class'troposphere.ivs.ThumbnailConfiguration'>, False)}

resource_type: Optional[str] = 'AWS::IVS::RecordingConfiguration'

class troposphere.ivs.S3DestinationConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

S3DestinationConfiguration

7.3. troposphere 471

Page 476: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BucketName': (<class 'str'>, True)}

class troposphere.ivs.StreamKey(title: Optional[str], template: Optional[troposphere.Template] = None,validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

StreamKey

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ChannelArn': (<class 'str'>, True), 'Tags': (<class 'troposphere.Tags'>, False)}

resource_type: Optional[str] = 'AWS::IVS::StreamKey'

class troposphere.ivs.ThumbnailConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ThumbnailConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'RecordingMode': (<class 'str'>, True), 'TargetIntervalSeconds': (<functioninteger>, False)}

troposphere.kendra module

class troposphere.kendra.AccessControlListConfiguration(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

AccessControlListConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'KeyPath': (<class 'str'>, False)}

class troposphere.kendra.AclConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

AclConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AllowedGroupsColumnName': (<class 'str'>, True)}

class troposphere.kendra.CapacityUnitsConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

CapacityUnitsConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'QueryCapacityUnits': (<function integer>, True), 'StorageCapacityUnits':(<function integer>, True)}

class troposphere.kendra.ColumnConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ColumnConfiguration

472 Chapter 7. Licensing

Page 477: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ChangeDetectingColumns': ([<class 'str'>], True), 'DocumentDataColumnName':(<class 'str'>, True), 'DocumentIdColumnName': (<class 'str'>, True),'DocumentTitleColumnName': (<class 'str'>, False), 'FieldMappings': ([<class'troposphere.kendra.DataSourceToIndexFieldMapping'>], False)}

class troposphere.kendra.ConfluenceAttachmentConfiguration(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

ConfluenceAttachmentConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AttachmentFieldMappings': ([<class'troposphere.kendra.ConfluenceAttachmentToIndexFieldMapping'>], False),'CrawlAttachments': (<function boolean>, False)}

class troposphere.kendra.ConfluenceAttachmentToIndexFieldMapping(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ConfluenceAttachmentToIndexFieldMapping

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DataSourceFieldName': (<class 'str'>, True), 'DateFieldFormat': (<class 'str'>,False), 'IndexFieldName': (<class 'str'>, True)}

class troposphere.kendra.ConfluenceBlogConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConfluenceBlogConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'BlogFieldMappings': ([<class'troposphere.kendra.ConfluenceBlogToIndexFieldMapping'>], False)}

class troposphere.kendra.ConfluenceBlogToIndexFieldMapping(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

ConfluenceBlogToIndexFieldMapping

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DataSourceFieldName': (<class 'str'>, True), 'DateFieldFormat': (<class 'str'>,False), 'IndexFieldName': (<class 'str'>, True)}

class troposphere.kendra.ConfluenceConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConfluenceConfiguration

7.3. troposphere 473

Page 478: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'AttachmentConfiguration': (<class'troposphere.kendra.ConfluenceAttachmentConfiguration'>, False),'BlogConfiguration': (<class 'troposphere.kendra.ConfluenceBlogConfiguration'>,False), 'ExclusionPatterns': ([<class 'str'>], False), 'InclusionPatterns':([<class 'str'>], False), 'PageConfiguration': (<class'troposphere.kendra.ConfluencePageConfiguration'>, False), 'SecretArn': (<class'str'>, True), 'ServerUrl': (<class 'str'>, True), 'SpaceConfiguration': (<class'troposphere.kendra.ConfluenceSpaceConfiguration'>, False), 'Version': (<class'str'>, True), 'VpcConfiguration': (<class'troposphere.kendra.DataSourceVpcConfiguration'>, False)}

class troposphere.kendra.ConfluencePageConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConfluencePageConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'PageFieldMappings': ([<class'troposphere.kendra.ConfluencePageToIndexFieldMapping'>], False)}

class troposphere.kendra.ConfluencePageToIndexFieldMapping(title: Optional[str] = None, **kwargs:Any)

Bases: troposphere.AWSProperty

ConfluencePageToIndexFieldMapping

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DataSourceFieldName': (<class 'str'>, True), 'DateFieldFormat': (<class 'str'>,False), 'IndexFieldName': (<class 'str'>, True)}

class troposphere.kendra.ConfluenceSpaceConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConfluenceSpaceConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CrawlArchivedSpaces': (<function boolean>, False), 'CrawlPersonalSpaces':(<function boolean>, False), 'ExcludeSpaces': ([<class 'str'>], False),'IncludeSpaces': ([<class 'str'>], False), 'SpaceFieldMappings': ([<class'troposphere.kendra.ConfluenceSpaceToIndexFieldMapping'>], False)}

class troposphere.kendra.ConfluenceSpaceToIndexFieldMapping(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

ConfluenceSpaceToIndexFieldMapping

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DataSourceFieldName': (<class 'str'>, True), 'DateFieldFormat': (<class 'str'>,False), 'IndexFieldName': (<class 'str'>, True)}

class troposphere.kendra.ConnectionConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

ConnectionConfiguration

474 Chapter 7. Licensing

Page 479: Release 3.1

troposphere Documentation, Release 4.0.1

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'DatabaseHost': (<class 'str'>, True), 'DatabaseName': (<class 'str'>, True),'DatabasePort': (<function integer>, True), 'SecretArn': (<class 'str'>, True),'TableName': (<class 'str'>, True)}

class troposphere.kendra.CustomDocumentEnrichmentConfiguration(title: Optional[str] = None,**kwargs: Any)

Bases: troposphere.AWSProperty

CustomDocumentEnrichmentConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'InlineConfigurations': ([<class'troposphere.kendra.InlineCustomDocumentEnrichmentConfiguration'>], False),'PostExtractionHookConfiguration': (<class 'troposphere.kendra.HookConfiguration'>,False), 'PreExtractionHookConfiguration': (<class'troposphere.kendra.HookConfiguration'>, False), 'RoleArn': (<class 'str'>, False)}

class troposphere.kendra.DataSource(title: Optional[str], template: Optional[troposphere.Template] =None, validation: bool = True, **kwargs: Any)

Bases: troposphere.AWSObject

DataSource

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'CustomDocumentEnrichmentConfiguration': (<class'troposphere.kendra.CustomDocumentEnrichmentConfiguration'>, False),'DataSourceConfiguration': (<class 'troposphere.kendra.DataSourceConfiguration'>,False), 'Description': (<class 'str'>, False), 'IndexId': (<class 'str'>, True),'Name': (<class 'str'>, True), 'RoleArn': (<class 'str'>, False), 'Schedule':(<class 'str'>, False), 'Tags': (<class 'troposphere.Tags'>, False), 'Type':(<class 'str'>, True)}

resource_type: Optional[str] = 'AWS::Kendra::DataSource'

class troposphere.kendra.DataSourceConfiguration(title: Optional[str] = None, **kwargs: Any)Bases: troposphere.AWSProperty

DataSourceConfiguration

props: Dict[str, Tuple[Union[str, troposphere.AWSProperty, troposphere.AWSHelperFn,Callable[[Any], Any], Dict[str, Any], List[Any], Tuple[type, ...]], bool]] ={'ConfluenceConfiguration': (<class 'troposphere.kendra.ConfluenceConfiguration'>,False), 'DatabaseConfiguration': (<class'troposphere.kendra.DatabaseConfiguration'>, False), 'GoogleDriveConfiguration':(<class 'troposphere.kendra.GoogleDriveConfiguration'>, False),'OneDriveConfiguration': (<class 'troposphere.kendra.OneDriveConfiguration'>,False), 'S3Configuration': (<class 'troposphere.kendra.S3DataSourceConfiguration'>,False), 'SalesforceConfiguration': (<class'troposphere.kendra.SalesforceConfiguration'>, False), 'ServiceNowConfiguration':(<class 'troposphere.kendra.ServiceNowConfiguration'>, False),'SharePointConfiguration': (<class 'troposphere.kendra.SharePointConfiguration'>,False), 'WebCrawlerConfiguration': (<class'troposphere.kendra.WebCrawlerConfiguration'>, False), 'WorkDocsConfiguration':(<class 'troposphere.kendra.WorkDocsConfiguration'>, False)}

7.3. troposphere 475

Page 480: Release 3.1
Page 481: Release 3.1
Page 482: Release 3.1
Page 483: Release 3.1
Page 484: Release 3.1
Page 485: Release 3.1
Page 486: Release 3.1
Page 487: Release 3.1
Page 488: Release 3.1
Page 489: Release 3.1
Page 490: Release 3.1
Page 491: Release 3.1
Page 492: Release 3.1
Page 493: Release 3.1
Page 494: Release 3.1
Page 495: Release 3.1
Page 496: Release 3.1
Page 497: Release 3.1
Page 498: Release 3.1
Page 499: Release 3.1
Page 500: Release 3.1
Page 501: Release 3.1
Page 502: Release 3.1
Page 503: Release 3.1
Page 504: Release 3.1
Page 505: Release 3.1
Page 506: Release 3.1
Page 507: Release 3.1
Page 508: Release 3.1
Page 509: Release 3.1
Page 510: Release 3.1
Page 511: Release 3.1
Page 512: Release 3.1
Page 513: Release 3.1
Page 514: Release 3.1
Page 515: Release 3.1
Page 516: Release 3.1
Page 517: Release 3.1
Page 518: Release 3.1
Page 519: Release 3.1
Page 520: Release 3.1
Page 521: Release 3.1
Page 522: Release 3.1
Page 523: Release 3.1
Page 524: Release 3.1
Page 525: Release 3.1
Page 526: Release 3.1
Page 527: Release 3.1
Page 528: Release 3.1
Page 529: Release 3.1
Page 530: Release 3.1
Page 531: Release 3.1
Page 532: Release 3.1
Page 533: Release 3.1
Page 534: Release 3.1
Page 535: Release 3.1
Page 536: Release 3.1
Page 537: Release 3.1
Page 538: Release 3.1
Page 539: Release 3.1
Page 540: Release 3.1
Page 541: Release 3.1
Page 542: Release 3.1
Page 543: Release 3.1
Page 544: Release 3.1
Page 545: Release 3.1
Page 546: Release 3.1
Page 547: Release 3.1
Page 548: Release 3.1
Page 549: Release 3.1
Page 550: Release 3.1
Page 551: Release 3.1
Page 552: Release 3.1
Page 553: Release 3.1
Page 554: Release 3.1
Page 555: Release 3.1
Page 556: Release 3.1
Page 557: Release 3.1
Page 558: Release 3.1
Page 559: Release 3.1
Page 560: Release 3.1
Page 561: Release 3.1
Page 562: Release 3.1
Page 563: Release 3.1
Page 564: Release 3.1
Page 565: Release 3.1
Page 566: Release 3.1
Page 567: Release 3.1
Page 568: Release 3.1
Page 569: Release 3.1
Page 570: Release 3.1
Page 571: Release 3.1
Page 572: Release 3.1
Page 573: Release 3.1
Page 574: Release 3.1
Page 575: Release 3.1
Page 576: Release 3.1
Page 577: Release 3.1
Page 578: Release 3.1
Page 579: Release 3.1
Page 580: Release 3.1
Page 581: Release 3.1
Page 582: Release 3.1
Page 583: Release 3.1
Page 584: Release 3.1
Page 585: Release 3.1
Page 586: Release 3.1
Page 587: Release 3.1
Page 588: Release 3.1
Page 589: Release 3.1
Page 590: Release 3.1
Page 591: Release 3.1
Page 592: Release 3.1
Page 593: Release 3.1
Page 594: Release 3.1
Page 595: Release 3.1
Page 596: Release 3.1
Page 597: Release 3.1
Page 598: Release 3.1
Page 599: Release 3.1
Page 600: Release 3.1
Page 601: Release 3.1
Page 602: Release 3.1
Page 603: Release 3.1
Page 604: Release 3.1
Page 605: Release 3.1
Page 606: Release 3.1
Page 607: Release 3.1
Page 608: Release 3.1
Page 609: Release 3.1
Page 610: Release 3.1
Page 611: Release 3.1
Page 612: Release 3.1
Page 613: Release 3.1
Page 614: Release 3.1
Page 615: Release 3.1
Page 616: Release 3.1
Page 617: Release 3.1
Page 618: Release 3.1
Page 619: Release 3.1
Page 620: Release 3.1
Page 621: Release 3.1
Page 622: Release 3.1
Page 623: Release 3.1
Page 624: Release 3.1
Page 625: Release 3.1
Page 626: Release 3.1
Page 627: Release 3.1
Page 628: Release 3.1
Page 629: Release 3.1
Page 630: Release 3.1
Page 631: Release 3.1
Page 632: Release 3.1
Page 633: Release 3.1
Page 634: Release 3.1
Page 635: Release 3.1
Page 636: Release 3.1
Page 637: Release 3.1
Page 638: Release 3.1
Page 639: Release 3.1
Page 640: Release 3.1
Page 641: Release 3.1
Page 642: Release 3.1
Page 643: Release 3.1
Page 644: Release 3.1
Page 645: Release 3.1
Page 646: Release 3.1
Page 647: Release 3.1
Page 648: Release 3.1
Page 649: Release 3.1
Page 650: Release 3.1
Page 651: Release 3.1
Page 652: Release 3.1
Page 653: Release 3.1
Page 654: Release 3.1
Page 655: Release 3.1
Page 656: Release 3.1
Page 657: Release 3.1
Page 658: Release 3.1
Page 659: Release 3.1
Page 660: Release 3.1
Page 661: Release 3.1
Page 662: Release 3.1
Page 663: Release 3.1
Page 664: Release 3.1
Page 665: Release 3.1
Page 666: Release 3.1
Page 667: Release 3.1
Page 668: Release 3.1
Page 669: Release 3.1
Page 670: Release 3.1
Page 671: Release 3.1
Page 672: Release 3.1
Page 673: Release 3.1
Page 674: Release 3.1
Page 675: Release 3.1
Page 676: Release 3.1
Page 677: Release 3.1
Page 678: Release 3.1
Page 679: Release 3.1
Page 680: Release 3.1
Page 681: Release 3.1
Page 682: Release 3.1
Page 683: Release 3.1
Page 684: Release 3.1
Page 685: Release 3.1
Page 686: Release 3.1
Page 687: Release 3.1
Page 688: Release 3.1
Page 689: Release 3.1
Page 690: Release 3.1
Page 691: Release 3.1
Page 692: Release 3.1
Page 693: Release 3.1
Page 694: Release 3.1
Page 695: Release 3.1
Page 696: Release 3.1
Page 697: Release 3.1
Page 698: Release 3.1
Page 699: Release 3.1
Page 700: Release 3.1
Page 701: Release 3.1
Page 702: Release 3.1
Page 703: Release 3.1
Page 704: Release 3.1
Page 705: Release 3.1
Page 706: Release 3.1
Page 707: Release 3.1
Page 708: Release 3.1
Page 709: Release 3.1
Page 710: Release 3.1
Page 711: Release 3.1
Page 712: Release 3.1
Page 713: Release 3.1
Page 714: Release 3.1
Page 715: Release 3.1
Page 716: Release 3.1
Page 717: Release 3.1
Page 718: Release 3.1
Page 719: Release 3.1
Page 720: Release 3.1
Page 721: Release 3.1
Page 722: Release 3.1
Page 723: Release 3.1
Page 724: Release 3.1
Page 725: Release 3.1
Page 726: Release 3.1
Page 727: Release 3.1
Page 728: Release 3.1
Page 729: Release 3.1
Page 730: Release 3.1
Page 731: Release 3.1
Page 732: Release 3.1
Page 733: Release 3.1
Page 734: Release 3.1
Page 735: Release 3.1
Page 736: Release 3.1
Page 737: Release 3.1
Page 738: Release 3.1
Page 739: Release 3.1
Page 740: Release 3.1
Page 741: Release 3.1
Page 742: Release 3.1
Page 743: Release 3.1
Page 744: Release 3.1
Page 745: Release 3.1
Page 746: Release 3.1
Page 747: Release 3.1
Page 748: Release 3.1
Page 749: Release 3.1
Page 750: Release 3.1
Page 751: Release 3.1
Page 752: Release 3.1
Page 753: Release 3.1
Page 754: Release 3.1
Page 755: Release 3.1
Page 756: Release 3.1
Page 757: Release 3.1
Page 758: Release 3.1
Page 759: Release 3.1
Page 760: Release 3.1
Page 761: Release 3.1
Page 762: Release 3.1
Page 763: Release 3.1
Page 764: Release 3.1
Page 765: Release 3.1
Page 766: Release 3.1
Page 767: Release 3.1
Page 768: Release 3.1
Page 769: Release 3.1
Page 770: Release 3.1
Page 771: Release 3.1
Page 772: Release 3.1
Page 773: Release 3.1
Page 774: Release 3.1
Page 775: Release 3.1
Page 776: Release 3.1
Page 777: Release 3.1
Page 778: Release 3.1
Page 779: Release 3.1
Page 780: Release 3.1
Page 781: Release 3.1
Page 782: Release 3.1
Page 783: Release 3.1
Page 784: Release 3.1
Page 785: Release 3.1
Page 786: Release 3.1
Page 787: Release 3.1
Page 788: Release 3.1
Page 789: Release 3.1
Page 790: Release 3.1
Page 791: Release 3.1
Page 792: Release 3.1
Page 793: Release 3.1
Page 794: Release 3.1
Page 795: Release 3.1
Page 796: Release 3.1
Page 797: Release 3.1
Page 798: Release 3.1
Page 799: Release 3.1
Page 800: Release 3.1
Page 801: Release 3.1
Page 802: Release 3.1
Page 803: Release 3.1
Page 804: Release 3.1
Page 805: Release 3.1
Page 806: Release 3.1
Page 807: Release 3.1
Page 808: Release 3.1
Page 809: Release 3.1
Page 810: Release 3.1
Page 811: Release 3.1
Page 812: Release 3.1
Page 813: Release 3.1
Page 814: Release 3.1
Page 815: Release 3.1
Page 816: Release 3.1
Page 817: Release 3.1
Page 818: Release 3.1
Page 819: Release 3.1
Page 820: Release 3.1
Page 821: Release 3.1
Page 822: Release 3.1
Page 823: Release 3.1
Page 824: Release 3.1
Page 825: Release 3.1
Page 826: Release 3.1
Page 827: Release 3.1
Page 828: Release 3.1
Page 829: Release 3.1
Page 830: Release 3.1
Page 831: Release 3.1
Page 832: Release 3.1
Page 833: Release 3.1
Page 834: Release 3.1
Page 835: Release 3.1
Page 836: Release 3.1
Page 837: Release 3.1
Page 838: Release 3.1
Page 839: Release 3.1
Page 840: Release 3.1
Page 841: Release 3.1
Page 842: Release 3.1
Page 843: Release 3.1
Page 844: Release 3.1
Page 845: Release 3.1
Page 846: Release 3.1
Page 847: Release 3.1
Page 848: Release 3.1
Page 849: Release 3.1
Page 850: Release 3.1
Page 851: Release 3.1
Page 852: Release 3.1
Page 853: Release 3.1
Page 854: Release 3.1
Page 855: Release 3.1
Page 856: Release 3.1
Page 857: Release 3.1
Page 858: Release 3.1
Page 859: Release 3.1
Page 860: Release 3.1
Page 861: Release 3.1
Page 862: Release 3.1
Page 863: Release 3.1
Page 864: Release 3.1
Page 865: Release 3.1
Page 866: Release 3.1
Page 867: Release 3.1
Page 868: Release 3.1
Page 869: Release 3.1
Page 870: Release 3.1
Page 871: Release 3.1
Page 872: Release 3.1
Page 873: Release 3.1
Page 874: Release 3.1
Page 875: Release 3.1
Page 876: Release 3.1
Page 877: Release 3.1
Page 878: Release 3.1
Page 879: Release 3.1
Page 880: Release 3.1
Page 881: Release 3.1
Page 882: Release 3.1
Page 883: Release 3.1
Page 884: Release 3.1
Page 885: Release 3.1
Page 886: Release 3.1
Page 887: Release 3.1
Page 888: Release 3.1
Page 889: Release 3.1
Page 890: Release 3.1
Page 891: Release 3.1
Page 892: Release 3.1
Page 893: Release 3.1
Page 894: Release 3.1
Page 895: Release 3.1
Page 896: Release 3.1
Page 897: Release 3.1
Page 898: Release 3.1
Page 899: Release 3.1
Page 900: Release 3.1
Page 901: Release 3.1
Page 902: Release 3.1
Page 903: Release 3.1
Page 904: Release 3.1
Page 905: Release 3.1
Page 906: Release 3.1
Page 907: Release 3.1
Page 908: Release 3.1
Page 909: Release 3.1
Page 910: Release 3.1
Page 911: Release 3.1
Page 912: Release 3.1
Page 913: Release 3.1
Page 914: Release 3.1
Page 915: Release 3.1
Page 916: Release 3.1
Page 917: Release 3.1
Page 918: Release 3.1
Page 919: Release 3.1
Page 920: Release 3.1
Page 921: Release 3.1
Page 922: Release 3.1
Page 923: Release 3.1
Page 924: Release 3.1
Page 925: Release 3.1
Page 926: Release 3.1
Page 927: Release 3.1
Page 928: Release 3.1
Page 929: Release 3.1
Page 930: Release 3.1
Page 931: Release 3.1
Page 932: Release 3.1
Page 933: Release 3.1
Page 934: Release 3.1
Page 935: Release 3.1
Page 936: Release 3.1
Page 937: Release 3.1
Page 938: Release 3.1
Page 939: Release 3.1
Page 940: Release 3.1
Page 941: Release 3.1
Page 942: Release 3.1
Page 943: Release 3.1
Page 944: Release 3.1
Page 945: Release 3.1
Page 946: Release 3.1
Page 947: Release 3.1
Page 948: Release 3.1
Page 949: Release 3.1
Page 950: Release 3.1
Page 951: Release 3.1
Page 952: Release 3.1
Page 953: Release 3.1
Page 954: Release 3.1
Page 955: Release 3.1
Page 956: Release 3.1
Page 957: Release 3.1
Page 958: Release 3.1
Page 959: Release 3.1
Page 960: Release 3.1
Page 961: Release 3.1
Page 962: Release 3.1
Page 963: Release 3.1
Page 964: Release 3.1
Page 965: Release 3.1
Page 966: Release 3.1
Page 967: Release 3.1
Page 968: Release 3.1
Page 969: Release 3.1
Page 970: Release 3.1
Page 971: Release 3.1
Page 972: Release 3.1
Page 973: Release 3.1
Page 974: Release 3.1
Page 975: Release 3.1
Page 976: Release 3.1
Page 977: Release 3.1
Page 978: Release 3.1
Page 979: Release 3.1
Page 980: Release 3.1
Page 981: Release 3.1
Page 982: Release 3.1
Page 983: Release 3.1
Page 984: Release 3.1
Page 985: Release 3.1
Page 986: Release 3.1
Page 987: Release 3.1
Page 988: Release 3.1
Page 989: Release 3.1
Page 990: Release 3.1
Page 991: Release 3.1
Page 992: Release 3.1
Page 993: Release 3.1
Page 994: Release 3.1
Page 995: Release 3.1
Page 996: Release 3.1
Page 997: Release 3.1
Page 998: Release 3.1
Page 999: Release 3.1
Page 1000: Release 3.1
Page 1001: Release 3.1
Page 1002: Release 3.1
Page 1003: Release 3.1
Page 1004: Release 3.1
Page 1005: Release 3.1
Page 1006: Release 3.1
Page 1007: Release 3.1
Page 1008: Release 3.1
Page 1009: Release 3.1
Page 1010: Release 3.1
Page 1011: Release 3.1
Page 1012: Release 3.1