Interface ICfnDomainConfigurationProps
Properties for defining a CfnDomainConfiguration
.
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.AWS.IoT.dll
Syntax (csharp)
public interface ICfnDomainConfigurationProps
Syntax (vb)
Public Interface ICfnDomainConfigurationProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoT;
var cfnDomainConfigurationProps = new CfnDomainConfigurationProps {
AuthorizerConfig = new AuthorizerConfigProperty {
AllowAuthorizerOverride = false,
DefaultAuthorizerName = "defaultAuthorizerName"
},
DomainConfigurationName = "domainConfigurationName",
DomainConfigurationStatus = "domainConfigurationStatus",
DomainName = "domainName",
ServerCertificateArns = new [] { "serverCertificateArns" },
ServiceType = "serviceType",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TlsConfig = new TlsConfigProperty {
SecurityPolicy = "securityPolicy"
},
ValidationCertificateArn = "validationCertificateArn"
};
Synopsis
Properties
AuthorizerConfig | An object that specifies the authorization service for a domain. |
DomainConfigurationName | The name of the domain configuration. |
DomainConfigurationStatus | The status to which the domain configuration should be updated. |
DomainName | The name of the domain. |
ServerCertificateArns | The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake. |
ServiceType | The type of service delivered by the endpoint. |
Tags | Metadata which can be used to manage the domain configuration. |
TlsConfig |
|
ValidationCertificateArn | The certificate used to validate the server certificate and prove domain name ownership. |
Properties
AuthorizerConfig
An object that specifies the authorization service for a domain.
virtual object AuthorizerConfig { get; }
Property Value
System.Object
Remarks
DomainConfigurationName
The name of the domain configuration.
virtual string DomainConfigurationName { get; }
Property Value
System.String
Remarks
This value must be unique to a region.
DomainConfigurationStatus
The status to which the domain configuration should be updated.
virtual string DomainConfigurationStatus { get; }
Property Value
System.String
Remarks
DomainName
The name of the domain.
virtual string DomainName { get; }
Property Value
System.String
Remarks
ServerCertificateArns
The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.
virtual string[] ServerCertificateArns { get; }
Property Value
System.String[]
Remarks
Currently you can specify only one certificate ARN. This value is not required for AWS -managed domains.
ServiceType
The type of service delivered by the endpoint.
virtual string ServiceType { get; }
Property Value
System.String
Remarks
AWS IoT Core currently supports only the DATA
service type.
Tags
Metadata which can be used to manage the domain configuration.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
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..."
TlsConfig
AWS::IoT::DomainConfiguration.TlsConfig
.
virtual object TlsConfig { get; }
Property Value
System.Object
Remarks
ValidationCertificateArn
The certificate used to validate the server certificate and prove domain name ownership.
virtual string ValidationCertificateArn { get; }
Property Value
System.String
Remarks
This certificate must be signed by a public certificate authority. This value is not required for AWS -managed domains.