This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::Connect::SecurityKey
The security key for the instance.
Only two security keys are allowed per Connect Customer instance.
Syntax
To declare this entity in your CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Connect::SecurityKey", "Properties" : { "InstanceId" :String, "Key" :String} }
YAML
Type: AWS::Connect::SecurityKey Properties: InstanceId:StringKey:String
Properties
InstanceId-
The Amazon Resource Name (ARN) of the instance.
Minimum:
1Maximum:
100Required: Yes
Type: String
Pattern:
^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$Minimum:
1Maximum:
100Update requires: Replacement
Key-
A valid security key in PEM format. For example:
"-----BEGIN PUBLIC KEY-----\ [a lot of characters] ----END PUBLIC KEY-----"Minimum:
1Maximum:
1024Required: Yes
Type: String
Minimum:
1Maximum:
1024Update requires: Replacement
Return values
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.
AssociationId-
An
AssociationIdis automatically generated when a storage config is associated with an instance.
Examples
Specify a security key for an Amazon Connect instance
The following example specifies a security key for an Connect Customer instance.
YAML
AWSTemplateFormatVersion: 2010-09-09 Description: Specifies a security key for an Amazon Connect instance Resources: SecurityKey: Type: AWS::Connect::SecurityKey Properties: InstanceId: arn:aws:connect:region-name:aws-account-id:instance/instance-arn Key: "valid-pem-key"