Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iot
  5. getDomainConfiguration

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.iot.getDomainConfiguration

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Create and manage a Domain Configuration

Using getDomainConfiguration

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDomainConfiguration(args: GetDomainConfigurationArgs, opts?: InvokeOptions): Promise<GetDomainConfigurationResult>
function getDomainConfigurationOutput(args: GetDomainConfigurationOutputArgs, opts?: InvokeOptions): Output<GetDomainConfigurationResult>
Copy
def get_domain_configuration(domain_configuration_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetDomainConfigurationResult
def get_domain_configuration_output(domain_configuration_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetDomainConfigurationResult]
Copy
func LookupDomainConfiguration(ctx *Context, args *LookupDomainConfigurationArgs, opts ...InvokeOption) (*LookupDomainConfigurationResult, error)
func LookupDomainConfigurationOutput(ctx *Context, args *LookupDomainConfigurationOutputArgs, opts ...InvokeOption) LookupDomainConfigurationResultOutput
Copy

> Note: This function is named LookupDomainConfiguration in the Go SDK.

public static class GetDomainConfiguration 
{
    public static Task<GetDomainConfigurationResult> InvokeAsync(GetDomainConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetDomainConfigurationResult> Invoke(GetDomainConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDomainConfigurationResult> getDomainConfiguration(GetDomainConfigurationArgs args, InvokeOptions options)
public static Output<GetDomainConfigurationResult> getDomainConfiguration(GetDomainConfigurationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:iot:getDomainConfiguration
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DomainConfigurationName This property is required. string
The name of the domain configuration. This value must be unique to a region.
DomainConfigurationName This property is required. string
The name of the domain configuration. This value must be unique to a region.
domainConfigurationName This property is required. String
The name of the domain configuration. This value must be unique to a region.
domainConfigurationName This property is required. string
The name of the domain configuration. This value must be unique to a region.
domain_configuration_name This property is required. str
The name of the domain configuration. This value must be unique to a region.
domainConfigurationName This property is required. String
The name of the domain configuration. This value must be unique to a region.

getDomainConfiguration Result

The following output properties are available:

ApplicationProtocol Pulumi.AwsNative.IoT.DomainConfigurationApplicationProtocol
An enumerated string that specifies the application-layer protocol.
Arn string
The Amazon Resource Name (ARN) of the domain configuration.
AuthenticationType Pulumi.AwsNative.IoT.DomainConfigurationAuthenticationType
An enumerated string that specifies the authentication type.
AuthorizerConfig Pulumi.AwsNative.IoT.Outputs.DomainConfigurationAuthorizerConfig
An object that specifies the authorization service for a domain.
ClientCertificateConfig Pulumi.AwsNative.IoT.Outputs.DomainConfigurationClientCertificateConfig
An object that specifies the client certificate configuration for a domain.
DomainConfigurationStatus Pulumi.AwsNative.IoT.DomainConfigurationStatus

The status to which the domain configuration should be updated.

Valid values: ENABLED | DISABLED

DomainType Pulumi.AwsNative.IoT.DomainConfigurationDomainType
The type of service delivered by the domain.
ServerCertificateConfig Pulumi.AwsNative.IoT.Outputs.DomainConfigurationServerCertificateConfig

The server certificate configuration.

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

ServerCertificates List<Pulumi.AwsNative.IoT.Outputs.DomainConfigurationServerCertificateSummary>
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.
Tags List<Pulumi.AwsNative.Outputs.Tag>

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

TlsConfig Pulumi.AwsNative.IoT.Outputs.DomainConfigurationTlsConfig
An object that specifies the TLS configuration for a domain.
ApplicationProtocol DomainConfigurationApplicationProtocol
An enumerated string that specifies the application-layer protocol.
Arn string
The Amazon Resource Name (ARN) of the domain configuration.
AuthenticationType DomainConfigurationAuthenticationType
An enumerated string that specifies the authentication type.
AuthorizerConfig DomainConfigurationAuthorizerConfig
An object that specifies the authorization service for a domain.
ClientCertificateConfig DomainConfigurationClientCertificateConfig
An object that specifies the client certificate configuration for a domain.
DomainConfigurationStatus DomainConfigurationStatus

The status to which the domain configuration should be updated.

Valid values: ENABLED | DISABLED

DomainType DomainConfigurationDomainType
The type of service delivered by the domain.
ServerCertificateConfig DomainConfigurationServerCertificateConfig

The server certificate configuration.

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

ServerCertificates []DomainConfigurationServerCertificateSummary
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.
Tags Tag

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

TlsConfig DomainConfigurationTlsConfig
An object that specifies the TLS configuration for a domain.
applicationProtocol DomainConfigurationApplicationProtocol
An enumerated string that specifies the application-layer protocol.
arn String
The Amazon Resource Name (ARN) of the domain configuration.
authenticationType DomainConfigurationAuthenticationType
An enumerated string that specifies the authentication type.
authorizerConfig DomainConfigurationAuthorizerConfig
An object that specifies the authorization service for a domain.
clientCertificateConfig DomainConfigurationClientCertificateConfig
An object that specifies the client certificate configuration for a domain.
domainConfigurationStatus DomainConfigurationStatus

The status to which the domain configuration should be updated.

Valid values: ENABLED | DISABLED

domainType DomainConfigurationDomainType
The type of service delivered by the domain.
serverCertificateConfig DomainConfigurationServerCertificateConfig

The server certificate configuration.

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

serverCertificates List<DomainConfigurationServerCertificateSummary>
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.
tags List<Tag>

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

tlsConfig DomainConfigurationTlsConfig
An object that specifies the TLS configuration for a domain.
applicationProtocol DomainConfigurationApplicationProtocol
An enumerated string that specifies the application-layer protocol.
arn string
The Amazon Resource Name (ARN) of the domain configuration.
authenticationType DomainConfigurationAuthenticationType
An enumerated string that specifies the authentication type.
authorizerConfig DomainConfigurationAuthorizerConfig
An object that specifies the authorization service for a domain.
clientCertificateConfig DomainConfigurationClientCertificateConfig
An object that specifies the client certificate configuration for a domain.
domainConfigurationStatus DomainConfigurationStatus

The status to which the domain configuration should be updated.

Valid values: ENABLED | DISABLED

domainType DomainConfigurationDomainType
The type of service delivered by the domain.
serverCertificateConfig DomainConfigurationServerCertificateConfig

The server certificate configuration.

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

serverCertificates DomainConfigurationServerCertificateSummary[]
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.
tags Tag[]

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

tlsConfig DomainConfigurationTlsConfig
An object that specifies the TLS configuration for a domain.
application_protocol DomainConfigurationApplicationProtocol
An enumerated string that specifies the application-layer protocol.
arn str
The Amazon Resource Name (ARN) of the domain configuration.
authentication_type DomainConfigurationAuthenticationType
An enumerated string that specifies the authentication type.
authorizer_config DomainConfigurationAuthorizerConfig
An object that specifies the authorization service for a domain.
client_certificate_config DomainConfigurationClientCertificateConfig
An object that specifies the client certificate configuration for a domain.
domain_configuration_status DomainConfigurationStatus

The status to which the domain configuration should be updated.

Valid values: ENABLED | DISABLED

domain_type DomainConfigurationDomainType
The type of service delivered by the domain.
server_certificate_config DomainConfigurationServerCertificateConfig

The server certificate configuration.

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

server_certificates Sequence[DomainConfigurationServerCertificateSummary]
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.
tags Sequence[root_Tag]

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

tls_config DomainConfigurationTlsConfig
An object that specifies the TLS configuration for a domain.
applicationProtocol "SECURE_MQTT" | "MQTT_WSS" | "HTTPS" | "DEFAULT"
An enumerated string that specifies the application-layer protocol.
arn String
The Amazon Resource Name (ARN) of the domain configuration.
authenticationType "AWS_X509" | "CUSTOM_AUTH" | "AWS_SIGV4" | "CUSTOM_AUTH_X509" | "DEFAULT"
An enumerated string that specifies the authentication type.
authorizerConfig Property Map
An object that specifies the authorization service for a domain.
clientCertificateConfig Property Map
An object that specifies the client certificate configuration for a domain.
domainConfigurationStatus "ENABLED" | "DISABLED"

The status to which the domain configuration should be updated.

Valid values: ENABLED | DISABLED

domainType "ENDPOINT" | "AWS_MANAGED" | "CUSTOMER_MANAGED"
The type of service delivered by the domain.
serverCertificateConfig Property Map

The server certificate configuration.

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

serverCertificates List<Property Map>
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.
tags List<Property Map>

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

tlsConfig Property Map
An object that specifies the TLS configuration for a domain.

Supporting Types

DomainConfigurationApplicationProtocol

DomainConfigurationAuthenticationType

DomainConfigurationAuthorizerConfig

AllowAuthorizerOverride bool
A Boolean that specifies whether the domain configuration's authorization service can be overridden.
DefaultAuthorizerName string
The name of the authorization service for a domain configuration.
AllowAuthorizerOverride bool
A Boolean that specifies whether the domain configuration's authorization service can be overridden.
DefaultAuthorizerName string
The name of the authorization service for a domain configuration.
allowAuthorizerOverride Boolean
A Boolean that specifies whether the domain configuration's authorization service can be overridden.
defaultAuthorizerName String
The name of the authorization service for a domain configuration.
allowAuthorizerOverride boolean
A Boolean that specifies whether the domain configuration's authorization service can be overridden.
defaultAuthorizerName string
The name of the authorization service for a domain configuration.
allow_authorizer_override bool
A Boolean that specifies whether the domain configuration's authorization service can be overridden.
default_authorizer_name str
The name of the authorization service for a domain configuration.
allowAuthorizerOverride Boolean
A Boolean that specifies whether the domain configuration's authorization service can be overridden.
defaultAuthorizerName String
The name of the authorization service for a domain configuration.

DomainConfigurationClientCertificateConfig

ClientCertificateCallbackArn string
The ARN of the Lambda function that IoT invokes after mutual TLS authentication during the connection.
ClientCertificateCallbackArn string
The ARN of the Lambda function that IoT invokes after mutual TLS authentication during the connection.
clientCertificateCallbackArn String
The ARN of the Lambda function that IoT invokes after mutual TLS authentication during the connection.
clientCertificateCallbackArn string
The ARN of the Lambda function that IoT invokes after mutual TLS authentication during the connection.
client_certificate_callback_arn str
The ARN of the Lambda function that IoT invokes after mutual TLS authentication during the connection.
clientCertificateCallbackArn String
The ARN of the Lambda function that IoT invokes after mutual TLS authentication during the connection.

DomainConfigurationDomainType

DomainConfigurationServerCertificateConfig

EnableOcspCheck bool
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.
OcspAuthorizedResponderArn string
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.
OcspLambdaArn string
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.
EnableOcspCheck bool
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.
OcspAuthorizedResponderArn string
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.
OcspLambdaArn string
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.
enableOcspCheck Boolean
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.
ocspAuthorizedResponderArn String
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.
ocspLambdaArn String
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.
enableOcspCheck boolean
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.
ocspAuthorizedResponderArn string
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.
ocspLambdaArn string
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.
enable_ocsp_check bool
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 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 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.
enableOcspCheck Boolean
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.
ocspAuthorizedResponderArn String
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.
ocspLambdaArn String
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.

DomainConfigurationServerCertificateSummary

ServerCertificateArn string
The ARN of the server certificate.
ServerCertificateStatus Pulumi.AwsNative.IoT.DomainConfigurationServerCertificateSummaryServerCertificateStatus
The status of the server certificate.
ServerCertificateStatusDetail string
Details that explain the status of the server certificate.
ServerCertificateArn string
The ARN of the server certificate.
ServerCertificateStatus DomainConfigurationServerCertificateSummaryServerCertificateStatus
The status of the server certificate.
ServerCertificateStatusDetail string
Details that explain the status of the server certificate.
serverCertificateArn String
The ARN of the server certificate.
serverCertificateStatus DomainConfigurationServerCertificateSummaryServerCertificateStatus
The status of the server certificate.
serverCertificateStatusDetail String
Details that explain the status of the server certificate.
serverCertificateArn string
The ARN of the server certificate.
serverCertificateStatus DomainConfigurationServerCertificateSummaryServerCertificateStatus
The status of the server certificate.
serverCertificateStatusDetail string
Details that explain the status of the server certificate.
server_certificate_arn str
The ARN of the server certificate.
server_certificate_status DomainConfigurationServerCertificateSummaryServerCertificateStatus
The status of the server certificate.
server_certificate_status_detail str
Details that explain the status of the server certificate.
serverCertificateArn String
The ARN of the server certificate.
serverCertificateStatus "INVALID" | "VALID"
The status of the server certificate.
serverCertificateStatusDetail String
Details that explain the status of the server certificate.

DomainConfigurationServerCertificateSummaryServerCertificateStatus

DomainConfigurationStatus

DomainConfigurationTlsConfig

SecurityPolicy string
The security policy for a domain configuration. For more information, see Security policies in the AWS IoT Core developer guide .
SecurityPolicy string
The security policy for a domain configuration. For more information, see Security policies in the AWS IoT Core developer guide .
securityPolicy String
The security policy for a domain configuration. For more information, see Security policies in the AWS IoT Core developer guide .
securityPolicy string
The security policy for a domain configuration. For more information, see Security policies in the AWS IoT Core developer guide .
security_policy str
The security policy for a domain configuration. For more information, see Security policies in the AWS IoT Core developer guide .
securityPolicy String
The security policy for a domain configuration. For more information, see Security policies in the AWS IoT Core developer guide .

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native