CfnDomainConfigurationProps

class aws_cdk.aws_iot.CfnDomainConfigurationProps(*, authorizer_config=None, domain_configuration_name=None, domain_configuration_status=None, domain_name=None, server_certificate_arns=None, service_type=None, tags=None, tls_config=None, validation_certificate_arn=None)

Bases: object

Properties for defining a CfnDomainConfiguration.

Parameters:

  • authorizer_config (Union[IResolvable, AuthorizerConfigProperty, Dict[str, Any], None]) – An object that specifies the authorization service for a domain.

  • domain_configuration_name (Optional[str]) – The name of the domain configuration. This value must be unique to a region.

  • domain_configuration_status (Optional[str]) – The status to which the domain configuration should be updated. Valid values: ENABLED | DISABLED

  • domain_name (Optional[str]) – The name of the domain.

  • server_certificate_arns (Optional[Sequence[str]]) – 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.

  • service_type (Optional[str]) – The type of service delivered by the endpoint. .. epigraph:: AWS IoT Core currently supports only the DATA service type.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Metadata which can be used to manage the domain configuration. .. epigraph:: 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…”

  • tls_config (Union[IResolvable, TlsConfigProperty, Dict[str, Any], None]) – AWS::IoT::DomainConfiguration.TlsConfig.

  • validation_certificate_arn (Optional[str]) – 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.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iot as iot

cfn_domain_configuration_props = iot.CfnDomainConfigurationProps(
    authorizer_config=iot.CfnDomainConfiguration.AuthorizerConfigProperty(
        allow_authorizer_override=False,
        default_authorizer_name="defaultAuthorizerName"
    ),
    domain_configuration_name="domainConfigurationName",
    domain_configuration_status="domainConfigurationStatus",
    domain_name="domainName",
    server_certificate_arns=["serverCertificateArns"],
    service_type="serviceType",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    tls_config=iot.CfnDomainConfiguration.TlsConfigProperty(
        security_policy="securityPolicy"
    ),
    validation_certificate_arn="validationCertificateArn"
)

Attributes

authorizer_config

An object that specifies the authorization service for a domain.

Link:

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

domain_configuration_name

The name of the domain configuration.

This value must be unique to a region.

Link:

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

domain_configuration_status

The status to which the domain configuration should be updated.

Valid values: ENABLED | DISABLED

Link:

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

domain_name

The name of the domain.

Link:

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

server_certificate_arns

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.

Link:

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

service_type

The type of service delivered by the endpoint.

AWS IoT Core currently supports only the DATA service type.

Link:

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.

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…”

Link:

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

tls_config

AWS::IoT::DomainConfiguration.TlsConfig.

Link:

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

validation_certificate_arn

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.

Link:

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