Struct aws_sdk_datasync::input::create_agent_input::Builder

#[non_exhaustive]
pub struct Builder { /* private fields */ }

A builder for CreateAgentInput

Implementations

impl Builder

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

Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the DataSync console.

The redirect URL returned in the response provides you the activation key for your agent in the query string parameter activationKey. It might also include other activation-related parameters; however, these are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent.

For more information, see Activating an Agent in the DataSync User Guide.

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

Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the DataSync console.

The redirect URL returned in the response provides you the activation key for your agent in the query string parameter activationKey. It might also include other activation-related parameters; however, these are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent.

For more information, see Activating an Agent in the DataSync User Guide.

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

The name you configured for your agent. This value is a text reference that is used to identify the agent in the console.

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

The name you configured for your agent. This value is a text reference that is used to identify the agent in the console.

pub fn tags(self, input: TagListEntry) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

The key-value pair that represents the tag that you want to associate with the agent. The value can be an empty string. This value helps you manage, filter, and search for your agents.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.

pub fn set_tags(self, input: Option<Vec<TagListEntry>>) -> Self

The key-value pair that represents the tag that you want to associate with the agent. The value can be an empty string. This value helps you manage, filter, and search for your agents.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.

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

The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is the client-side VPC endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC endpoint, see Creating a VPC Endpoint Service Configuration in the Amazon VPC User Guide.

VPC endpoint ID looks like this: vpce-01234d5aff67890e1.

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

The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is the client-side VPC endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC endpoint, see Creating a VPC Endpoint Service Configuration in the Amazon VPC User Guide.

VPC endpoint ID looks like this: vpce-01234d5aff67890e1.

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

Appends an item to subnet_arns.

To override the contents of this collection use set_subnet_arns.

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task. The agent that runs a task must be private. When you start a task that is associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this case, DataSync creates four network interfaces for each task in your subnet. For a data transfer to work, the agent must be able to route to all these four network interfaces.

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

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task. The agent that runs a task must be private. When you start a task that is associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this case, DataSync creates four network interfaces for each task in your subnet. For a data transfer to work, the agent must be able to route to all these four network interfaces.

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

Appends an item to security_group_arns.

To override the contents of this collection use set_security_group_arns.

The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.

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

The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.

pub fn build(self) -> Result<CreateAgentInput, BuildError>

Consumes the builder and constructs a CreateAgentInput

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Builder) -> bool

This method tests for !=.

impl StructuralPartialEq for Builder