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 protects your task's [network interfaces][1] when [using a virtual private cloud (VPC) endpoint][2].

• #subnet_arns ⇒ Array<String>

  Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint.

• #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 endpoint that you want your agent to connect to.

Instance Attribute Details

#activation_key ⇒ String

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

Returns:

• (String)

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

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. You can see this name in the DataSync console.

Returns:

• (String)

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

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 protects your task's network interfaces when using a virtual private cloud (VPC) endpoint. You can only specify one ARN.

Returns:

• (Array<String>)

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

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 you want to run your DataSync task when using a VPC endpoint. This is the subnet where DataSync creates and manages the network interfaces for your transfer. You can only specify one ARN.

Returns:

• (Array<String>)

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

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 271

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 endpoint that you want your agent to connect to. For example, a VPC endpoint ID looks like vpce-01234d5aff67890e1.

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

Returns:

• (String)

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

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