com.amazonaws.services.iot.model

Class CreateSecurityProfileRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.CreateSecurityProfileRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateSecurityProfileRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateSecurityProfileRequest()

Method Summary

Modifier and Type	Method and Description
CreateSecurityProfileRequest	addAlertTargetsEntry(String key, AlertTarget value) Add a single AlertTargets entry
CreateSecurityProfileRequest	clearAlertTargetsEntries() Removes all the entries added into AlertTargets.
CreateSecurityProfileRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAdditionalMetricsToRetain() Deprecated.
List<MetricToRetain>	getAdditionalMetricsToRetainV2() 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.
MetricsExportConfig	getMetricsExportConfig() Specifies the MQTT topic and role ARN required for metric export.
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) Deprecated.
void	setAdditionalMetricsToRetainV2(Collection<MetricToRetain> additionalMetricsToRetainV2) 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	setMetricsExportConfig(MetricsExportConfig metricsExportConfig) Specifies the MQTT topic and role ARN required for metric export.
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.
CreateSecurityProfileRequest	withAdditionalMetricsToRetain(Collection<String> additionalMetricsToRetain) Deprecated.
CreateSecurityProfileRequest	withAdditionalMetricsToRetain(String... additionalMetricsToRetain) Deprecated.
CreateSecurityProfileRequest	withAdditionalMetricsToRetainV2(Collection<MetricToRetain> additionalMetricsToRetainV2) A list of metrics whose data is retained (stored).
CreateSecurityProfileRequest	withAdditionalMetricsToRetainV2(MetricToRetain... additionalMetricsToRetainV2) 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	withMetricsExportConfig(MetricsExportConfig metricsExportConfig) Specifies the MQTT topic and role ARN required for metric export.
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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateSecurityProfileRequest

public CreateSecurityProfileRequest()

Method Detail

setSecurityProfileName

public void setSecurityProfileName(String securityProfileName)

The name you are giving to the security profile.

Parameters:

securityProfileName - The name you are giving to the security profile.

getSecurityProfileName

public String getSecurityProfileName()

The name you are giving to the security profile.

Returns:

The name you are giving to the security profile.

withSecurityProfileName

public CreateSecurityProfileRequest withSecurityProfileName(String securityProfileName)

The name you are giving to the security profile.

Parameters:

securityProfileName - The name you are giving to the security profile.

Returns:

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

setSecurityProfileDescription

public void setSecurityProfileDescription(String securityProfileDescription)

A description of the security profile.

Parameters:

securityProfileDescription - A description of the security profile.

getSecurityProfileDescription

public String getSecurityProfileDescription()

A description of the security profile.

Returns:

A description of the security profile.

withSecurityProfileDescription

public CreateSecurityProfileRequest withSecurityProfileDescription(String securityProfileDescription)

A description of the security profile.

Parameters:

securityProfileDescription - A description of the security profile.

Returns:

Returns a reference to this 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.

NOTE: This method appends the values to the existing list (if any). Use setBehaviors(java.util.Collection) or withBehaviors(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this 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.

Parameters:

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

Returns:

Returns a reference to this 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.

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:

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

addAlertTargetsEntry

public CreateSecurityProfileRequest addAlertTargetsEntry(String key,
                                                         AlertTarget value)

Add a single AlertTargets entry

See Also:

withAlertTargets(java.util.Map<java.lang.String, com.amazonaws.services.iot.model.AlertTarget>)

clearAlertTargetsEntries

public CreateSecurityProfileRequest clearAlertTargetsEntries()

Removes all the entries added into AlertTargets.

Returns:

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

getAdditionalMetricsToRetain

@Deprecated
public List<String> getAdditionalMetricsToRetain()

Deprecated.

Please use CreateSecurityProfileRequest$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 CreateSecurityProfileRequest$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

@Deprecated
public void setAdditionalMetricsToRetain(Collection<String> additionalMetricsToRetain)

Deprecated.

Please use CreateSecurityProfileRequest$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 CreateSecurityProfileRequest$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

@Deprecated
public CreateSecurityProfileRequest withAdditionalMetricsToRetain(String... additionalMetricsToRetain)

Deprecated.

Please use CreateSecurityProfileRequest$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.

NOTE: This method appends the values to the existing list (if any). Use setAdditionalMetricsToRetain(java.util.Collection) or withAdditionalMetricsToRetain(java.util.Collection) if you want to override the existing values.

Parameters:

additionalMetricsToRetain - Please use CreateSecurityProfileRequest$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:

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

withAdditionalMetricsToRetain

@Deprecated
public CreateSecurityProfileRequest withAdditionalMetricsToRetain(Collection<String> additionalMetricsToRetain)

Deprecated.

Please use CreateSecurityProfileRequest$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 CreateSecurityProfileRequest$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:

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

getAdditionalMetricsToRetainV2

public 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(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 CreateSecurityProfileRequest 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.

NOTE: This method appends the values to the existing list (if any). Use setAdditionalMetricsToRetainV2(java.util.Collection) or withAdditionalMetricsToRetainV2(java.util.Collection) if you want to override the existing values.

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:

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

withAdditionalMetricsToRetainV2

public CreateSecurityProfileRequest withAdditionalMetricsToRetainV2(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.

Returns:

Returns a reference to this 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.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - Metadata that can be used to manage the security profile.

Returns:

Returns a reference to this 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.

Parameters:

tags - Metadata that can be used to manage the security profile.

Returns:

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

setMetricsExportConfig

public void setMetricsExportConfig(MetricsExportConfig metricsExportConfig)

Specifies the MQTT topic and role ARN required for metric export.

Parameters:

metricsExportConfig - Specifies the MQTT topic and role ARN required for metric export.

getMetricsExportConfig

public MetricsExportConfig getMetricsExportConfig()

Specifies the MQTT topic and role ARN required for metric export.

Returns:

Specifies the MQTT topic and role ARN required for metric export.

withMetricsExportConfig

public CreateSecurityProfileRequest withMetricsExportConfig(MetricsExportConfig metricsExportConfig)

Specifies the MQTT topic and role ARN required for metric export.

Parameters:

metricsExportConfig - Specifies the MQTT topic and role ARN required for metric export.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateSecurityProfileRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()