Class CfnDomainConfigurationMixinProps

Properties for CfnDomainConfigurationPropsMixin.

Inheritance

object

CfnDomainConfigurationMixinProps

Implements

ICfnDomainConfigurationMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.IoT

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnDomainConfigurationMixinProps : ICfnDomainConfigurationMixinProps

Syntax (vb)

Public Class CfnDomainConfigurationMixinProps Implements ICfnDomainConfigurationMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html

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.CfnPropertyMixins.AWS.IoT;

             var cfnDomainConfigurationMixinProps = new CfnDomainConfigurationMixinProps {
                 ApplicationProtocol = "applicationProtocol",
                 AuthenticationType = "authenticationType",
                 AuthorizerConfig = new AuthorizerConfigProperty {
                     AllowAuthorizerOverride = false,
                     DefaultAuthorizerName = "defaultAuthorizerName"
                 },
                 ClientCertificateConfig = new ClientCertificateConfigProperty {
                     ClientCertificateCallbackArn = "clientCertificateCallbackArn"
                 },
                 DomainConfigurationName = "domainConfigurationName",
                 DomainConfigurationStatus = "domainConfigurationStatus",
                 DomainName = "domainName",
                 ServerCertificateArns = new [] { "serverCertificateArns" },
                 ServerCertificateConfig = new ServerCertificateConfigProperty {
                     EnableOcspCheck = false,
                     OcspAuthorizedResponderArn = "ocspAuthorizedResponderArn",
                     OcspLambdaArn = "ocspLambdaArn"
                 },
                 ServiceType = "serviceType",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TlsConfig = new TlsConfigProperty {
                     SecurityPolicy = "securityPolicy"
                 },
                 ValidationCertificateArn = "validationCertificateArn"
             };

Synopsis

Constructors

CfnDomainConfigurationMixinProps()

Properties for CfnDomainConfigurationPropsMixin.

Properties

ApplicationProtocol	An enumerated string that specifies the application-layer protocol.
AuthenticationType	An enumerated string that specifies the authentication type.
AuthorizerConfig	An object that specifies the authorization service for a domain.
ClientCertificateConfig	An object that specifies the client certificate configuration 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.
ServerCertificateConfig	The server certificate configuration.
ServiceType	The type of service delivered by the endpoint.
Tags	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.

Constructors

CfnDomainConfigurationMixinProps()

Properties for CfnDomainConfigurationPropsMixin.

public CfnDomainConfigurationMixinProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html

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.CfnPropertyMixins.AWS.IoT;

             var cfnDomainConfigurationMixinProps = new CfnDomainConfigurationMixinProps {
                 ApplicationProtocol = "applicationProtocol",
                 AuthenticationType = "authenticationType",
                 AuthorizerConfig = new AuthorizerConfigProperty {
                     AllowAuthorizerOverride = false,
                     DefaultAuthorizerName = "defaultAuthorizerName"
                 },
                 ClientCertificateConfig = new ClientCertificateConfigProperty {
                     ClientCertificateCallbackArn = "clientCertificateCallbackArn"
                 },
                 DomainConfigurationName = "domainConfigurationName",
                 DomainConfigurationStatus = "domainConfigurationStatus",
                 DomainName = "domainName",
                 ServerCertificateArns = new [] { "serverCertificateArns" },
                 ServerCertificateConfig = new ServerCertificateConfigProperty {
                     EnableOcspCheck = false,
                     OcspAuthorizedResponderArn = "ocspAuthorizedResponderArn",
                     OcspLambdaArn = "ocspLambdaArn"
                 },
                 ServiceType = "serviceType",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TlsConfig = new TlsConfigProperty {
                     SecurityPolicy = "securityPolicy"
                 },
                 ValidationCertificateArn = "validationCertificateArn"
             };

Properties

ApplicationProtocol

An enumerated string that specifies the application-layer protocol.

public string? ApplicationProtocol { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-applicationprotocol

AuthenticationType

An enumerated string that specifies the authentication type.

public string? AuthenticationType { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-authenticationtype

AuthorizerConfig

An object that specifies the authorization service for a domain.

public object? AuthorizerConfig { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-authorizerconfig

Type union: either IResolvable or CfnDomainConfigurationPropsMixin.IAuthorizerConfigProperty

ClientCertificateConfig

An object that specifies the client certificate configuration for a domain.

public object? ClientCertificateConfig { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-clientcertificateconfig

Type union: either IResolvable or CfnDomainConfigurationPropsMixin.IClientCertificateConfigProperty

DomainConfigurationName

The name of the domain configuration.

public string? DomainConfigurationName { get; set; }

Property Value

string

Remarks

This value must be unique to a region.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-domainconfigurationname

DomainConfigurationStatus

The status to which the domain configuration should be updated.

public string? DomainConfigurationStatus { get; set; }

Property Value

string

Remarks

Valid values: ENABLED | DISABLED

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-domainconfigurationstatus

DomainName

The name of the domain.

public string? DomainName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-domainname

ServerCertificateArns

The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.

public string[]? ServerCertificateArns { get; set; }

Property Value

string[]

Remarks

Currently you can specify only one certificate ARN. This value is not required for AWS -managed domains.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-servercertificatearns

ServerCertificateConfig

The server certificate configuration.

public object? ServerCertificateConfig { get; set; }

Property Value

object

Remarks

For more information, see Configurable endpoints from the AWS IoT Core Developer Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-servercertificateconfig

Type union: either IResolvable or CfnDomainConfigurationPropsMixin.IServerCertificateConfigProperty

ServiceType

The type of service delivered by the endpoint.

public string? ServiceType { get; set; }

Property Value

string

Remarks

AWS IoT Core currently supports only the <code>DATA</code> service type.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-servicetype

Tags

Metadata which can be used to manage the domain configuration.

public ICfnTag[]? Tags { get; set; }

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..."

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-tags

TlsConfig

An object that specifies the TLS configuration for a domain.

public object? TlsConfig { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-tlsconfig

Type union: either IResolvable or CfnDomainConfigurationPropsMixin.ITlsConfigProperty

ValidationCertificateArn

The certificate used to validate the server certificate and prove domain name ownership.

public string? ValidationCertificateArn { get; set; }

Property Value

string

Remarks

This certificate must be signed by a public certificate authority. This value is not required for AWS -managed domains.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-validationcertificatearn

Implements

ICfnDomainConfigurationMixinProps