Class: Aws::IoT::Types::DescribeDomainConfigurationResponse

Inherits:

Struct

Object
Struct
Aws::IoT::Types::DescribeDomainConfigurationResponse

show all

Defined in:: gems/aws-sdk-iot/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_arn ⇒ String
The ARN of the domain configuration.
#domain_configuration_name ⇒ String
The name of the domain configuration.
#domain_configuration_status ⇒ String
A Boolean value that specifies the current state of the domain configuration.
#domain_name ⇒ String
The name of the domain.
#domain_type ⇒ String
The type of the domain.
#last_status_change_date ⇒ Time
The date and time the domain configuration's status was last changed.
#server_certificate_config ⇒ Types::ServerCertificateConfig
The server certificate configuration.
#server_certificates ⇒ Array<Types::ServerCertificateSummary>
A list containing summary information about the server certificate included in the domain configuration.
#service_type ⇒ String
The type of service delivered by the endpoint.
#tls_config ⇒ Types::TlsConfig
An object that specifies the TLS configuration for a domain.

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.

Returns:

(String)

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

class DescribeDomainConfigurationResponse < Struct.new(
  :domain_configuration_name,
  :domain_configuration_arn,
  :domain_name,
  :server_certificates,
  :authorizer_config,
  :domain_configuration_status,
  :service_type,
  :domain_type,
  :last_status_change_date,
  :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.

Returns:

(String)

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

class DescribeDomainConfigurationResponse < Struct.new(
  :domain_configuration_name,
  :domain_configuration_arn,
  :domain_name,
  :server_certificates,
  :authorizer_config,
  :domain_configuration_status,
  :service_type,
  :domain_type,
  :last_status_change_date,
  :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 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6073

class DescribeDomainConfigurationResponse < Struct.new(
  :domain_configuration_name,
  :domain_configuration_arn,
  :domain_name,
  :server_certificates,
  :authorizer_config,
  :domain_configuration_status,
  :service_type,
  :domain_type,
  :last_status_change_date,
  :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 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6073

class DescribeDomainConfigurationResponse < Struct.new(
  :domain_configuration_name,
  :domain_configuration_arn,
  :domain_name,
  :server_certificates,
  :authorizer_config,
  :domain_configuration_status,
  :service_type,
  :domain_type,
  :last_status_change_date,
  :tls_config,
  :server_certificate_config,
  :authentication_type,
  :application_protocol,
  :client_certificate_config)
  SENSITIVE = []
  include Aws::Structure
end

#domain_configuration_arn ⇒ `String`

The ARN of the domain configuration.

Returns:

(String)

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

class DescribeDomainConfigurationResponse < Struct.new(
  :domain_configuration_name,
  :domain_configuration_arn,
  :domain_name,
  :server_certificates,
  :authorizer_config,
  :domain_configuration_status,
  :service_type,
  :domain_type,
  :last_status_change_date,
  :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.

Returns:

(String)

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

class DescribeDomainConfigurationResponse < Struct.new(
  :domain_configuration_name,
  :domain_configuration_arn,
  :domain_name,
  :server_certificates,
  :authorizer_config,
  :domain_configuration_status,
  :service_type,
  :domain_type,
  :last_status_change_date,
  :tls_config,
  :server_certificate_config,
  :authentication_type,
  :application_protocol,
  :client_certificate_config)
  SENSITIVE = []
  include Aws::Structure
end

#domain_configuration_status ⇒ `String`

A Boolean value that specifies the current state of the domain configuration.

Returns:

(String)

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

class DescribeDomainConfigurationResponse < Struct.new(
  :domain_configuration_name,
  :domain_configuration_arn,
  :domain_name,
  :server_certificates,
  :authorizer_config,
  :domain_configuration_status,
  :service_type,
  :domain_type,
  :last_status_change_date,
  :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 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6073

class DescribeDomainConfigurationResponse < Struct.new(
  :domain_configuration_name,
  :domain_configuration_arn,
  :domain_name,
  :server_certificates,
  :authorizer_config,
  :domain_configuration_status,
  :service_type,
  :domain_type,
  :last_status_change_date,
  :tls_config,
  :server_certificate_config,
  :authentication_type,
  :application_protocol,
  :client_certificate_config)
  SENSITIVE = []
  include Aws::Structure
end

#domain_type ⇒ `String`

The type of the domain.

Returns:

(String)

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

class DescribeDomainConfigurationResponse < Struct.new(
  :domain_configuration_name,
  :domain_configuration_arn,
  :domain_name,
  :server_certificates,
  :authorizer_config,
  :domain_configuration_status,
  :service_type,
  :domain_type,
  :last_status_change_date,
  :tls_config,
  :server_certificate_config,
  :authentication_type,
  :application_protocol,
  :client_certificate_config)
  SENSITIVE = []
  include Aws::Structure
end

#last_status_change_date ⇒ `Time`

The date and time the domain configuration's status was last changed.

Returns:

(Time)

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

class DescribeDomainConfigurationResponse < Struct.new(
  :domain_configuration_name,
  :domain_configuration_arn,
  :domain_name,
  :server_certificates,
  :authorizer_config,
  :domain_configuration_status,
  :service_type,
  :domain_type,
  :last_status_change_date,
  :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 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6073

class DescribeDomainConfigurationResponse < Struct.new(
  :domain_configuration_name,
  :domain_configuration_arn,
  :domain_name,
  :server_certificates,
  :authorizer_config,
  :domain_configuration_status,
  :service_type,
  :domain_type,
  :last_status_change_date,
  :tls_config,
  :server_certificate_config,
  :authentication_type,
  :application_protocol,
  :client_certificate_config)
  SENSITIVE = []
  include Aws::Structure
end

#server_certificates ⇒ `Array<Types::ServerCertificateSummary>`

A list containing summary information about the server certificate included in the domain configuration.

Returns:

(Array<Types::ServerCertificateSummary>)

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

class DescribeDomainConfigurationResponse < Struct.new(
  :domain_configuration_name,
  :domain_configuration_arn,
  :domain_name,
  :server_certificates,
  :authorizer_config,
  :domain_configuration_status,
  :service_type,
  :domain_type,
  :last_status_change_date,
  :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.

Returns:

(String)

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

class DescribeDomainConfigurationResponse < Struct.new(
  :domain_configuration_name,
  :domain_configuration_arn,
  :domain_name,
  :server_certificates,
  :authorizer_config,
  :domain_configuration_status,
  :service_type,
  :domain_type,
  :last_status_change_date,
  :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 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6073

class DescribeDomainConfigurationResponse < Struct.new(
  :domain_configuration_name,
  :domain_configuration_arn,
  :domain_name,
  :server_certificates,
  :authorizer_config,
  :domain_configuration_status,
  :service_type,
  :domain_type,
  :last_status_change_date,
  :tls_config,
  :server_certificate_config,
  :authentication_type,
  :application_protocol,
  :client_certificate_config)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::IoT::Types::DescribeDomainConfigurationResponse

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_arn ⇒ String

#domain_configuration_name ⇒ String

#domain_configuration_status ⇒ String

#domain_name ⇒ String

#domain_type ⇒ String

#last_status_change_date ⇒ Time

#server_certificate_config ⇒ Types::ServerCertificateConfig

#server_certificates ⇒ Array<Types::ServerCertificateSummary>

#service_type ⇒ String

#tls_config ⇒ Types::TlsConfig

#application_protocol ⇒ `String`

#authentication_type ⇒ `String`

#authorizer_config ⇒ `Types::AuthorizerConfig`

#client_certificate_config ⇒ `Types::ClientCertificateConfig`

#domain_configuration_arn ⇒ `String`

#domain_configuration_name ⇒ `String`

#domain_configuration_status ⇒ `String`

#domain_name ⇒ `String`

#domain_type ⇒ `String`

#last_status_change_date ⇒ `Time`

#server_certificate_config ⇒ `Types::ServerCertificateConfig`

#server_certificates ⇒ `Array<Types::ServerCertificateSummary>`

#service_type ⇒ `String`

#tls_config ⇒ `Types::TlsConfig`