Class CfnAgent
A CloudFormation AWS::DataSync::Agent
.
Inherited Members
Namespace: Amazon.CDK.AWS.DataSync
Assembly: Amazon.CDK.AWS.DataSync.dll
Syntax (csharp)
public class CfnAgent : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnAgent
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::DataSync::Agent
resource activates an AWS DataSync agent that you've deployed for storage discovery or data transfers. The activation process associates the agent with your AWS account .
For more information, see the following topics in the AWS DataSync User Guide :
CloudformationResource: AWS::DataSync::Agent
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 cfnAgent = new CfnAgent(this, "MyCfnAgent", new CfnAgentProps {
ActivationKey = "activationKey",
AgentName = "agentName",
SecurityGroupArns = new [] { "securityGroupArns" },
SubnetArns = new [] { "subnetArns" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VpcEndpointId = "vpcEndpointId"
});
Synopsis
Constructors
CfnAgent(Construct, String, ICfnAgentProps) | Create a new |
CfnAgent(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAgent(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ActivationKey | Specifies your DataSync agent's activation key. |
AgentName | Specifies a name for your agent. |
AttrAgentArn | The Amazon Resource Name (ARN) of the agent. |
AttrEndpointType | The type of endpoint that your agent is connected to. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnAgent(Construct, String, ICfnAgentProps)
Create a new AWS::DataSync::Agent
.
public CfnAgent(Construct scope, string id, ICfnAgentProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnAgentProps
- resource properties.
CfnAgent(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAgent(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAgent(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAgent(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ActivationKey
Specifies your DataSync agent's activation key.
public virtual 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 virtual string AgentName { get; set; }
Property Value
System.String
Remarks
You can see this name in the DataSync console.
AttrAgentArn
The Amazon Resource Name (ARN) of the agent.
public virtual string AttrAgentArn { get; }
Property Value
System.String
Remarks
Use the ListAgents
operation to return a list of agents for your account and AWS Region .
CloudformationAttribute: AgentArn
AttrEndpointType
The type of endpoint that your agent is connected to.
public virtual string AttrEndpointType { get; }
Property Value
System.String
Remarks
If the endpoint is a VPC endpoint, the agent is not accessible over the public internet.
CloudformationAttribute: EndpointType
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
SecurityGroupArns
The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets.
public virtual 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 virtual 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 virtual TagManager Tags { get; }
Property Value
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 virtual 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
.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>