com.amazonaws.services.simpleworkflow.model

Class DeprecateDomainRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.DeprecateDomainRequest

All Implemented Interfaces:

Serializable

public class DeprecateDomainRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DeprecateDomain operation.

Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated will continue to run.

NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.
• Use an Action element to allow or deny permission to call this action.
• You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

See Also:

AmazonSimpleWorkflow.deprecateDomain(DeprecateDomainRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeprecateDomainRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getName() The name of the domain to deprecate.
int	hashCode()
void	setName(String name) The name of the domain to deprecate.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DeprecateDomainRequest	withName(String name) The name of the domain to deprecate.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DeprecateDomainRequest

public DeprecateDomainRequest()

Method Detail

getName

public String getName()

The name of the domain to deprecate.

Constraints:
Length: 1 - 256

Returns:

The name of the domain to deprecate.

setName

public void setName(String name)

The name of the domain to deprecate.

Constraints:
Length: 1 - 256

Parameters:

name - The name of the domain to deprecate.

withName

public DeprecateDomainRequest withName(String name)

The name of the domain to deprecate.

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

Constraints:
Length: 1 - 256

Parameters:

name - The name of the domain to deprecate.

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