com.amazonaws.services.iot.model

Class UpdateSecurityProfileRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.UpdateSecurityProfileRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class UpdateSecurityProfileRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Updates a Device Defender security profile.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdateSecurityProfileRequest()

Method Summary

Modifier and Type	Method and Description
UpdateSecurityProfileRequest	addalertTargetsEntry(java.lang.String key, AlertTarget value) Where the alerts are sent.
UpdateSecurityProfileRequest	clearalertTargetsEntries() Removes all the entries added into alertTargets.
boolean	equals(java.lang.Object obj)
java.util.List<java.lang.String>	getAdditionalMetricsToRetain() Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
java.util.List<MetricToRetain>	getAdditionalMetricsToRetainV2() A list of metrics whose data is retained (stored).
java.util.Map<java.lang.String,AlertTarget>	getAlertTargets() Where the alerts are sent.
java.util.List<Behavior>	getBehaviors() Specifies the behaviors that, when violated by a device (thing), cause an alert.
java.lang.Boolean	getDeleteAdditionalMetricsToRetain() If true, delete all additionalMetricsToRetain defined for this security profile.
java.lang.Boolean	getDeleteAlertTargets() If true, delete all alertTargets defined for this security profile.
java.lang.Boolean	getDeleteBehaviors() If true, delete all behaviors defined for this security profile.
java.lang.Long	getExpectedVersion() The expected version of the security profile.
java.lang.String	getSecurityProfileDescription() A description of the security profile.
java.lang.String	getSecurityProfileName() The name of the security profile you want to update.
int	hashCode()
java.lang.Boolean	isDeleteAdditionalMetricsToRetain() If true, delete all additionalMetricsToRetain defined for this security profile.
java.lang.Boolean	isDeleteAlertTargets() If true, delete all alertTargets defined for this security profile.
java.lang.Boolean	isDeleteBehaviors() If true, delete all behaviors defined for this security profile.
void	setAdditionalMetricsToRetain(java.util.Collection<java.lang.String> additionalMetricsToRetain) Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
void	setAdditionalMetricsToRetainV2(java.util.Collection<MetricToRetain> additionalMetricsToRetainV2) A list of metrics whose data is retained (stored).
void	setAlertTargets(java.util.Map<java.lang.String,AlertTarget> alertTargets) Where the alerts are sent.
void	setBehaviors(java.util.Collection<Behavior> behaviors) Specifies the behaviors that, when violated by a device (thing), cause an alert.
void	setDeleteAdditionalMetricsToRetain(java.lang.Boolean deleteAdditionalMetricsToRetain) If true, delete all additionalMetricsToRetain defined for this security profile.
void	setDeleteAlertTargets(java.lang.Boolean deleteAlertTargets) If true, delete all alertTargets defined for this security profile.
void	setDeleteBehaviors(java.lang.Boolean deleteBehaviors) If true, delete all behaviors defined for this security profile.
void	setExpectedVersion(java.lang.Long expectedVersion) The expected version of the security profile.
void	setSecurityProfileDescription(java.lang.String securityProfileDescription) A description of the security profile.
void	setSecurityProfileName(java.lang.String securityProfileName) The name of the security profile you want to update.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateSecurityProfileRequest	withAdditionalMetricsToRetain(java.util.Collection<java.lang.String> additionalMetricsToRetain) Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
UpdateSecurityProfileRequest	withAdditionalMetricsToRetain(java.lang.String... additionalMetricsToRetain) Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
UpdateSecurityProfileRequest	withAdditionalMetricsToRetainV2(java.util.Collection<MetricToRetain> additionalMetricsToRetainV2) A list of metrics whose data is retained (stored).
UpdateSecurityProfileRequest	withAdditionalMetricsToRetainV2(MetricToRetain... additionalMetricsToRetainV2) A list of metrics whose data is retained (stored).
UpdateSecurityProfileRequest	withAlertTargets(java.util.Map<java.lang.String,AlertTarget> alertTargets) Where the alerts are sent.
UpdateSecurityProfileRequest	withBehaviors(Behavior... behaviors) Specifies the behaviors that, when violated by a device (thing), cause an alert.
UpdateSecurityProfileRequest	withBehaviors(java.util.Collection<Behavior> behaviors) Specifies the behaviors that, when violated by a device (thing), cause an alert.
UpdateSecurityProfileRequest	withDeleteAdditionalMetricsToRetain(java.lang.Boolean deleteAdditionalMetricsToRetain) If true, delete all additionalMetricsToRetain defined for this security profile.
UpdateSecurityProfileRequest	withDeleteAlertTargets(java.lang.Boolean deleteAlertTargets) If true, delete all alertTargets defined for this security profile.
UpdateSecurityProfileRequest	withDeleteBehaviors(java.lang.Boolean deleteBehaviors) If true, delete all behaviors defined for this security profile.
UpdateSecurityProfileRequest	withExpectedVersion(java.lang.Long expectedVersion) The expected version of the security profile.
UpdateSecurityProfileRequest	withSecurityProfileDescription(java.lang.String securityProfileDescription) A description of the security profile.
UpdateSecurityProfileRequest	withSecurityProfileName(java.lang.String securityProfileName) The name of the security profile you want to update.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateSecurityProfileRequest

