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

Inherits:

Struct

• Object
• Struct
• Aws::DataSync::Types::CreateAgentRequest

Defined in:

gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb

Overview

CreateAgentRequest

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #activation_key ⇒ String

  Specifies your DataSync agent's activation key.

• #agent_name ⇒ String

  Specifies a name for your agent.

• #security_group_arns ⇒ Array<String>

  Specifies the Amazon Resource Name (ARN) of the security group that allows traffic between your agent and VPC service endpoint.

• #subnet_arns ⇒ Array<String>

  Specifies the ARN of the subnet where DataSync creates the [network interfaces][1] that handle data transfer traffic for your tasks.

• #tags ⇒ Array<Types::TagListEntry>

  Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.

• #vpc_endpoint_id ⇒ String

  Specifies the ID of the [VPC service endpoint][1] that you're using.

Instance Attribute Details

#activation_key ⇒ String

Specifies your DataSync agent's activation key. If you don't have an activation key, see Activating your agent.

Returns:

• (String)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 212

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

#agent_name ⇒ String

Specifies a name for your agent. We recommend specifying a name that you can remember.

Returns:

• (String)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 212

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

#security_group_arns ⇒ Array<String>

Specifies the Amazon Resource Name (ARN) of the security group that allows traffic between your agent and VPC service endpoint. You can only specify one ARN.

The ARN must specify your own account, even when the security group was shared with you from the account that owns the VPC. The security group must belong to the same VPC as the subnet that you specify in SubnetArns.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 212

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

#subnet_arns ⇒ Array<String>

Specifies the ARN of the subnet where DataSync creates the network interfaces that handle data transfer traffic for your tasks. You can only specify one ARN.

The subnet doesn't have to be the subnet that contains your VPC service endpoint. The subnet can be one that another Amazon Web Services account shared with you through RAM, in which case the ARN must specify the account that owns the subnet. For more information, see Using a single VPC service endpoint across multiple subnets.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 212

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

#tags ⇒ Array<Types::TagListEntry>

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.

Returns:

• (Array<Types::TagListEntry>)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 212

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

#vpc_endpoint_id ⇒ String

Specifies the ID of the VPC service endpoint that you're using. For example, a VPC endpoint ID looks like vpce-01234d5aff67890e1.

The VPC service endpoint you use must include the DataSync service name (for example, com.amazonaws.us-east-2.datasync).

The endpoint ID is informational. DataSync doesn't verify it or use it to connect to your agent. For more information, see Using a single VPC service endpoint across multiple subnets.

Returns:

• (String)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 212

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