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

Inherits:

Struct

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

Includes:

Structure

Defined in:

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 your VPC service endpoint is located.

• #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] 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].

[1]: docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html

Returns:

• (String)

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

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 'lib/aws-sdk-datasync/types.rb', line 264

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.

Returns:

• (Array<String>)

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

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 your VPC service endpoint is located. You can only specify one ARN.

Returns:

• (Array<String>)

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

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 'lib/aws-sdk-datasync/types.rb', line 264

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`).

[1]: docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#datasync-in-vpc

Returns:

• (String)

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

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