Class: Aws::IoT::Types::UpdateDomainConfigurationRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::UpdateDomainConfigurationRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_protocol ⇒ String

  An enumerated string that specifies the application-layer protocol.

• #authentication_type ⇒ String

  An enumerated string that specifies 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 specifies the client certificate configuration for a domain.

• #domain_configuration_name ⇒ String

  The name of the domain configuration to be updated.

• #domain_configuration_status ⇒ String

  The status to which the domain configuration should be updated.

• #remove_authorizer_config ⇒ Boolean

  Removes the authorization configuration from a domain.

• #server_certificate_config ⇒ Types::ServerCertificateConfig

  The server certificate configuration.

• #tls_config ⇒ Types::TlsConfig

  An object that specifies the TLS configuration for a domain.

Instance Attribute Details

#application_protocol ⇒ String

An enumerated string that specifies 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 17589

class UpdateDomainConfigurationRequest < Struct.new(
  :domain_configuration_name,
  :authorizer_config,
  :domain_configuration_status,
  :remove_authorizer_config,
  :tls_config,
  :server_certificate_config,
  :authentication_type,
  :application_protocol,
  :client_certificate_config)
  SENSITIVE = []
  include Aws::Structure
end

#authentication_type ⇒ String

An enumerated string that specifies 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 17589

class UpdateDomainConfigurationRequest < Struct.new(
  :domain_configuration_name,
  :authorizer_config,
  :domain_configuration_status,
  :remove_authorizer_config,
  :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 17589

class UpdateDomainConfigurationRequest < Struct.new(
  :domain_configuration_name,
  :authorizer_config,
  :domain_configuration_status,
  :remove_authorizer_config,
  :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 specifies the client certificate configuration for a domain.

Returns:

• (Types::ClientCertificateConfig)

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

class UpdateDomainConfigurationRequest < Struct.new(
  :domain_configuration_name,
  :authorizer_config,
  :domain_configuration_status,
  :remove_authorizer_config,
  :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 to be updated.

Returns:

• (String)

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

class UpdateDomainConfigurationRequest < Struct.new(
  :domain_configuration_name,
  :authorizer_config,
  :domain_configuration_status,
  :remove_authorizer_config,
  :tls_config,
  :server_certificate_config,
  :authentication_type,
  :application_protocol,
  :client_certificate_config)
  SENSITIVE = []
  include Aws::Structure
end

#domain_configuration_status ⇒ String

The status to which the domain configuration should be updated.

Returns:

• (String)

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

class UpdateDomainConfigurationRequest < Struct.new(
  :domain_configuration_name,
  :authorizer_config,
  :domain_configuration_status,
  :remove_authorizer_config,
  :tls_config,
  :server_certificate_config,
  :authentication_type,
  :application_protocol,
  :client_certificate_config)
  SENSITIVE = []
  include Aws::Structure
end

#remove_authorizer_config ⇒ Boolean

Removes the authorization configuration from a domain.

Returns:

• (Boolean)

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

class UpdateDomainConfigurationRequest < Struct.new(
  :domain_configuration_name,
  :authorizer_config,
  :domain_configuration_status,
  :remove_authorizer_config,
  :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 17589

class UpdateDomainConfigurationRequest < Struct.new(
  :domain_configuration_name,
  :authorizer_config,
  :domain_configuration_status,
  :remove_authorizer_config,
  :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 17589

class UpdateDomainConfigurationRequest < Struct.new(
  :domain_configuration_name,
  :authorizer_config,
  :domain_configuration_status,
  :remove_authorizer_config,
  :tls_config,
  :server_certificate_config,
  :authentication_type,
  :application_protocol,
  :client_certificate_config)
  SENSITIVE = []
  include Aws::Structure
end