DomainConfiguration class

Creates and manages an AWS IoT domain configuration.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const iot = new aws.iot.DomainConfiguration("iot", {
    name: "iot-",
    domainName: "iot.example.com",
    serviceType: "DATA",
    serverCertificateArns: [cert.arn],
});
import pulumi
import pulumi_aws as aws

iot = aws.iot.DomainConfiguration("iot",
    name="iot-",
    domain_name="iot.example.com",
    service_type="DATA",
    server_certificate_arns=[cert["arn"]])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var iot = new Aws.Iot.DomainConfiguration("iot", new()
    {
        Name = "iot-",
        DomainName = "iot.example.com",
        ServiceType = "DATA",
        ServerCertificateArns = new[]
        {
            cert.Arn,
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iot"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iot.NewDomainConfiguration(ctx, "iot", &iot.DomainConfigurationArgs{
			Name:        pulumi.String("iot-"),
			DomainName:  pulumi.String("iot.example.com"),
			ServiceType: pulumi.String("DATA"),
			ServerCertificateArns: pulumi.StringArray{
				cert.Arn,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_iot_domainconfiguration" "iot" {
  name                    = "iot-"
  domain_name             = "iot.example.com"
  service_type            = "DATA"
  server_certificate_arns = [cert.arn]
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iot.DomainConfiguration;
import com.pulumi.aws.iot.DomainConfigurationArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var iot = new DomainConfiguration("iot", DomainConfigurationArgs.builder()
            .name("iot-")
            .domainName("iot.example.com")
            .serviceType("DATA")
            .serverCertificateArns(cert.arn())
            .build());

    }
}
resources:
  iot:
    type: aws:iot:DomainConfiguration
    properties:
      name: iot-
      domainName: iot.example.com
      serviceType: DATA
      serverCertificateArns:
        - ${cert.arn}

Import

Using pulumi import, import domain configurations using the name. For example:

$ pulumi import aws:iot/domainConfiguration:DomainConfiguration example example

Constructors

DomainConfiguration(String name, {DomainConfigurationArgs? args, CustomResourceOptions? options})
Creates a new DomainConfiguration. name The Pulumi resource name. args Arguments used to configure this DomainConfiguration. The set of arguments for DomainConfiguration. options Resource options controlling this resource's behavior.
DomainConfiguration.reference(String urn)
Creates a typed reference to an existing DomainConfiguration resource.

Properties

applicationProtocol ↔ Output<String>
An enumerated string that specifies the application-layer protocol. Valid values are SECURE_MQTT, MQTT_WSS, HTTPS or DEFAULT.
latefinal
arn ↔ Output<String>
The ARN of the domain configuration.
latefinal
authenticationType ↔ Output<String>
An enumerated string that specifies the authentication type. Valid values are CUSTOM_AUTH_X509, CUSTOM_AUTH, AWS_X509, AWS_SIGV4 or DEFAULT.
latefinal
authorizerConfig ↔ Output<DomainConfigurationAuthorizerConfig?>
An object that specifies the authorization service for a domain. See the authorizerConfig Block below for details.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
domainName ↔ Output<String>
Fully-qualified domain name.
latefinal
domainType ↔ Output<String>
The type of the domain.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
The name of the domain configuration. This value must be unique to a region.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serverCertificateArns ↔ Output<List<String>?>
The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains. When using a custom domainName, the cert must include it.
latefinal
serviceType ↔ Output<String?>
The type of service delivered by the endpoint. Note: Amazon Web Services IoT Core currently supports only the DATA service type.
latefinal
status ↔ Output<String?>
The status to which the domain configuration should be set. Valid values are ENABLED and DISABLED.
latefinal
tags ↔ Output<Map<String, String>?>
Map of tags to assign to this resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
tlsConfig ↔ Output<DomainConfigurationTlsConfig>
An object that specifies the TLS configuration for a domain. See the tlsConfig Block below for details.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
validationCertificateArn ↔ Output<String?>
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 Amazon Web Services-managed domains.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {DomainConfigurationState? state, CustomResourceOptions? options}) → DomainConfiguration
Gets an existing DomainConfiguration resource's state with the given name and id.