com.amazonaws.services.iot.model

Class CreateMitigationActionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.CreateMitigationActionRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreateMitigationActionRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateMitigationActionRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getActionName() A friendly name for the action.
MitigationActionParams	getActionParams() Defines the type of action and the parameters for that action.
java.lang.String	getRoleArn() The ARN of the IAM role that is used to apply the mitigation action.
java.util.List<Tag>	getTags() Metadata that can be used to manage the mitigation action.
int	hashCode()
void	setActionName(java.lang.String actionName) A friendly name for the action.
void	setActionParams(MitigationActionParams actionParams) Defines the type of action and the parameters for that action.
void	setRoleArn(java.lang.String roleArn) The ARN of the IAM role that is used to apply the mitigation action.
void	setTags(java.util.Collection<Tag> tags) Metadata that can be used to manage the mitigation action.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateMitigationActionRequest	withActionName(java.lang.String actionName) A friendly name for the action.
CreateMitigationActionRequest	withActionParams(MitigationActionParams actionParams) Defines the type of action and the parameters for that action.
CreateMitigationActionRequest	withRoleArn(java.lang.String roleArn) The ARN of the IAM role that is used to apply the mitigation action.
CreateMitigationActionRequest	withTags(java.util.Collection<Tag> tags) Metadata that can be used to manage the mitigation action.
CreateMitigationActionRequest	withTags(Tag... tags) Metadata that can be used to manage the mitigation action.

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

CreateMitigationActionRequest

public CreateMitigationActionRequest()

Method Detail

getActionName

public java.lang.String getActionName()

A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

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

Returns:

A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

setActionName

public void setActionName(java.lang.String actionName)

A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

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

Parameters:

actionName -

A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

withActionName

public CreateMitigationActionRequest withActionName(java.lang.String actionName)

A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

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

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

Parameters:

actionName -

A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

Returns:

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

getRoleArn

public java.lang.String getRoleArn()

The ARN of the IAM role that is used to apply the mitigation action.

Constraints:
Length: 20 - 2048

Returns:

The ARN of the IAM role that is used to apply the mitigation action.

setRoleArn

public void setRoleArn(java.lang.String roleArn)

The ARN of the IAM role that is used to apply the mitigation action.

Constraints:
Length: 20 - 2048

Parameters:

roleArn -

The ARN of the IAM role that is used to apply the mitigation action.

withRoleArn

public CreateMitigationActionRequest withRoleArn(java.lang.String roleArn)

The ARN of the IAM role that is used to apply the mitigation action.

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

Constraints:
Length: 20 - 2048

Parameters:

roleArn -

The ARN of the IAM role that is used to apply the mitigation action.

Returns:

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

getActionParams

public MitigationActionParams getActionParams()

Defines the type of action and the parameters for that action.

Returns:

Defines the type of action and the parameters for that action.

setActionParams

public void setActionParams(MitigationActionParams actionParams)

Defines the type of action and the parameters for that action.

Parameters:

actionParams -

Defines the type of action and the parameters for that action.

withActionParams

public CreateMitigationActionRequest withActionParams(MitigationActionParams actionParams)

Defines the type of action and the parameters for that action.

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

Parameters:

actionParams -

Defines the type of action and the parameters for that action.

Returns:

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

getTags

public java.util.List<Tag> getTags()

Metadata that can be used to manage the mitigation action.

Returns:

Metadata that can be used to manage the mitigation action.

setTags

public void setTags(java.util.Collection<Tag> tags)

Metadata that can be used to manage the mitigation action.

Parameters:

tags -

Metadata that can be used to manage the mitigation action.

withTags

public CreateMitigationActionRequest withTags(Tag... tags)

Metadata that can be used to manage the mitigation action.

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

Parameters:

tags -

Metadata that can be used to manage the mitigation action.

Returns:

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

withTags

public CreateMitigationActionRequest withTags(java.util.Collection<Tag> tags)

Metadata that can be used to manage the mitigation action.

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

Parameters:

tags -

Metadata that can be used to manage the mitigation action.

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