Package software.amazon.awscdk.cfnpropertymixins.services.iot

Class CfnDomainConfigurationPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.iot.CfnDomainConfigurationPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDomainConfigurationPropsMixin>

Enclosing class:

CfnDomainConfigurationPropsMixin

@Stability(Stable)
public static final class CfnDomainConfigurationPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDomainConfigurationPropsMixin>

A fluent builder for CfnDomainConfigurationPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnDomainConfigurationPropsMixin.Builder	applicationProtocol(String applicationProtocol)	An enumerated string that specifies the application-layer protocol.
CfnDomainConfigurationPropsMixin.Builder	authenticationType(String authenticationType)	An enumerated string that specifies the authentication type.
CfnDomainConfigurationPropsMixin.Builder	authorizerConfig(CfnDomainConfigurationPropsMixin.AuthorizerConfigProperty authorizerConfig)	An object that specifies the authorization service for a domain.
CfnDomainConfigurationPropsMixin.Builder	authorizerConfig(IResolvable authorizerConfig)	An object that specifies the authorization service for a domain.
CfnDomainConfigurationPropsMixin	build()
CfnDomainConfigurationPropsMixin.Builder	clientCertificateConfig(CfnDomainConfigurationPropsMixin.ClientCertificateConfigProperty clientCertificateConfig)	An object that specifies the client certificate configuration for a domain.
CfnDomainConfigurationPropsMixin.Builder	clientCertificateConfig(IResolvable clientCertificateConfig)	An object that specifies the client certificate configuration for a domain.
static CfnDomainConfigurationPropsMixin.Builder	create()
static CfnDomainConfigurationPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnDomainConfigurationPropsMixin.Builder	domainConfigurationName(String domainConfigurationName)	The name of the domain configuration.
CfnDomainConfigurationPropsMixin.Builder	domainConfigurationStatus(String domainConfigurationStatus)	The status to which the domain configuration should be updated.
CfnDomainConfigurationPropsMixin.Builder	domainName(String domainName)	The name of the domain.
CfnDomainConfigurationPropsMixin.Builder	serverCertificateArns(List<String> serverCertificateArns)	The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.
CfnDomainConfigurationPropsMixin.Builder	serverCertificateConfig(CfnDomainConfigurationPropsMixin.ServerCertificateConfigProperty serverCertificateConfig)	The server certificate configuration.
CfnDomainConfigurationPropsMixin.Builder	serverCertificateConfig(IResolvable serverCertificateConfig)	The server certificate configuration.
CfnDomainConfigurationPropsMixin.Builder	serviceType(String serviceType)	The type of service delivered by the endpoint.
CfnDomainConfigurationPropsMixin.Builder	tags(List<? extends CfnTag> tags)	Metadata which can be used to manage the domain configuration.
CfnDomainConfigurationPropsMixin.Builder	tlsConfig(CfnDomainConfigurationPropsMixin.TlsConfigProperty tlsConfig)	An object that specifies the TLS configuration for a domain.
CfnDomainConfigurationPropsMixin.Builder	tlsConfig(IResolvable tlsConfig)	An object that specifies the TLS configuration for a domain.
CfnDomainConfigurationPropsMixin.Builder	validationCertificateArn(String validationCertificateArn)	The certificate used to validate the server certificate and prove domain name ownership.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnDomainConfigurationPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnDomainConfigurationPropsMixin.Builder.

create

@Stability(Stable)
public static CfnDomainConfigurationPropsMixin.Builder create()

Returns:

a new instance of CfnDomainConfigurationPropsMixin.Builder.

applicationProtocol

@Stability(Stable)
public CfnDomainConfigurationPropsMixin.Builder applicationProtocol(String applicationProtocol)

An enumerated string that specifies the application-layer protocol.

Parameters:

applicationProtocol - An enumerated string that specifies the application-layer protocol. This parameter is required.

Returns:

this

See Also:

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

authenticationType

@Stability(Stable)
public CfnDomainConfigurationPropsMixin.Builder authenticationType(String authenticationType)

An enumerated string that specifies the authentication type.

Parameters:

authenticationType - An enumerated string that specifies the authentication type. This parameter is required.

Returns:

this

See Also:

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

authorizerConfig

@Stability(Stable)
public CfnDomainConfigurationPropsMixin.Builder authorizerConfig(IResolvable authorizerConfig)

An object that specifies the authorization service for a domain.

Parameters:

authorizerConfig - An object that specifies the authorization service for a domain. This parameter is required.

Returns:

this

See Also:

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

authorizerConfig

