Struct aws_sdk_swf::operation::register_activity_type::builders::RegisterActivityTypeFluentBuilder

pub struct RegisterActivityTypeFluentBuilder { /* private fields */ }

Fluent builder constructing a request to RegisterActivityType.

Registers a new activity type along with its configuration settings in the specified domain.

A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.

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.

• Constrain the following parameters by using a Condition element with the appropriate keys.

  • defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.

  • name: String constraint. The key is swf:name.

  • version: String constraint. The key is swf:version.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Implementations

impl RegisterActivityTypeFluentBuilder

pub fn as_input(&self) -> &RegisterActivityTypeInputBuilder

Access the RegisterActivityType as a reference.

pub async fn send( self ) -> Result<RegisterActivityTypeOutput, SdkError<RegisterActivityTypeError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<RegisterActivityTypeOutput, RegisterActivityTypeError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn domain(self, input: impl Into<String>) -> Self

The name of the domain in which this activity is to be registered.

pub fn set_domain(self, input: Option<String>) -> Self

The name of the domain in which this activity is to be registered.

pub fn get_domain(&self) -> &Option<String>

The name of the domain in which this activity is to be registered.

pub fn name(self, input: impl Into<String>) -> Self

The name of the activity type within the domain.

The specified string 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.

pub fn set_name(self, input: Option<String>) -> Self

The name of the activity type within the domain.

The specified string 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.

pub fn get_name(&self) -> &Option<String>

The name of the activity type within the domain.

The specified string 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.

pub fn version(self, input: impl Into<String>) -> Self

The version of the activity type.

The activity type consists of the name and version, the combination of which must be unique within the domain.

The specified string 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.

pub fn set_version(self, input: Option<String>) -> Self

The version of the activity type.

The activity type consists of the name and version, the combination of which must be unique within the domain.

The specified string 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.

pub fn get_version(&self) -> &Option<String>

The version of the activity type.

The activity type consists of the name and version, the combination of which must be unique within the domain.

The specified string 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.

pub fn description(self, input: impl Into<String>) -> Self

A textual description of the activity type.

pub fn set_description(self, input: Option<String>) -> Self

A textual description of the activity type.

pub fn get_description(&self) -> &Option<String>

A textual description of the activity type.

pub fn default_task_start_to_close_timeout( self, input: impl Into<String> ) -> Self

If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

pub fn set_default_task_start_to_close_timeout( self, input: Option<String> ) -> Self

If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

pub fn get_default_task_start_to_close_timeout(&self) -> &Option<String>

If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

pub fn default_task_heartbeat_timeout(self, input: impl Into<String>) -> Self

If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

pub fn set_default_task_heartbeat_timeout(self, input: Option<String>) -> Self

If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

pub fn get_default_task_heartbeat_timeout(&self) -> &Option<String>

If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

pub fn default_task_list(self, input: TaskList) -> Self

If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision.

pub fn set_default_task_list(self, input: Option<TaskList>) -> Self

If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision.

pub fn get_default_task_list(&self) -> &Option<TaskList>

If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision.

pub fn default_task_priority(self, input: impl Into<String>) -> Self

The default task priority to assign to the activity type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the in the Amazon SWF Developer Guide..

pub fn set_default_task_priority(self, input: Option<String>) -> Self

The default task priority to assign to the activity type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the in the Amazon SWF Developer Guide..

pub fn get_default_task_priority(&self) -> &Option<String>

The default task priority to assign to the activity type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the in the Amazon SWF Developer Guide..

pub fn default_task_schedule_to_start_timeout( self, input: impl Into<String> ) -> Self

If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

pub fn set_default_task_schedule_to_start_timeout( self, input: Option<String> ) -> Self

If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

pub fn get_default_task_schedule_to_start_timeout(&self) -> &Option<String>

If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

pub fn default_task_schedule_to_close_timeout( self, input: impl Into<String> ) -> Self

If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

pub fn set_default_task_schedule_to_close_timeout( self, input: Option<String> ) -> Self

If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

pub fn get_default_task_schedule_to_close_timeout(&self) -> &Option<String>

If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Trait Implementations

impl Clone for RegisterActivityTypeFluentBuilder

fn clone(&self) -> RegisterActivityTypeFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RegisterActivityTypeFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.