software.amazon.awscdk.services.iot

Class CfnDomainConfiguration

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iot.CfnDomainConfiguration

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.855Z")
 @Stability(value=Stable)
public class CfnDomainConfiguration
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoT::DomainConfiguration`.

Specifies a domain configuration.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 CfnDomainConfiguration cfnDomainConfiguration = CfnDomainConfiguration.Builder.create(this, "MyCfnDomainConfiguration")
         .authorizerConfig(AuthorizerConfigProperty.builder()
                 .allowAuthorizerOverride(false)
                 .defaultAuthorizerName("defaultAuthorizerName")
                 .build())
         .domainConfigurationName("domainConfigurationName")
         .domainConfigurationStatus("domainConfigurationStatus")
         .domainName("domainName")
         .serverCertificateArns(List.of("serverCertificateArns"))
         .serviceType("serviceType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .validationCertificateArn("validationCertificateArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnDomainConfiguration.AuthorizerConfigProperty An object that specifies the authorization service for a domain.
static class	CfnDomainConfiguration.Builder A fluent builder for CfnDomainConfiguration.
static interface	CfnDomainConfiguration.ServerCertificateSummaryProperty An object that contains information about a server certificate.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDomainConfiguration(software.constructs.Construct scope, String id) Create a new `AWS::IoT::DomainConfiguration`.
	CfnDomainConfiguration(software.constructs.Construct scope, String id, CfnDomainConfigurationProps props) Create a new `AWS::IoT::DomainConfiguration`.
protected	CfnDomainConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDomainConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the domain configuration.
String	getAttrDomainType() The type of service delivered by the domain.
IResolvable	getAttrServerCertificates() The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.
Object	getAuthorizerConfig() An object that specifies the authorization service for a domain.
protected Map<String,Object>	getCfnProperties()
String	getDomainConfigurationName() The name of the domain configuration.
String	getDomainConfigurationStatus() The status to which the domain configuration should be updated.
String	getDomainName() The name of the domain.
List<String>	getServerCertificateArns() The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.
String	getServiceType() The type of service delivered by the endpoint.
TagManager	getTags() Metadata which can be used to manage the domain configuration.
String	getValidationCertificateArn() The certificate used to validate the server certificate and prove domain name ownership.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAuthorizerConfig(CfnDomainConfiguration.AuthorizerConfigProperty value) An object that specifies the authorization service for a domain.
void	setAuthorizerConfig(IResolvable value) An object that specifies the authorization service for a domain.
void	setDomainConfigurationName(String value) The name of the domain configuration.
void	setDomainConfigurationStatus(String value) The status to which the domain configuration should be updated.
void	setDomainName(String value) The name of the domain.
void	setServerCertificateArns(List<String> value) The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.
void	setServiceType(String value) The type of service delivered by the endpoint.
void	setValidationCertificateArn(String value) The certificate used to validate the server certificate and prove domain name ownership.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDomainConfiguration

protected CfnDomainConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

CfnDomainConfiguration

protected CfnDomainConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDomainConfiguration

@Stability(value=Stable)
public CfnDomainConfiguration(@NotNull
                                                       software.constructs.Construct scope,
                                                       @NotNull
                                                       String id,
                                                       @Nullable
                                                       CfnDomainConfigurationProps props)

Create a new `AWS::IoT::DomainConfiguration`.

Parameters:

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

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

props - - resource properties.

CfnDomainConfiguration

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

Create a new `AWS::IoT::DomainConfiguration`.

Parameters:

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

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

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the domain configuration.

getAttrDomainType

@Stability(value=Stable)
 @NotNull
public String getAttrDomainType()

The type of service delivered by the domain.

getAttrServerCertificates

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrServerCertificates()

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.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getAuthorizerConfig

@Stability(value=Stable)
 @Nullable
public Object getAuthorizerConfig()

An object that specifies the authorization service for a domain.

setAuthorizerConfig

@Stability(value=Stable)
public void setAuthorizerConfig(@Nullable
                                                         CfnDomainConfiguration.AuthorizerConfigProperty value)

An object that specifies the authorization service for a domain.

setAuthorizerConfig

@Stability(value=Stable)
public void setAuthorizerConfig(@Nullable
                                                         IResolvable value)

An object that specifies the authorization service for a domain.

getDomainConfigurationName

@Stability(value=Stable)
 @Nullable
public String getDomainConfigurationName()

The name of the domain configuration.

This value must be unique to a region.

setDomainConfigurationName

@Stability(value=Stable)
public void setDomainConfigurationName(@Nullable
                                                                String value)

The name of the domain configuration.

This value must be unique to a region.

getDomainConfigurationStatus

@Stability(value=Stable)
 @Nullable
public String getDomainConfigurationStatus()

The status to which the domain configuration should be updated.

Valid values: ENABLED | DISABLED

setDomainConfigurationStatus

@Stability(value=Stable)
public void setDomainConfigurationStatus(@Nullable
                                                                  String value)

The status to which the domain configuration should be updated.

Valid values: ENABLED | DISABLED

getDomainName

@Stability(value=Stable)
 @Nullable
public String getDomainName()

The name of the domain.

setDomainName

@Stability(value=Stable)
public void setDomainName(@Nullable
                                                   String value)

The name of the domain.

getServerCertificateArns

@Stability(value=Stable)
 @Nullable
public List<String> getServerCertificateArns()

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.

setServerCertificateArns

@Stability(value=Stable)
public void setServerCertificateArns(@Nullable
                                                              List<String> value)

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.

getServiceType

@Stability(value=Stable)
 @Nullable
public String getServiceType()

The type of service delivered by the endpoint.

AWS IoT Core currently supports only the DATA service type.

setServiceType

@Stability(value=Stable)
public void setServiceType(@Nullable
                                                    String value)

The type of service delivered by the endpoint.

AWS IoT Core currently supports only the DATA service type.

getValidationCertificateArn

@Stability(value=Stable)
 @Nullable
public String getValidationCertificateArn()

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.

setValidationCertificateArn

@Stability(value=Stable)
public void setValidationCertificateArn(@Nullable
                                                                 String value)

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.