public UpdateSecurityProfileRequest()

Method Detail

getSecurityProfileName

public java.lang.String getSecurityProfileName()

The name of the security profile you want to update.

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

Returns:

The name of the security profile you want to update.

setSecurityProfileName

public void setSecurityProfileName(java.lang.String securityProfileName)

The name of the security profile you want to update.

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

Parameters:

securityProfileName -

The name of the security profile you want to update.

withSecurityProfileName

public UpdateSecurityProfileRequest withSecurityProfileName(java.lang.String securityProfileName)

The name of the security profile you want to update.

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 of the security profile you want to update.

Returns:

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

getSecurityProfileDescription

public java.lang.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(java.lang.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 UpdateSecurityProfileRequest withSecurityProfileDescription(java.lang.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 java.util.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(java.util.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 UpdateSecurityProfileRequest 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 UpdateSecurityProfileRequest withBehaviors(java.util.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 java.util.Map<java.lang.String,AlertTarget> getAlertTargets()

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

Returns:

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

setAlertTargets

public void setAlertTargets(java.util.Map<java.lang.String,AlertTarget> alertTargets)

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

Parameters:

alertTargets -

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

withAlertTargets

public UpdateSecurityProfileRequest withAlertTargets(java.util.Map<java.lang.String,AlertTarget> alertTargets)

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

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

Parameters:

alertTargets -

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

Returns:

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

addalertTargetsEntry

public UpdateSecurityProfileRequest addalertTargetsEntry(java.lang.String key,
                                                         AlertTarget value)

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

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 UpdateSecurityProfileRequest clearalertTargetsEntries()

Removes all the entries added into alertTargets.

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

getAdditionalMetricsToRetain

public java.util.List<java.lang.String> getAdditionalMetricsToRetain()

Please use UpdateSecurityProfileRequest$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. Can be used with custom metrics; cannot be used with dimensions.

Returns:

Please use UpdateSecurityProfileRequest$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. Can be used with custom metrics; cannot be used with dimensions.

setAdditionalMetricsToRetain

public void setAdditionalMetricsToRetain(java.util.Collection<java.lang.String> additionalMetricsToRetain)

Please use UpdateSecurityProfileRequest$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. Can be used with custom metrics; cannot be used with dimensions.

Parameters:

additionalMetricsToRetain -

Please use UpdateSecurityProfileRequest$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. Can be used with custom metrics; cannot be used with dimensions.

withAdditionalMetricsToRetain

public UpdateSecurityProfileRequest withAdditionalMetricsToRetain(java.lang.String... additionalMetricsToRetain)

Please use UpdateSecurityProfileRequest$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. Can be used with custom metrics; cannot be used with dimensions.

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

Parameters:

additionalMetricsToRetain -

Please use UpdateSecurityProfileRequest$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. Can be used with custom metrics; cannot be used with dimensions.

Returns:

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

withAdditionalMetricsToRetain

public UpdateSecurityProfileRequest withAdditionalMetricsToRetain(java.util.Collection<java.lang.String> additionalMetricsToRetain)

Please use UpdateSecurityProfileRequest$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. Can be used with custom metrics; cannot be used with dimensions.

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

Parameters:

additionalMetricsToRetain -

Please use UpdateSecurityProfileRequest$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. Can be used with custom metrics; cannot be used with dimensions.

Returns:

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

getAdditionalMetricsToRetainV2

public java.util.List<MetricToRetain> getAdditionalMetricsToRetainV2()

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. Can be used with custom metrics; cannot be used with dimensions.

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. Can be used with custom metrics; cannot be used with dimensions.

setAdditionalMetricsToRetainV2

public void setAdditionalMetricsToRetainV2(java.util.Collection<MetricToRetain> additionalMetricsToRetainV2)

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. Can be used with custom metrics; cannot be used with dimensions.

Parameters:

additionalMetricsToRetainV2 -

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. Can be used with custom metrics; cannot be used with dimensions.

withAdditionalMetricsToRetainV2

public UpdateSecurityProfileRequest withAdditionalMetricsToRetainV2(MetricToRetain... additionalMetricsToRetainV2)

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. Can be used with custom metrics; cannot be used with dimensions.

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

Parameters:

additionalMetricsToRetainV2 -

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. Can be used with custom metrics; cannot be used with dimensions.

Returns:

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

withAdditionalMetricsToRetainV2

public UpdateSecurityProfileRequest withAdditionalMetricsToRetainV2(java.util.Collection<MetricToRetain> additionalMetricsToRetainV2)

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. Can be used with custom metrics; cannot be used with dimensions.

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

Parameters:

additionalMetricsToRetainV2 -

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. Can be used with custom metrics; cannot be used with dimensions.

Returns:

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

isDeleteBehaviors

public java.lang.Boolean isDeleteBehaviors()

If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

Returns:

If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

getDeleteBehaviors

public java.lang.Boolean getDeleteBehaviors()

If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

Returns:

If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

setDeleteBehaviors

public void setDeleteBehaviors(java.lang.Boolean deleteBehaviors)

If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

Parameters:

deleteBehaviors -

If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

withDeleteBehaviors

public UpdateSecurityProfileRequest withDeleteBehaviors(java.lang.Boolean deleteBehaviors)

If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

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

Parameters:

deleteBehaviors -

If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

Returns:

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

isDeleteAlertTargets

public java.lang.Boolean isDeleteAlertTargets()

If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

Returns:

If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

getDeleteAlertTargets

public java.lang.Boolean getDeleteAlertTargets()

If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

Returns:

If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

setDeleteAlertTargets

public void setDeleteAlertTargets(java.lang.Boolean deleteAlertTargets)

If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

Parameters:

deleteAlertTargets -

If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

withDeleteAlertTargets

public UpdateSecurityProfileRequest withDeleteAlertTargets(java.lang.Boolean deleteAlertTargets)

If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

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

Parameters:

deleteAlertTargets -

If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

Returns:

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

isDeleteAdditionalMetricsToRetain

public java.lang.Boolean isDeleteAdditionalMetricsToRetain()

If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

Returns:

If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

getDeleteAdditionalMetricsToRetain

public java.lang.Boolean getDeleteAdditionalMetricsToRetain()

If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

Returns:

If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

setDeleteAdditionalMetricsToRetain

public void setDeleteAdditionalMetricsToRetain(java.lang.Boolean deleteAdditionalMetricsToRetain)

If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

Parameters:

deleteAdditionalMetricsToRetain -

If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

withDeleteAdditionalMetricsToRetain

public UpdateSecurityProfileRequest withDeleteAdditionalMetricsToRetain(java.lang.Boolean deleteAdditionalMetricsToRetain)

If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

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

Parameters:

deleteAdditionalMetricsToRetain -

If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

Returns:

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

getExpectedVersion

public java.lang.Long getExpectedVersion()

The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

Returns:

The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

setExpectedVersion

public void setExpectedVersion(java.lang.Long expectedVersion)

The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

Parameters:

expectedVersion -

The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

withExpectedVersion

public UpdateSecurityProfileRequest withExpectedVersion(java.lang.Long expectedVersion)

The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

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

Parameters:

expectedVersion -

The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object