AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoT::Types::CreateDomainConfigurationRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateDomainConfigurationRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  domain_configuration_name: "DomainConfigurationName", # required
  domain_name: "DomainName",
  server_certificate_arns: ["AcmCertificateArn"],
  validation_certificate_arn: "AcmCertificateArn",
  authorizer_config: {
    default_authorizer_name: "AuthorizerName",
    allow_authorizer_override: false,
  },
  service_type: "DATA", # accepts DATA, CREDENTIAL_PROVIDER, JOBS
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#authorizer_configTypes::AuthorizerConfig

An object that specifies the authorization service for a domain.

Returns:

#domain_configuration_nameString

The name of the domain configuration. This value must be unique to a region.

Returns:

  • (String)

    The name of the domain configuration.

#domain_nameString

The name of the domain.

Returns:

  • (String)

    The name of the domain.

#server_certificate_arnsArray<String>

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.

Returns:

  • (Array<String>)

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

#service_typeString

The type of service delivered by the endpoint.

AWS IoT Core currently supports only the DATA service type.

Possible values:

  • DATA
  • CREDENTIAL_PROVIDER
  • JOBS

Returns:

  • (String)

    The type of service delivered by the endpoint.

#tagsArray<Types::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...\"

Returns:

  • (Array<Types::Tag>)

    Metadata which can be used to manage the domain configuration.

#validation_certificate_arnString

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 AWS-managed domains.

Returns:

  • (String)

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