CfnDomainConfigurationPropsMixin

class aws_cdk.mixins_preview.aws_iot.mixins.CfnDomainConfigurationPropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies a domain configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html
CloudformationResource:: AWS::IoT::DomainConfiguration
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_domain_configuration_props_mixin = iot_mixins.CfnDomainConfigurationPropsMixin(iot_mixins.CfnDomainConfigurationMixinProps(
    application_protocol="applicationProtocol",
    authentication_type="authenticationType",
    authorizer_config=iot_mixins.CfnDomainConfigurationPropsMixin.AuthorizerConfigProperty(
        allow_authorizer_override=False,
        default_authorizer_name="defaultAuthorizerName"
    ),
    client_certificate_config=iot_mixins.CfnDomainConfigurationPropsMixin.ClientCertificateConfigProperty(
        client_certificate_callback_arn="clientCertificateCallbackArn"
    ),
    domain_configuration_name="domainConfigurationName",
    domain_configuration_status="domainConfigurationStatus",
    domain_name="domainName",
    server_certificate_arns=["serverCertificateArns"],
    server_certificate_config=iot_mixins.CfnDomainConfigurationPropsMixin.ServerCertificateConfigProperty(
        enable_ocsp_check=False,
        ocsp_authorized_responder_arn="ocspAuthorizedResponderArn",
        ocsp_lambda_arn="ocspLambdaArn"
    ),
    service_type="serviceType",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    tls_config=iot_mixins.CfnDomainConfigurationPropsMixin.TlsConfigProperty(
        security_policy="securityPolicy"
    ),
    validation_certificate_arn="validationCertificateArn"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoT::DomainConfiguration.

Parameters:

props (Union[CfnDomainConfigurationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['applicationProtocol', 'authenticationType', 'authorizerConfig', 'clientCertificateConfig', 'domainConfigurationName', 'domainConfigurationStatus', 'domainName', 'serverCertificateArns', 'serverCertificateConfig', 'serviceType', 'tags', 'tlsConfig', 'validationCertificateArn']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AuthorizerConfigProperty

class CfnDomainConfigurationPropsMixin.AuthorizerConfigProperty(*, allow_authorizer_override=None, default_authorizer_name=None)

Bases: object

An object that specifies the authorization service for a domain.

Parameters:

allow_authorizer_override (Union[bool, IResolvable, None]) – A Boolean that specifies whether the domain configuration’s authorization service can be overridden.
default_authorizer_name (Optional[str]) – The name of the authorization service for a domain configuration.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

authorizer_config_property = iot_mixins.CfnDomainConfigurationPropsMixin.AuthorizerConfigProperty(
    allow_authorizer_override=False,
    default_authorizer_name="defaultAuthorizerName"
)

Attributes

allow_authorizer_override

A Boolean that specifies whether the domain configuration’s authorization service can be overridden.

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

default_authorizer_name

The name of the authorization service for a domain configuration.

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

ClientCertificateConfigProperty

class CfnDomainConfigurationPropsMixin.ClientCertificateConfigProperty(*, client_certificate_callback_arn=None)

Bases: object

An object that speciﬁes the client certificate conﬁguration for a domain.

Parameters:: client_certificate_callback_arn (Optional[str]) – The ARN of the Lambda function that IoT invokes after mutual TLS authentication during the connection.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-clientcertificateconfig.html
ExampleMetadata:: fixture=_generated

Example:

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

client_certificate_config_property = iot_mixins.CfnDomainConfigurationPropsMixin.ClientCertificateConfigProperty(
    client_certificate_callback_arn="clientCertificateCallbackArn"
)

Attributes

client_certificate_callback_arn

The ARN of the Lambda function that IoT invokes after mutual TLS authentication during the connection.

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

ServerCertificateConfigProperty

class CfnDomainConfigurationPropsMixin.ServerCertificateConfigProperty(*, enable_ocsp_check=None, ocsp_authorized_responder_arn=None, ocsp_lambda_arn=None)

Bases: object

The server certificate configuration.

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

Parameters:

enable_ocsp_check (Union[bool, IResolvable, None]) –
A Boolean value that indicates whether Online Certificate Status Protocol (OCSP) server certificate check is enabled or not. For more information, see Configurable endpoints from the AWS IoT Core Developer Guide.
ocsp_authorized_responder_arn (Optional[str]) – The Amazon Resource Name (ARN) for an X.509 certificate stored in ACM. If provided, AWS IoT Core will use this certificate to validate the signature of the received OCSP response. The OCSP responder must sign responses using either this authorized responder certificate or the issuing certificate, depending on whether the ARN is provided or not. The certificate must be in the same account and region as the domain configuration.
ocsp_lambda_arn (Optional[str]) – The Amazon Resource Name (ARN) for a Lambda function that acts as a Request for Comments (RFC) 6960-compliant Online Certificate Status Protocol (OCSP) responder, supporting basic OCSP responses. The Lambda function accepts a base64-encoding of the OCSP request in the Distinguished Encoding Rules (DER) format. The Lambda function’s response is also a base64-encoded OCSP response in the DER format. The response size must not exceed 4 kilobytes (KiB). The Lambda function must be in the same account and region as the domain configuration.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

server_certificate_config_property = iot_mixins.CfnDomainConfigurationPropsMixin.ServerCertificateConfigProperty(
    enable_ocsp_check=False,
    ocsp_authorized_responder_arn="ocspAuthorizedResponderArn",
    ocsp_lambda_arn="ocspLambdaArn"
)

Attributes

enable_ocsp_check

A Boolean value that indicates whether Online Certificate Status Protocol (OCSP) server certificate check is enabled or not.

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

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

ocsp_authorized_responder_arn

The Amazon Resource Name (ARN) for an X.509 certificate stored in ACM. If provided, AWS IoT Core will use this certificate to validate the signature of the received OCSP response. The OCSP responder must sign responses using either this authorized responder certificate or the issuing certificate, depending on whether the ARN is provided or not. The certificate must be in the same account and region as the domain configuration.

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

ocsp_lambda_arn

The Amazon Resource Name (ARN) for a Lambda function that acts as a Request for Comments (RFC) 6960-compliant Online Certificate Status Protocol (OCSP) responder, supporting basic OCSP responses.

The Lambda function accepts a base64-encoding of the OCSP request in the Distinguished Encoding Rules (DER) format. The Lambda function’s response is also a base64-encoded OCSP response in the DER format. The response size must not exceed 4 kilobytes (KiB). The Lambda function must be in the same account and region as the domain configuration.

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

ServerCertificateSummaryProperty

class CfnDomainConfigurationPropsMixin.ServerCertificateSummaryProperty(*, server_certificate_arn=None, server_certificate_status=None, server_certificate_status_detail=None)

Bases: object

An object that contains information about a server certificate.

Parameters:

server_certificate_arn (Optional[str]) – The ARN of the server certificate.
server_certificate_status (Optional[str]) – The status of the server certificate.
server_certificate_status_detail (Optional[str]) – Details that explain the status of the server certificate.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

server_certificate_summary_property = iot_mixins.CfnDomainConfigurationPropsMixin.ServerCertificateSummaryProperty(
    server_certificate_arn="serverCertificateArn",
    server_certificate_status="serverCertificateStatus",
    server_certificate_status_detail="serverCertificateStatusDetail"
)

Attributes

server_certificate_arn

The ARN of the server certificate.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-servercertificatesummary.html#cfn-iot-domainconfiguration-servercertificatesummary-servercertificatearn

server_certificate_status

The status of the server certificate.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-servercertificatesummary.html#cfn-iot-domainconfiguration-servercertificatesummary-servercertificatestatus

server_certificate_status_detail

Details that explain the status of the server certificate.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-servercertificatesummary.html#cfn-iot-domainconfiguration-servercertificatesummary-servercertificatestatusdetail

TlsConfigProperty

class CfnDomainConfigurationPropsMixin.TlsConfigProperty(*, security_policy=None)

Bases: object

An object that specifies the TLS configuration for a domain.

Parameters:: security_policy (Optional[str]) – The security policy for a domain configuration. For more information, see Security policies in the AWS IoT Core developer guide .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-domainconfiguration-tlsconfig.html
ExampleMetadata:: fixture=_generated

Example:

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

tls_config_property = iot_mixins.CfnDomainConfigurationPropsMixin.TlsConfigProperty(
    security_policy="securityPolicy"
)

Attributes

security_policy

The security policy for a domain configuration.

For more information, see Security policies in the AWS IoT Core developer guide .

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