Class: Aws::IoT::Types::DescribeSecurityProfileResponse

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

#additional_metrics_to_retain ⇒ Array<String>

*Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead.*

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile’s ‘behaviors`, but it is also retained for any metric specified here.

Returns:

  • (Array<String>) 


5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
 
# File 'lib/aws-sdk-iot/types.rb', line 5997

class DescribeSecurityProfileResponse < Struct.new(
  :security_profile_name,
  :security_profile_arn,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :version,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#additional_metrics_to_retain_v2 ⇒ Array<Types::MetricToRetain>

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile’s behaviors, but it is also retained for any metric specified here.

Returns:



5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
 
# File 'lib/aws-sdk-iot/types.rb', line 5997

class DescribeSecurityProfileResponse < Struct.new(
  :security_profile_name,
  :security_profile_arn,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :version,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#alert_targets ⇒ Hash<String,Types::AlertTarget>

Where the alerts are sent. (Alerts are always sent to the console.)

Returns:



5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
 
# File 'lib/aws-sdk-iot/types.rb', line 5997

class DescribeSecurityProfileResponse < Struct.new(
  :security_profile_name,
  :security_profile_arn,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :version,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#behaviors ⇒ Array<Types::Behavior>

Specifies the behaviors that, when violated by a device (thing), cause an alert.

Returns:



5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
 
# File 'lib/aws-sdk-iot/types.rb', line 5997

class DescribeSecurityProfileResponse < Struct.new(
  :security_profile_name,
  :security_profile_arn,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :version,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ Time

The time the security profile was created.

Returns:

  • (Time) 


5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
 
# File 'lib/aws-sdk-iot/types.rb', line 5997

class DescribeSecurityProfileResponse < Struct.new(
  :security_profile_name,
  :security_profile_arn,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :version,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ Time

The time the security profile was last modified.

Returns:

  • (Time) 


5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
 
# File 'lib/aws-sdk-iot/types.rb', line 5997

class DescribeSecurityProfileResponse < Struct.new(
  :security_profile_name,
  :security_profile_arn,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :version,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#security_profile_arn ⇒ String

The ARN of the security profile.

Returns:

  • (String) 


5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
 
# File 'lib/aws-sdk-iot/types.rb', line 5997

class DescribeSecurityProfileResponse < Struct.new(
  :security_profile_name,
  :security_profile_arn,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :version,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#security_profile_description ⇒ String

A description of the security profile (associated with the security profile when it was created or updated).

Returns:

  • (String) 


5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
 
# File 'lib/aws-sdk-iot/types.rb', line 5997

class DescribeSecurityProfileResponse < Struct.new(
  :security_profile_name,
  :security_profile_arn,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :version,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#security_profile_name ⇒ String

The name of the security profile.

Returns:

  • (String) 


5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
 
# File 'lib/aws-sdk-iot/types.rb', line 5997

class DescribeSecurityProfileResponse < Struct.new(
  :security_profile_name,
  :security_profile_arn,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :version,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ Integer

The version of the security profile. A new version is generated whenever the security profile is updated.

Returns:

  • (Integer) 


5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
 
# File 'lib/aws-sdk-iot/types.rb', line 5997

class DescribeSecurityProfileResponse < Struct.new(
  :security_profile_name,
  :security_profile_arn,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :version,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end