Package 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, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)",
           date="2024-03-01T20:58:25.584Z")
@Stability(Stable)
public class CfnDomainConfiguration
extends CfnResource
implements IInspectable, ITaggable

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"))
         .serverCertificateConfig(ServerCertificateConfigProperty.builder()
                 .enableOcspCheck(false)
                 .build())
         .serviceType("serviceType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tlsConfig(TlsConfigProperty.builder()
                 .securityPolicy("securityPolicy")
                 .build())
         .validationCertificateArn("validationCertificateArn")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDomainConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDomainConfiguration(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDomainConfiguration(software.constructs.Construct scope, String id)
	CfnDomainConfiguration(software.constructs.Construct scope, String id, CfnDomainConfigurationProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The Amazon Resource Name (ARN) of the domain configuration.
String	getAttrDomainType()	The type of service delivered by the domain.
IResolvable	getAttrServerCertificates()
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.
Object	getServerCertificateConfig()	The server certificate configuration.
String	getServiceType()	The type of service delivered by the endpoint.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	Metadata which can be used to manage the domain configuration.
Object	getTlsConfig()	An object that specifies the TLS configuration for a domain.
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(IResolvable value)	An object that specifies the authorization service for a domain.
void	setAuthorizerConfig(CfnDomainConfiguration.AuthorizerConfigProperty 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	setServerCertificateConfig(IResolvable value)	The server certificate configuration.
void	setServerCertificateConfig(CfnDomainConfiguration.ServerCertificateConfigProperty value)	The server certificate configuration.
void	setServiceType(String value)	The type of service delivered by the endpoint.
void	setTagsRaw(List<CfnTag> value)	Metadata which can be used to manage the domain configuration.
void	setTlsConfig(IResolvable value)	An object that specifies the TLS configuration for a domain.
void	setTlsConfig(CfnDomainConfiguration.TlsConfigProperty value)	An object that specifies the TLS configuration for a domain.
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, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDomainConfiguration

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

CfnDomainConfiguration

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

CfnDomainConfiguration

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

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnDomainConfiguration

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

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

inspect

@Stability(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(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(Stable)
@NotNull
public String getAttrArn()

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

getAttrDomainType

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

The type of service delivered by the domain.

getAttrServerCertificates

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getAuthorizerConfig

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

An object that specifies the authorization service for a domain.

setAuthorizerConfig

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

An object that specifies the authorization service for a domain.

setAuthorizerConfig

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

An object that specifies the authorization service for a domain.

getDomainConfigurationName

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

The name of the domain configuration.

setDomainConfigurationName

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

The name of the domain configuration.

getDomainConfigurationStatus

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

The status to which the domain configuration should be updated.

setDomainConfigurationStatus

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

The status to which the domain configuration should be updated.

getDomainName

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

The name of the domain.

setDomainName

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

The name of the domain.

getServerCertificateArns

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

The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.

setServerCertificateArns

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

The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.

getServerCertificateConfig

@Stability(Stable)
@Nullable
public Object getServerCertificateConfig()

The server certificate configuration.

setServerCertificateConfig

@Stability(Stable)
public void setServerCertificateConfig(@Nullable
 IResolvable value)

The server certificate configuration.

setServerCertificateConfig

@Stability(Stable)
public void setServerCertificateConfig(@Nullable
 CfnDomainConfiguration.ServerCertificateConfigProperty value)

The server certificate configuration.

getServiceType

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

The type of service delivered by the endpoint.

setServiceType

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

The type of service delivered by the endpoint.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

Metadata which can be used to manage the domain configuration.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

Metadata which can be used to manage the domain configuration.

getTlsConfig

@Stability(Stable)
@Nullable
public Object getTlsConfig()

An object that specifies the TLS configuration for a domain.

setTlsConfig

@Stability(Stable)
public void setTlsConfig(@Nullable
 IResolvable value)

An object that specifies the TLS configuration for a domain.

setTlsConfig

@Stability(Stable)
public void setTlsConfig(@Nullable
 CfnDomainConfiguration.TlsConfigProperty value)

An object that specifies the TLS configuration for a domain.

getValidationCertificateArn

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

The certificate used to validate the server certificate and prove domain name ownership.

setValidationCertificateArn

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

The certificate used to validate the server certificate and prove domain name ownership.