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

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
 
# File 'lib/aws-sdk-iot/types.rb', line 5701

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 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) 


5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
 
# File 'lib/aws-sdk-iot/types.rb', line 5701

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:



5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
 
# File 'lib/aws-sdk-iot/types.rb', line 5701

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

Returns:



5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
 
# File 'lib/aws-sdk-iot/types.rb', line 5701

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) 


5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
 
# File 'lib/aws-sdk-iot/types.rb', line 5701

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) 


5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
 
# File 'lib/aws-sdk-iot/types.rb', line 5701

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) 


5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
 
# File 'lib/aws-sdk-iot/types.rb', line 5701

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) 


5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
 
# File 'lib/aws-sdk-iot/types.rb', line 5701

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) 


5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
 
# File 'lib/aws-sdk-iot/types.rb', line 5701

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) 


5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
 
# File 'lib/aws-sdk-iot/types.rb', line 5701

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:



5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
 
# File 'lib/aws-sdk-iot/types.rb', line 5701

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:



5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
 
# File 'lib/aws-sdk-iot/types.rb', line 5701

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) 


5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
 
# File 'lib/aws-sdk-iot/types.rb', line 5701

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:



5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
 
# File 'lib/aws-sdk-iot/types.rb', line 5701

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