@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
80 lines (79 loc) • 3.38 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Create and manage a Domain Configuration
*/
export declare function getDomainConfiguration(args: GetDomainConfigurationArgs, opts?: pulumi.InvokeOptions): Promise<GetDomainConfigurationResult>;
export interface GetDomainConfigurationArgs {
/**
* The name of the domain configuration. This value must be unique to a region.
*/
domainConfigurationName: string;
}
export interface GetDomainConfigurationResult {
/**
* An enumerated string that specifies the application-layer protocol.
*/
readonly applicationProtocol?: enums.iot.DomainConfigurationApplicationProtocol;
/**
* The Amazon Resource Name (ARN) of the domain configuration.
*/
readonly arn?: string;
/**
* An enumerated string that specifies the authentication type.
*/
readonly authenticationType?: enums.iot.DomainConfigurationAuthenticationType;
/**
* An object that specifies the authorization service for a domain.
*/
readonly authorizerConfig?: outputs.iot.DomainConfigurationAuthorizerConfig;
/**
* An object that specifies the client certificate configuration for a domain.
*/
readonly clientCertificateConfig?: outputs.iot.DomainConfigurationClientCertificateConfig;
/**
* The status to which the domain configuration should be updated.
*
* Valid values: `ENABLED` | `DISABLED`
*/
readonly domainConfigurationStatus?: enums.iot.DomainConfigurationStatus;
/**
* The type of service delivered by the domain.
*/
readonly domainType?: enums.iot.DomainConfigurationDomainType;
/**
* The server certificate configuration.
*
* For more information, see [Configurable endpoints](https://docs.aws.amazon.com//iot/latest/developerguide/iot-custom-endpoints-configurable.html) from the AWS IoT Core Developer Guide.
*/
readonly serverCertificateConfig?: outputs.iot.DomainConfigurationServerCertificateConfig;
/**
* 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.
*/
readonly serverCertificates?: outputs.iot.DomainConfigurationServerCertificateSummary[];
/**
* 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..."
*/
readonly tags?: outputs.Tag[];
/**
* An object that specifies the TLS configuration for a domain.
*/
readonly tlsConfig?: outputs.iot.DomainConfigurationTlsConfig;
}
/**
* Create and manage a Domain Configuration
*/
export declare function getDomainConfigurationOutput(args: GetDomainConfigurationOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDomainConfigurationResult>;
export interface GetDomainConfigurationOutputArgs {
/**
* The name of the domain configuration. This value must be unique to a region.
*/
domainConfigurationName: pulumi.Input<string>;
}