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

Class: Aws::DataSync::Types::CreateAgentRequest

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

Overview

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"],
}

CreateAgentRequest

Instance Attribute Summary collapse

Instance Attribute Details

#activation_keyString

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 AWS 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 AWS DataSync User Guide.

Returns:

  • (String)


145
146
147
148
149
150
151
152
153
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 145

class CreateAgentRequest < Struct.new(
  :activation_key,
  :agent_name,
  :tags,
  :vpc_endpoint_id,
  :subnet_arns,
  :security_group_arns)
  include Aws::Structure
end

#agent_nameString

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

Returns:

  • (String)


145
146
147
148
149
150
151
152
153
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 145

class CreateAgentRequest < Struct.new(
  :activation_key,
  :agent_name,
  :tags,
  :vpc_endpoint_id,
  :subnet_arns,
  :security_group_arns)
  include Aws::Structure
end

#security_group_arnsArray<String>

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

Returns:

  • (Array<String>)


145
146
147
148
149
150
151
152
153
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 145

class CreateAgentRequest < Struct.new(
  :activation_key,
  :agent_name,
  :tags,
  :vpc_endpoint_id,
  :subnet_arns,
  :security_group_arns)
  include Aws::Structure
end

#subnet_arnsArray<String>

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create Elastic Network Interfaces (ENIs) 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 ENIs for each task in your subnet. For a data transfer to work, the agent must be able to route to all these four ENIs.

Returns:

  • (Array<String>)


145
146
147
148
149
150
151
152
153
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 145

class CreateAgentRequest < Struct.new(
  :activation_key,
  :agent_name,
  :tags,
  :vpc_endpoint_id,
  :subnet_arns,
  :security_group_arns)
  include Aws::Structure
end

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

Returns:



145
146
147
148
149
150
151
152
153
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 145

class CreateAgentRequest < Struct.new(
  :activation_key,
  :agent_name,
  :tags,
  :vpc_endpoint_id,
  :subnet_arns,
  :security_group_arns)
  include Aws::Structure
end

#vpc_endpoint_idString

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 AWS VPC User Guide.

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

Returns:

  • (String)


145
146
147
148
149
150
151
152
153
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 145

class CreateAgentRequest < Struct.new(
  :activation_key,
  :agent_name,
  :tags,
  :vpc_endpoint_id,
  :subnet_arns,
  :security_group_arns)
  include Aws::Structure
end