@Stability(Stable)
public CfnDomainConfigurationPropsMixin.Builder authorizerConfig(CfnDomainConfigurationPropsMixin.AuthorizerConfigProperty authorizerConfig)

An object that specifies the authorization service for a domain.

Parameters:

authorizerConfig - An object that specifies the authorization service for a domain. This parameter is required.

Returns:

this

See Also:

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

clientCertificateConfig

@Stability(Stable)
public CfnDomainConfigurationPropsMixin.Builder clientCertificateConfig(IResolvable clientCertificateConfig)

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

Parameters:

clientCertificateConfig - An object that specifies the client certificate configuration for a domain. This parameter is required.

Returns:

this

See Also:

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

clientCertificateConfig

@Stability(Stable)
public CfnDomainConfigurationPropsMixin.Builder clientCertificateConfig(CfnDomainConfigurationPropsMixin.ClientCertificateConfigProperty clientCertificateConfig)

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

Parameters:

clientCertificateConfig - An object that specifies the client certificate configuration for a domain. This parameter is required.

Returns:

this

See Also:

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

domainConfigurationName

@Stability(Stable)
public CfnDomainConfigurationPropsMixin.Builder domainConfigurationName(String domainConfigurationName)

The name of the domain configuration.

This value must be unique to a region.

Parameters:

domainConfigurationName - The name of the domain configuration. This parameter is required.

Returns:

this

See Also:

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

domainConfigurationStatus

@Stability(Stable)
public CfnDomainConfigurationPropsMixin.Builder domainConfigurationStatus(String domainConfigurationStatus)

The status to which the domain configuration should be updated.

Valid values: ENABLED | DISABLED

Parameters:

domainConfigurationStatus - The status to which the domain configuration should be updated. This parameter is required.

Returns:

this

See Also:

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

domainName

@Stability(Stable)
public CfnDomainConfigurationPropsMixin.Builder domainName(String domainName)

The name of the domain.

Parameters:

domainName - The name of the domain. This parameter is required.

Returns:

this

See Also:

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

serverCertificateArns

@Stability(Stable)
public CfnDomainConfigurationPropsMixin.Builder serverCertificateArns(List<String> serverCertificateArns)

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.

Parameters:

serverCertificateArns - The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake. This parameter is required.

Returns:

this

See Also:

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

serverCertificateConfig

@Stability(Stable)
public CfnDomainConfigurationPropsMixin.Builder serverCertificateConfig(IResolvable serverCertificateConfig)

The server certificate configuration.

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

Parameters:

serverCertificateConfig - The server certificate configuration. This parameter is required.

Returns:

this

See Also:

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

serverCertificateConfig

@Stability(Stable)
public CfnDomainConfigurationPropsMixin.Builder serverCertificateConfig(CfnDomainConfigurationPropsMixin.ServerCertificateConfigProperty serverCertificateConfig)

The server certificate configuration.

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

Parameters:

serverCertificateConfig - The server certificate configuration. This parameter is required.

Returns:

this

See Also:

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

serviceType

@Stability(Stable)
public CfnDomainConfigurationPropsMixin.Builder serviceType(String serviceType)

The type of service delivered by the endpoint.

AWS IoT Core currently supports only the DATA service type.

Parameters:

serviceType - The type of service delivered by the endpoint. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnDomainConfigurationPropsMixin.Builder tags(List<? extends CfnTag> 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..."

Parameters:

tags - Metadata which can be used to manage the domain configuration. This parameter is required.

Returns:

this

See Also:

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

tlsConfig

@Stability(Stable)
public CfnDomainConfigurationPropsMixin.Builder tlsConfig(IResolvable tlsConfig)

An object that specifies the TLS configuration for a domain.

Parameters:

tlsConfig - An object that specifies the TLS configuration for a domain. This parameter is required.

Returns:

this

See Also:

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

tlsConfig

@Stability(Stable)
public CfnDomainConfigurationPropsMixin.Builder tlsConfig(CfnDomainConfigurationPropsMixin.TlsConfigProperty tlsConfig)

An object that specifies the TLS configuration for a domain.

Parameters:

tlsConfig - An object that specifies the TLS configuration for a domain. This parameter is required.

Returns:

this

See Also:

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

validationCertificateArn

@Stability(Stable)
public CfnDomainConfigurationPropsMixin.Builder validationCertificateArn(String validationCertificateArn)

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.

Parameters:

validationCertificateArn - The certificate used to validate the server certificate and prove domain name ownership. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnDomainConfigurationPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnDomainConfigurationPropsMixin>

Returns:

a newly built instance of CfnDomainConfigurationPropsMixin.