You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SWF::Types::RegisterDomainInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RegisterDomainInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "DomainName", # required
  description: "Description",
  workflow_execution_retention_period_in_days: "DurationInDays", # required
  tags: [
    {
      key: "ResourceTagKey", # required
      value: "ResourceTagValue",
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A text description of the domain.

Returns:

  • (String) —

    A text description of the domain.

#name ⇒ String

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 (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

Returns:

  • (String) —

    Name of the domain to register.

#tags ⇒ Array<Types::ResourceTag>

Tags to be added when registering a domain.

Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

Returns:

#workflow_execution_retention_period_in_days ⇒ String

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 isn\'t available in the results of visibility calls.

If you pass the value NONE or 0 (zero), then the workflow execution history isn\'t 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:

  • (String) —

    The duration (in days) that records and histories of workflow executions on the domain should be kept by the service.