Class CfnAgentProps
Properties for defining a CfnAgent
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.DataSync
Assembly: Amazon.CDK.AWS.DataSync.dll
Syntax (csharp)
public class CfnAgentProps : Object, ICfnAgentProps
Syntax (vb)
Public Class CfnAgentProps
Inherits Object
Implements 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;
var cfnAgentProps = new CfnAgentProps {
ActivationKey = "activationKey",
AgentName = "agentName",
SecurityGroupArns = new [] { "securityGroupArns" },
SubnetArns = new [] { "subnetArns" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VpcEndpointId = "vpcEndpointId"
};
Synopsis
Constructors
CfnAgentProps() |
Properties
ActivationKey | Specifies your DataSync agent's activation key. |
AgentName | Specifies a name for your agent. |
SecurityGroupArns | The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets. |
SubnetArns | Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint. |
Tags | Specifies labels that help you categorize, filter, and search for your AWS resources. |
VpcEndpointId | The ID of the virtual private cloud (VPC) endpoint that the agent has access to. |
Constructors
CfnAgentProps()
public CfnAgentProps()
Properties
ActivationKey
Specifies your DataSync agent's activation key.
public string ActivationKey { get; set; }
Property Value
System.String
Remarks
If you don't have an activation key, see Activate your agent .
AgentName
Specifies a name for your agent.
public string AgentName { get; set; }
Property Value
System.String
Remarks
You can see this name in the DataSync console.
SecurityGroupArns
The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets.
public string[] SecurityGroupArns { get; set; }
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/.$
SubnetArns
Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint.
public string[] SubnetArns { get; set; }
Property Value
System.String[]
Remarks
This is the subnet where DataSync creates and manages the network interfaces for your transfer.
Tags
Specifies labels that help you categorize, filter, and search for your AWS resources.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
We recommend creating at least one tag for your agent.
VpcEndpointId
The ID of the virtual private cloud (VPC) endpoint that the agent has access to.
public string VpcEndpointId { get; set; }
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
.