AWS::ElasticLoadBalancingV2::TrustStore - AWS CloudFormation

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::ElasticLoadBalancingV2::TrustStore

Creates a trust store. You must specify CaCertificatesBundleS3Bucket and CaCertificatesBundleS3Key. When you create a trust store, you must specify Name.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::ElasticLoadBalancingV2::TrustStore", "Properties" : { "CaCertificatesBundleS3Bucket" : String, "CaCertificatesBundleS3Key" : String, "CaCertificatesBundleS3ObjectVersion" : String, "Name" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::ElasticLoadBalancingV2::TrustStore Properties: CaCertificatesBundleS3Bucket: String CaCertificatesBundleS3Key: String CaCertificatesBundleS3ObjectVersion: String Name: String Tags: - Tag

Properties

CaCertificatesBundleS3Bucket

The Amazon S3 bucket for the ca certificates bundle.

Required: No

Type: String

Update requires: No interruption

CaCertificatesBundleS3Key

The Amazon S3 path for the ca certificates bundle.

Required: No

Type: String

Update requires: No interruption

CaCertificatesBundleS3ObjectVersion

The Amazon S3 object version for the ca certificates bundle. If undefined the current version is used.

Required: No

Type: String

Update requires: No interruption

Name

The name of the trust store.

Required: No

Type: String

Pattern: ^([a-zA-Z0-9]+-)*[a-zA-Z0-9]+$

Minimum: 1

Maximum: 32

Update requires: Replacement

Tags

The tags to assign to the trust store.

Required: No

Type: Array of Tag

Minimum: 1

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Resource Name (ARN) of the trust store.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

NumberOfCaCertificates

The number of ca certificates in the trust store.

Status

The status of the trust store. The possible values are CREATING and ACTIVE.

TrustStoreArn

The Amazon Resource Name (ARN) of the trust store.

Examples

The following example creates a trust store.

YAML

myTrustStore: Type: 'AWS::ElasticLoadBalancingV2::TrustStore' Properties: Name: my-trust-store CaCertificatesBundleS3Bucket: amzn-s3-demo-bucket CaCertificatesBundleS3Key: certificates/ca-bundle.pem

JSON

{ "myTrustStore": { "Type": "AWS::ElasticLoadBalancingV2::TrustStore", "Properties": { "Name": "my-trust-store", "CaCertificatesBundleS3Bucket": "amzn-s3-demo-bucket", "CaCertificatesBundleS3Key": "certificates/ca-bundle.pem" } } }