software.amazon.awscdk.services.iot

Class CfnDomainConfiguration.Builder

java.lang.Object

software.amazon.awscdk.services.iot.CfnDomainConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDomainConfiguration>

Enclosing class:

CfnDomainConfiguration

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

A fluent builder for CfnDomainConfiguration.

Method Summary

Modifier and Type	Method and Description
CfnDomainConfiguration.Builder	authorizerConfig(CfnDomainConfiguration.AuthorizerConfigProperty authorizerConfig) An object that specifies the authorization service for a domain.
CfnDomainConfiguration.Builder	authorizerConfig(IResolvable authorizerConfig) An object that specifies the authorization service for a domain.
CfnDomainConfiguration	build()
static CfnDomainConfiguration.Builder	create(software.constructs.Construct scope, String id)
CfnDomainConfiguration.Builder	domainConfigurationName(String domainConfigurationName) The name of the domain configuration.
CfnDomainConfiguration.Builder	domainConfigurationStatus(String domainConfigurationStatus) The status to which the domain configuration should be updated.
CfnDomainConfiguration.Builder	domainName(String domainName) The name of the domain.
CfnDomainConfiguration.Builder	serverCertificateArns(List<String> serverCertificateArns) The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.
CfnDomainConfiguration.Builder	serviceType(String serviceType) The type of service delivered by the endpoint.
CfnDomainConfiguration.Builder	tags(List<? extends CfnTag> tags) Metadata which can be used to manage the domain configuration.
CfnDomainConfiguration.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 Detail

create

@Stability(value=Stable)
public static CfnDomainConfiguration.Builder create(software.constructs.Construct scope,
                                                                             String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnDomainConfiguration.AuthorizerConfigProperty.Builder.

authorizerConfig

@Stability(value=Stable)
public CfnDomainConfiguration.Builder authorizerConfig(CfnDomainConfiguration.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

authorizerConfig

@Stability(value=Stable)
public CfnDomainConfiguration.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

domainConfigurationName

@Stability(value=Stable)
public CfnDomainConfiguration.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

domainConfigurationStatus

@Stability(value=Stable)
public CfnDomainConfiguration.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

domainName

@Stability(value=Stable)
public CfnDomainConfiguration.Builder domainName(String domainName)

The name of the domain.

Parameters:

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

Returns:

this

serverCertificateArns

@Stability(value=Stable)
public CfnDomainConfiguration.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

serviceType

@Stability(value=Stable)
public CfnDomainConfiguration.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

tags

@Stability(value=Stable)
public CfnDomainConfiguration.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

validationCertificateArn

@Stability(value=Stable)
public CfnDomainConfiguration.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

build

@Stability(value=Stable)
public CfnDomainConfiguration build()

Specified by:

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