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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb

Overview

Note:

When making an API call, you may pass RegisterDomainInput data as a hash:

{
  name: "DomainName", # required
  description: "Description",
  workflow_execution_retention_period_in_days: "DurationInDays", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A text description of the domain.

Returns:

  • (String)


3962
3963
3964
3965
3966
3967
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3962

class RegisterDomainInput < Struct.new(
  :name,
  :description,
  :workflow_execution_retention_period_in_days)
  include Aws::Structure
end

#nameString

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 contain the literal string arn.

Returns:

  • (String)


3962
3963
3964
3965
3966
3967
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3962

class RegisterDomainInput < Struct.new(
  :name,
  :description,
  :workflow_execution_retention_period_in_days)
  include Aws::Structure
end

#workflow_execution_retention_period_in_daysString

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)


3962
3963
3964
3965
3966
3967
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3962

class RegisterDomainInput < Struct.new(
  :name,
  :description,
  :workflow_execution_retention_period_in_days)
  include Aws::Structure
end