Class CfnDomainConfiguration
Specifies a domain configuration.
Inherited Members
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDomainConfiguration : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDomainConfiguration
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
CloudformationResource: AWS::IoT::DomainConfiguration
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 cfnDomainConfiguration = new CfnDomainConfiguration(this, "MyCfnDomainConfiguration", new CfnDomainConfigurationProps {
AuthorizerConfig = new AuthorizerConfigProperty {
AllowAuthorizerOverride = false,
DefaultAuthorizerName = "defaultAuthorizerName"
},
DomainConfigurationName = "domainConfigurationName",
DomainConfigurationStatus = "domainConfigurationStatus",
DomainName = "domainName",
ServerCertificateArns = new [] { "serverCertificateArns" },
ServerCertificateConfig = new ServerCertificateConfigProperty {
EnableOcspCheck = false
},
ServiceType = "serviceType",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TlsConfig = new TlsConfigProperty {
SecurityPolicy = "securityPolicy"
},
ValidationCertificateArn = "validationCertificateArn"
});
Synopsis
Constructors
CfnDomainConfiguration(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDomainConfiguration(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDomainConfiguration(Construct, String, ICfnDomainConfigurationProps) |
Properties
AttrArn | The Amazon Resource Name (ARN) of the domain configuration. |
AttrDomainType | The type of service delivered by the domain. |
AttrServerCertificates | The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake. |
AuthorizerConfig | An object that specifies the authorization service for a domain. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
ServerCertificateConfig | The server certificate configuration. |
ServiceType | The type of service delivered by the endpoint. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | Metadata which can be used to manage the domain configuration. |
TlsConfig | An object that specifies the TLS configuration for a domain. |
ValidationCertificateArn | The certificate used to validate the server certificate and prove domain name ownership. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDomainConfiguration(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDomainConfiguration(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDomainConfiguration(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDomainConfiguration(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDomainConfiguration(Construct, String, ICfnDomainConfigurationProps)
public CfnDomainConfiguration(Construct scope, string id, ICfnDomainConfigurationProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDomainConfigurationProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) of the domain configuration.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrDomainType
The type of service delivered by the domain.
public virtual string AttrDomainType { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DomainType
AttrServerCertificates
The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.
public virtual IResolvable AttrServerCertificates { get; }
Property Value
Remarks
Currently you can specify only one certificate ARN. This value is not required for AWS -managed domains.
CloudformationAttribute: ServerCertificates
AuthorizerConfig
An object that specifies the authorization service for a domain.
public virtual object AuthorizerConfig { get; set; }
Property Value
System.Object
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DomainConfigurationName
The name of the domain configuration.
public virtual string DomainConfigurationName { get; set; }
Property Value
System.String
DomainConfigurationStatus
The status to which the domain configuration should be updated.
public virtual string DomainConfigurationStatus { get; set; }
Property Value
System.String
DomainName
The name of the domain.
public virtual string DomainName { get; set; }
Property Value
System.String
ServerCertificateArns
The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.
public virtual string[] ServerCertificateArns { get; set; }
Property Value
System.String[]
ServerCertificateConfig
The server certificate configuration.
public virtual object ServerCertificateConfig { get; set; }
Property Value
System.Object
ServiceType
The type of service delivered by the endpoint.
public virtual string ServiceType { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Metadata which can be used to manage the domain configuration.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
TlsConfig
An object that specifies the TLS configuration for a domain.
public virtual object TlsConfig { get; set; }
Property Value
System.Object
ValidationCertificateArn
The certificate used to validate the server certificate and prove domain name ownership.
public virtual string ValidationCertificateArn { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>