AWS::IoT::DomainConfiguration
Specifies a domain configuration.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::IoT::DomainConfiguration", "Properties" : { "AuthorizerConfig" :
AuthorizerConfig
, "DomainConfigurationName" :String
, "DomainConfigurationStatus" :String
, "DomainName" :String
, "ServerCertificateArns" :[ String, ... ]
, "ServiceType" :String
, "Tags" :[ Tag, ... ]
, "ValidationCertificateArn" :String
} }
YAML
Type: AWS::IoT::DomainConfiguration Properties: AuthorizerConfig:
AuthorizerConfig
DomainConfigurationName:String
DomainConfigurationStatus:String
DomainName:String
ServerCertificateArns:- String
ServiceType:String
Tags:- Tag
ValidationCertificateArn:String
Properties
AuthorizerConfig
-
An object that specifies the authorization service for a domain.
Required: No
Type: AuthorizerConfig
Update requires: No interruption
DomainConfigurationName
-
The name of the domain configuration. This value must be unique to a region.
Required: No
Type: String
Update requires: Replacement
DomainConfigurationStatus
-
The status to which the domain configuration should be updated.
Valid values:
ENABLED
|DISABLED
Required: No
Type: String
Update requires: No interruption
DomainName
-
The name of the domain.
Required: No
Type: String
Update requires: Replacement
ServerCertificateArns
-
The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for AWS-managed domains.
Required: No
Type: List of String
Update requires: Replacement
ServiceType
-
The type of service delivered by the endpoint.
Note AWS IoT Core currently supports only the
DATA
service type.Required: No
Type: String
Update requires: Replacement
Tags
-
Metadata which can be used to manage the domain configuration.
Note For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
Required: No
Type: List of Tag
Update requires: No interruption
ValidationCertificateArn
-
The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for AWS-managed domains.
Required: No
Type: String
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the domain configuration name. For example:
{ "Ref": "MyDomainConfiguration" }
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.
Arn
-
The Amazon Resource Name (ARN) of the domain configuration.
DomainType
-
The type of service delivered by the domain.
ServerCertificates
-
The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for AWS-managed domains.