1. Packages
  2. AWS Native
  3. API Docs
  4. iot
  5. getDomainConfiguration

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.iot.getDomainConfiguration

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    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>
    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]
    func LookupDomainConfiguration(ctx *Context, args *LookupDomainConfigurationArgs, opts ...InvokeOption) (*LookupDomainConfigurationResult, error)
    func LookupDomainConfigurationOutput(ctx *Context, args *LookupDomainConfigurationOutputArgs, opts ...InvokeOption) LookupDomainConfigurationResultOutput

    > 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)
    }
    public static CompletableFuture<GetDomainConfigurationResult> getDomainConfiguration(GetDomainConfigurationArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:iot:getDomainConfiguration
      arguments:
        # arguments dictionary

    The following arguments are supported:

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

    getDomainConfiguration Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the domain configuration.
    AuthorizerConfig Pulumi.AwsNative.IoT.Outputs.DomainConfigurationAuthorizerConfig
    An object that specifies the authorization service 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.
    Arn string
    The Amazon Resource Name (ARN) of the domain configuration.
    AuthorizerConfig DomainConfigurationAuthorizerConfig
    An object that specifies the authorization service 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.
    arn String
    The Amazon Resource Name (ARN) of the domain configuration.
    authorizerConfig DomainConfigurationAuthorizerConfig
    An object that specifies the authorization service 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.
    arn string
    The Amazon Resource Name (ARN) of the domain configuration.
    authorizerConfig DomainConfigurationAuthorizerConfig
    An object that specifies the authorization service 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.
    arn str
    The Amazon Resource Name (ARN) of the domain configuration.
    authorizer_config DomainConfigurationAuthorizerConfig
    An object that specifies the authorization service 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.
    arn String
    The Amazon Resource Name (ARN) of the domain configuration.
    authorizerConfig Property Map
    An object that specifies the authorization service 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

    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.

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

    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 string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi