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

Inherits:

Struct

Object
Struct
Aws::IoT::Types::CreateDomainConfigurationRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-iot/types.rb

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#application_protocol ⇒ String

An enumerated string that speciﬁes the application-layer protocol.
#authentication_type ⇒ String

An enumerated string that speciﬁes the authentication type.
#authorizer_config ⇒ Types::AuthorizerConfig

An object that specifies the authorization service for a domain.
#client_certificate_config ⇒ Types::ClientCertificateConfig

An object that speciﬁes the client certificate conﬁguration for a domain.
#domain_configuration_name ⇒ String

The name of the domain configuration.
#domain_name ⇒ String

The name of the domain.
#server_certificate_arns ⇒ Array<String>

The ARNs of the certificates that IoT passes to the device during the TLS handshake.
#server_certificate_config ⇒ Types::ServerCertificateConfig

The server certificate configuration.
#service_type ⇒ String

The type of service delivered by the endpoint.
#tags ⇒ Array<Types::Tag>

Metadata which can be used to manage the domain configuration.
#tls_config ⇒ Types::TlsConfig

An object that specifies the TLS configuration for a domain.
#validation_certificate_arn ⇒ String

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

Instance Attribute Details

#application_protocol ⇒ `String`

An enumerated string that speciﬁes the application-layer protocol.

‘SECURE_MQTT` - MQTT over TLS.

^ ^

‘MQTT_WSS` - MQTT over WebSocket.

^ ^

‘HTTPS` - HTTP over TLS.

^ ^

‘DEFAULT` - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see [Device communication protocols].

[1]: docs.aws.amazon.com/iot/latest/developerguide/protocols.html

Returns:

(String)

# File 'lib/aws-sdk-iot/types.rb', line 3088

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

#authentication_type ⇒ `String`

An enumerated string that speciﬁes the authentication type.

‘CUSTOM_AUTH_X509` - Use custom authentication and authorization with additional details from the X.509 client certificate.

^ ^

‘CUSTOM_AUTH` - Use custom authentication and authorization. For more information, see [Custom authentication and authorization].

^ ^

‘AWS_X509` - Use X.509 client certificates without custom authentication and authorization. For more information, see [X.509 client certificates].

^ ^

‘AWS_SIGV4` - Use Amazon Web Services Signature Version 4. For more information, see [IAM users, groups, and roles].

^ ^

‘DEFAULT` - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see [Device communication protocols].

[1]: docs.aws.amazon.com/iot/latest/developerguide/custom-authentication.html [2]: docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html [3]: docs.aws.amazon.com/iot/latest/developerguide/protocols.html

Returns:

(String)

# File 'lib/aws-sdk-iot/types.rb', line 3088

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

#authorizer_config ⇒ `Types::AuthorizerConfig`

An object that specifies the authorization service for a domain.

Returns:

(Types::AuthorizerConfig)

# File 'lib/aws-sdk-iot/types.rb', line 3088

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

#client_certificate_config ⇒ `Types::ClientCertificateConfig`

An object that speciﬁes the client certificate conﬁguration for a domain.

Returns:

(Types::ClientCertificateConfig)

# File 'lib/aws-sdk-iot/types.rb', line 3088

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

#domain_configuration_name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-iot/types.rb', line 3088

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

#domain_name ⇒ `String`

The name of the domain.

Returns:

(String)

# File 'lib/aws-sdk-iot/types.rb', line 3088

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

#server_certificate_arns ⇒ `Array<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>)

# File 'lib/aws-sdk-iot/types.rb', line 3088

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

#server_certificate_config ⇒ `Types::ServerCertificateConfig`

The server certificate configuration.

Returns:

(Types::ServerCertificateConfig)

# File 'lib/aws-sdk-iot/types.rb', line 3088

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

#service_type ⇒ `String`

The type of service delivered by the endpoint.

<note markdown=“1”> Amazon Web Services IoT Core currently supports only the ‘DATA` service type.

</note>

Returns:

(String)

# File 'lib/aws-sdk-iot/types.rb', line 3088

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

#tags ⇒ `Array<Types::Tag>`

Metadata which can be used to manage the domain configuration.

<note markdown=“1”> For URI Request parameters use format: …key1=value1&key2=value2…

For the CLI command-line parameter use format: &amp;&amp;tags

“key1=value1&key2=value2…”

For the cli-input-json file use format: "tags":

“key1=value1&key2=value2…”

</note>

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-iot/types.rb', line 3088

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

#tls_config ⇒ `Types::TlsConfig`

An object that specifies the TLS configuration for a domain.

Returns:

(Types::TlsConfig)

# File 'lib/aws-sdk-iot/types.rb', line 3088

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

#validation_certificate_arn ⇒ `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.

Returns:

(String)

# File 'lib/aws-sdk-iot/types.rb', line 3088

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

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

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#application_protocol ⇒ String

#authentication_type ⇒ String

#authorizer_config ⇒ Types::AuthorizerConfig

#client_certificate_config ⇒ Types::ClientCertificateConfig

#domain_configuration_name ⇒ String

#domain_name ⇒ String

#server_certificate_arns ⇒ Array<String>

#server_certificate_config ⇒ Types::ServerCertificateConfig

#service_type ⇒ String

#tags ⇒ Array<Types::Tag>

#tls_config ⇒ Types::TlsConfig

#validation_certificate_arn ⇒ String

#application_protocol ⇒ `String`

#authentication_type ⇒ `String`

#authorizer_config ⇒ `Types::AuthorizerConfig`

#client_certificate_config ⇒ `Types::ClientCertificateConfig`

#domain_configuration_name ⇒ `String`

#domain_name ⇒ `String`

#server_certificate_arns ⇒ `Array<String>`

#server_certificate_config ⇒ `Types::ServerCertificateConfig`

#service_type ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#tls_config ⇒ `Types::TlsConfig`

#validation_certificate_arn ⇒ `String`