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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass CreateDomainConfigurationRequest data as a 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",
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authorizer_configTypes::AuthorizerConfig

An object that specifies the authorization service for a domain.



3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3245

class CreateDomainConfigurationRequest < Struct.new(
  :domain_configuration_name,
  :domain_name,
  :server_certificate_arns,
  :validation_certificate_arn,
  :authorizer_config,
  :service_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#domain_configuration_nameString

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

Returns:

  • (String)


3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3245

class CreateDomainConfigurationRequest < Struct.new(
  :domain_configuration_name,
  :domain_name,
  :server_certificate_arns,
  :validation_certificate_arn,
  :authorizer_config,
  :service_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#domain_nameString

The name of the domain.

Returns:

  • (String)


3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3245

class CreateDomainConfigurationRequest < Struct.new(
  :domain_configuration_name,
  :domain_name,
  :server_certificate_arns,
  :validation_certificate_arn,
  :authorizer_config,
  :service_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (Array<String>)


3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3245

class CreateDomainConfigurationRequest < Struct.new(
  :domain_configuration_name,
  :domain_name,
  :server_certificate_arns,
  :validation_certificate_arn,
  :authorizer_config,
  :service_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#service_typeString

The type of service delivered by the endpoint.

Amazon Web Services IoT Core currently supports only the DATA service type.

Returns:

  • (String)


3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3245

class CreateDomainConfigurationRequest < Struct.new(
  :domain_configuration_name,
  :domain_name,
  :server_certificate_arns,
  :validation_certificate_arn,
  :authorizer_config,
  :service_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#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:



3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3245

class CreateDomainConfigurationRequest < Struct.new(
  :domain_configuration_name,
  :domain_name,
  :server_certificate_arns,
  :validation_certificate_arn,
  :authorizer_config,
  :service_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#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 Amazon Web Services-managed domains.

Returns:

  • (String)


3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3245

class CreateDomainConfigurationRequest < Struct.new(
  :domain_configuration_name,
  :domain_name,
  :server_certificate_arns,
  :validation_certificate_arn,
  :authorizer_config,
  :service_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end