class Aws::DataSync::Types::CreateAgentRequest
@note When making an API call, you may pass CreateAgentRequest
data as a hash: { activation_key: "ActivationKey", # required agent_name: "TagValue", tags: [ { key: "TagKey", # required value: "TagValue", }, ], vpc_endpoint_id: "VpcEndpointId", subnet_arns: ["Ec2SubnetArn"], security_group_arns: ["Ec2SecurityGroupArn"], }
@!attribute [rw] activation_key
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.* @return [String]
@!attribute [rw] agent_name
The name you configured for your agent. This value is a text reference that is used to identify the agent in the console. @return [String]
@!attribute [rw] 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. <note markdown="1"> Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . \_ : / @. </note> @return [Array<Types::TagListEntry>]
@!attribute [rw] vpc_endpoint_id
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][1] in the Amazon VPC User Guide. VPC endpoint ID looks like this: `vpce-01234d5aff67890e1`. [1]: https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html#create-endpoint-service @return [String]
@!attribute [rw] 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. @return [Array<String>]
@!attribute [rw] security_group_arns
The ARNs of the security groups used to protect your data transfer task subnets. See [SecurityGroupArns][1]. [1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_Ec2Config.html#DataSync-Type-Ec2Config-SecurityGroupArns @return [Array<String>]
@see docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateAgentRequest AWS API Documentation
Constants
- SENSITIVE