com.amazonaws.services.simpleworkflow.model

Class RegisterDomainRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.RegisterDomainRequest

All Implemented Interfaces:

Serializable

public class RegisterDomainRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the RegisterDomain operation.

Registers a new domain.

Access Control

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

• You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.
• 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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

See Also:

AmazonSimpleWorkflow.registerDomain(RegisterDomainRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RegisterDomainRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDescription() A text description of the domain.
String	getName() Name of the domain to register.
String	getWorkflowExecutionRetentionPeriodInDays() The duration (in days) that records and histories of workflow executions on the domain should be kept by the service.
int	hashCode()
void	setDescription(String description) A text description of the domain.
void	setName(String name) Name of the domain to register.
void	setWorkflowExecutionRetentionPeriodInDays(String workflowExecutionRetentionPeriodInDays) The duration (in days) that records and histories of workflow executions on the domain should be kept by the service.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RegisterDomainRequest	withDescription(String description) A text description of the domain.
RegisterDomainRequest	withName(String name) Name of the domain to register.
RegisterDomainRequest	withWorkflowExecutionRetentionPeriodInDays(String workflowExecutionRetentionPeriodInDays) The duration (in days) that records and histories of workflow executions on the domain should be kept by the service.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisterDomainRequest

public RegisterDomainRequest()

Method Detail

getName

public String getName()

Name of the domain to register. The name must be unique in the region that the domain is registered in.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string "arn".

Constraints:
Length: 1 - 256

Returns:

Name of the domain to register. The name must be unique in the region that the domain is registered in.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string "arn".

setName

public void setName(String name)

Name of the domain to register. The name must be unique in the region that the domain is registered in.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string "arn".

Constraints:
Length: 1 - 256

Parameters:

name - Name of the domain to register. The name must be unique in the region that the domain is registered in.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string "arn".

withName

public RegisterDomainRequest withName(String name)

Name of the domain to register. The name must be unique in the region that the domain is registered in.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string "arn".

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

Constraints:
Length: 1 - 256

Parameters:

name - Name of the domain to register. The name must be unique in the region that the domain is registered in.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string "arn".

Returns:

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

getDescription

public String getDescription()

A text description of the domain.

Constraints:
Length: 0 - 1024

Returns:

A text description of the domain.

setDescription

public void setDescription(String description)

A text description of the domain.

Constraints:
Length: 0 - 1024

Parameters:

description - A text description of the domain.

withDescription

public RegisterDomainRequest withDescription(String description)

A text description of the domain.

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

Constraints:
Length: 0 - 1024

Parameters:

description - A text description of the domain.

Returns:

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

getWorkflowExecutionRetentionPeriodInDays

public String getWorkflowExecutionRetentionPeriodInDays()

The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution is not available in the results of visibility calls.

If you pass the value NONE or 0 (zero), then the workflow execution history will not be retained. As soon as the workflow execution completes, the execution record and its history are deleted.

The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.

Constraints:
Length: 1 - 8

Returns:

The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution is not available in the results of visibility calls.

If you pass the value NONE or 0 (zero), then the workflow execution history will not be retained. As soon as the workflow execution completes, the execution record and its history are deleted.

The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.

setWorkflowExecutionRetentionPeriodInDays

public void setWorkflowExecutionRetentionPeriodInDays(String workflowExecutionRetentionPeriodInDays)

The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution is not available in the results of visibility calls.

If you pass the value NONE or 0 (zero), then the workflow execution history will not be retained. As soon as the workflow execution completes, the execution record and its history are deleted.

The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.

Constraints:
Length: 1 - 8

Parameters:

workflowExecutionRetentionPeriodInDays - The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution is not available in the results of visibility calls.

If you pass the value NONE or 0 (zero), then the workflow execution history will not be retained. As soon as the workflow execution completes, the execution record and its history are deleted.

The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.

withWorkflowExecutionRetentionPeriodInDays

public RegisterDomainRequest withWorkflowExecutionRetentionPeriodInDays(String workflowExecutionRetentionPeriodInDays)

The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution is not available in the results of visibility calls.

If you pass the value NONE or 0 (zero), then the workflow execution history will not be retained. As soon as the workflow execution completes, the execution record and its history are deleted.

The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.

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

Constraints:
Length: 1 - 8

Parameters:

workflowExecutionRetentionPeriodInDays - The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution is not available in the results of visibility calls.

If you pass the value NONE or 0 (zero), then the workflow execution history will not be retained. As soon as the workflow execution completes, the execution record and its history are deleted.

The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.

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