Struct aws_sdk_datasync::input::CreateAgentInput

#[non_exhaustive]
pub struct CreateAgentInput {
    pub activation_key: Option<String>,
    pub agent_name: Option<String>,
    pub tags: Option<Vec<TagListEntry>>,
    pub vpc_endpoint_id: Option<String>,
    pub subnet_arns: Option<Vec<String>>,
    pub security_group_arns: Option<Vec<String>>,
}

CreateAgentRequest

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

activation_key: Option<String>

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.

agent_name: Option<String>

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

tags: Option<Vec<TagListEntry>>

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: + - = . _ : / @.

vpc_endpoint_id: Option<String>

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.

subnet_arns: Option<Vec<String>>

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.

security_group_arns: Option<Vec<String>>

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

Implementations

impl CreateAgentInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<CreateAgent, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<CreateAgent>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateAgentInput

impl CreateAgentInput

pub fn activation_key(&self) -> Option<&str>

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) -> Option<&str>

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) -> Option<&[TagListEntry]>

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) -> Option<&str>

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) -> Option<&[String]>

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) -> Option<&[String]>

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

Trait Implementations

impl Clone for CreateAgentInput

fn clone(&self) -> CreateAgentInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateAgentInput

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

Formats the value using the given formatter.

impl PartialEq<CreateAgentInput> for CreateAgentInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for CreateAgentInput