com.amazonaws.services.iot.model

Class CreateSecurityProfileRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.CreateSecurityProfileRequest

All Implemented Interfaces:

Serializable, Cloneable

public class CreateSecurityProfileRequest
extends AmazonWebServiceRequest
implements Serializable

Creates a Device Defender security profile.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateSecurityProfileRequest()

Method Summary

Modifier and Type	Method and Description
CreateSecurityProfileRequest	addalertTargetsEntry(String key, AlertTarget value) Specifies the destinations to which alerts are sent.
CreateSecurityProfileRequest	clearalertTargetsEntries() Removes all the entries added into alertTargets.
boolean	equals(Object obj)
List<String>	getAdditionalMetricsToRetain() A list of metrics whose data is retained (stored).
Map<String,AlertTarget>	getAlertTargets() Specifies the destinations to which alerts are sent.
List<Behavior>	getBehaviors() Specifies the behaviors that, when violated by a device (thing), cause an alert.
String	getSecurityProfileDescription() A description of the security profile.
String	getSecurityProfileName() The name you are giving to the security profile.
List<Tag>	getTags() Metadata that can be used to manage the security profile.
int	hashCode()
void	setAdditionalMetricsToRetain(Collection<String> additionalMetricsToRetain) A list of metrics whose data is retained (stored).
void	setAlertTargets(Map<String,AlertTarget> alertTargets) Specifies the destinations to which alerts are sent.
void	setBehaviors(Collection<Behavior> behaviors) Specifies the behaviors that, when violated by a device (thing), cause an alert.
void	setSecurityProfileDescription(String securityProfileDescription) A description of the security profile.
void	setSecurityProfileName(String securityProfileName) The name you are giving to the security profile.
void	setTags(Collection<Tag> tags) Metadata that can be used to manage the security profile.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateSecurityProfileRequest	withAdditionalMetricsToRetain(Collection<String> additionalMetricsToRetain) A list of metrics whose data is retained (stored).
CreateSecurityProfileRequest	withAdditionalMetricsToRetain(String... additionalMetricsToRetain) A list of metrics whose data is retained (stored).
CreateSecurityProfileRequest	withAlertTargets(Map<String,AlertTarget> alertTargets) Specifies the destinations to which alerts are sent.
CreateSecurityProfileRequest	withBehaviors(Behavior... behaviors) Specifies the behaviors that, when violated by a device (thing), cause an alert.
CreateSecurityProfileRequest	withBehaviors(Collection<Behavior> behaviors) Specifies the behaviors that, when violated by a device (thing), cause an alert.
CreateSecurityProfileRequest	withSecurityProfileDescription(String securityProfileDescription) A description of the security profile.
CreateSecurityProfileRequest	withSecurityProfileName(String securityProfileName) The name you are giving to the security profile.
CreateSecurityProfileRequest	withTags(Collection<Tag> tags) Metadata that can be used to manage the security profile.
CreateSecurityProfileRequest	withTags(Tag... tags) Metadata that can be used to manage the security profile.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateSecurityProfileRequest

public CreateSecurityProfileRequest()

Method Detail

getSecurityProfileName

public String getSecurityProfileName()

The name you are giving to the security profile.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Returns:

The name you are giving to the security profile.

setSecurityProfileName

public void setSecurityProfileName(String securityProfileName)

The name you are giving to the security profile.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Parameters:

securityProfileName -

The name you are giving to the security profile.

withSecurityProfileName

public CreateSecurityProfileRequest withSecurityProfileName(String securityProfileName)

The name you are giving to the security profile.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Parameters:

securityProfileName -

The name you are giving to the security profile.

Returns:

A reference to this updated object so that method calls can be chained together.

getSecurityProfileDescription

public String getSecurityProfileDescription()

A description of the security profile.

Constraints:
Length: - 1000
Pattern: [\p{Graph}\x20]*

Returns:

A description of the security profile.

