Interface ICfnAgentProps

Properties for defining a CfnAgent.

Namespace: Amazon.CDK.AWS.DataSync

Assembly: Amazon.CDK.AWS.DataSync.dll

Syntax (csharp)

public interface ICfnAgentProps

Syntax (vb)

Public Interface ICfnAgentProps

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DataSync;

CfnAgentProps cfnAgentProps = new CfnAgentProps {
    ActivationKey = "activationKey",

    // the properties below are optional
    AgentName = "agentName",
    SecurityGroupArns = new [] { "securityGroupArns" },
    SubnetArns = new [] { "subnetArns" },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    VpcEndpointId = "vpcEndpointId"
};

Synopsis

Properties

ActivationKey	Your agent activation key.
AgentName	The name you configured for your agent.
SecurityGroupArns	The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets.
SubnetArns	The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
Tags	The key-value pair that represents the tag that you want to associate with the agent.
VpcEndpointId	The ID of the virtual private cloud (VPC) endpoint that the agent has access to.

Properties

ActivationKey

Your agent activation key.

string ActivationKey { get; }

Property Value

System.String

Remarks

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 Creating and activating an agent in the AWS DataSync User Guide.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-activationkey

AgentName

The name you configured for your agent.

virtual string AgentName { get; }

Property Value

System.String

Remarks

This value is a text reference that is used to identify the agent in the console.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-agentname

SecurityGroupArns

The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets.

virtual string[] SecurityGroupArns { get; }

Property Value

System.String[]

Remarks

See SecurityGroupArns .

Pattern : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z-0-9]:[0-9]{12}:security-group/.$

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-securitygrouparns

SubnetArns

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.

virtual string[] SubnetArns { get; }

Property Value

System.String[]

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-subnetarns

Tags

The key-value pair that represents the tag that you want to associate with the agent.

virtual ICfnTag[] Tags { get; }

Property Value

ICfnTag[]

Remarks

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-tags

VpcEndpointId

The ID of the virtual private cloud (VPC) endpoint that the agent has access to.

virtual string VpcEndpointId { get; }

Property Value

System.String

Remarks

This is the client-side VPC endpoint, powered by AWS PrivateLink . If you don't have an AWS PrivateLink VPC endpoint, see AWS PrivateLink and VPC endpoints in the Amazon VPC User Guide .

For more information about activating your agent in a private network based on a VPC, see Using AWS DataSync in a Virtual Private Cloud in the AWS DataSync User Guide.

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-vpcendpointid