setSecurityProfileDescription

public void setSecurityProfileDescription(String securityProfileDescription)

A description of the security profile.

Constraints:
Length: - 1000
Pattern: [\p{Graph}\x20]*

Parameters:

securityProfileDescription -

A description of the security profile.

withSecurityProfileDescription

public CreateSecurityProfileRequest withSecurityProfileDescription(String securityProfileDescription)

A description of the security profile.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: - 1000
Pattern: [\p{Graph}\x20]*

Parameters:

securityProfileDescription -

A description of the security profile.

Returns:

A reference to this updated object so that method calls can be chained together.

getBehaviors

public List<Behavior> getBehaviors()

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

Returns:

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

setBehaviors

public void setBehaviors(Collection<Behavior> behaviors)

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

Parameters:

behaviors -

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

withBehaviors

public CreateSecurityProfileRequest withBehaviors(Behavior... behaviors)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

behaviors -

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

Returns:

A reference to this updated object so that method calls can be chained together.

withBehaviors

public CreateSecurityProfileRequest withBehaviors(Collection<Behavior> behaviors)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

behaviors -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getAlertTargets

public Map<String,AlertTarget> getAlertTargets()

Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

Returns:

Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

setAlertTargets

public void setAlertTargets(Map<String,AlertTarget> alertTargets)

Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

Parameters:

alertTargets -

Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

withAlertTargets

public CreateSecurityProfileRequest withAlertTargets(Map<String,AlertTarget> alertTargets)

Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

Returns a reference to this object so that method calls can be chained together.

Parameters:

alertTargets -

Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

Returns:

A reference to this updated object so that method calls can be chained together.

addalertTargetsEntry

public CreateSecurityProfileRequest addalertTargetsEntry(String key,
                                                         AlertTarget value)

Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

The method adds a new key-value pair into alertTargets parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into alertTargets.

value - The corresponding value of the entry to be added into alertTargets.

Returns:

A reference to this updated object so that method calls can be chained together.

clearalertTargetsEntries

public CreateSecurityProfileRequest clearalertTargetsEntries()

Removes all the entries added into alertTargets.

Returns a reference to this object so that method calls can be chained together.

getAdditionalMetricsToRetain

public List<String> getAdditionalMetricsToRetain()

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:

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.

setAdditionalMetricsToRetain

public void setAdditionalMetricsToRetain(Collection<String> additionalMetricsToRetain)

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.

Parameters:

additionalMetricsToRetain -

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.

withAdditionalMetricsToRetain

public CreateSecurityProfileRequest withAdditionalMetricsToRetain(String... additionalMetricsToRetain)

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 a reference to this object so that method calls can be chained together.

Parameters:

additionalMetricsToRetain -

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:

A reference to this updated object so that method calls can be chained together.

withAdditionalMetricsToRetain

public CreateSecurityProfileRequest withAdditionalMetricsToRetain(Collection<String> additionalMetricsToRetain)

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 a reference to this object so that method calls can be chained together.

Parameters:

additionalMetricsToRetain -

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:

A reference to this updated object so that method calls can be chained together.

getTags

public List<Tag> getTags()

Metadata that can be used to manage the security profile.

Returns:

Metadata that can be used to manage the security profile.

setTags

public void setTags(Collection<Tag> tags)

Metadata that can be used to manage the security profile.

Parameters:

tags -

Metadata that can be used to manage the security profile.

withTags

public CreateSecurityProfileRequest withTags(Tag... tags)

Metadata that can be used to manage the security profile.

Returns a reference to this object so that method calls can be chained together.

Parameters:

tags -

Metadata that can be used to manage the security profile.

Returns:

A reference to this updated object so that method calls can be chained together.

withTags

public CreateSecurityProfileRequest withTags(Collection<Tag> tags)

Metadata that can be used to manage the security profile.

Returns a reference to this object so that method calls can be chained together.

Parameters:

tags -

Metadata that can be used to manage the security profile.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object