Class CfnAgent

The AWS::DataSync::Agent resource activates an AWS DataSync agent that you've deployed for storage discovery or data transfers.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnAgent

Implements

IInspectable

IAgentRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.DataSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAgent : CfnResource, IInspectable, IAgentRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnAgent Inherits CfnResource Implements IInspectable, IAgentRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

The activation process associates the agent with your AWS account .

For more information, see the following topics in the AWS DataSync User Guide :

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

CloudformationResource: AWS::DataSync::Agent

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 AWS::DataSync::Agent.

Properties

ActivationKey	Specifies your DataSync agent's activation key.
AgentName	Specifies a name for your agent.
AgentRef	A reference to a Agent resource.
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	The AWS::DataSync::Agent resource activates an AWS DataSync agent that you've deployed for storage discovery or data transfers.
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 your VPC service endpoint is located.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	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

ArnForAgent(IAgentRef)	The AWS::DataSync::Agent resource activates an AWS DataSync agent that you've deployed for storage discovery or data transfers.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnAgent(object)	Checks whether the given object is a CfnAgent.
RenderProperties(IDictionary<string, object>)	The AWS::DataSync::Agent resource activates an AWS DataSync agent that you've deployed for storage discovery or data transfers.

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 string

Construct identifier for this resource (unique in its scope).

props ICfnAgentProps

Resource properties.

Remarks

The activation process associates the agent with your AWS account .

For more information, see the following topics in the AWS DataSync User Guide :

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

CloudformationResource: AWS::DataSync::Agent

ExampleMetadata: fixture=_generated

Properties

ActivationKey

Specifies your DataSync agent's activation key.

public virtual string? ActivationKey { get; set; }

Property Value

string

Remarks

The activation process associates the agent with your AWS account .

For more information, see the following topics in the AWS DataSync User Guide :

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

CloudformationResource: AWS::DataSync::Agent

ExampleMetadata: fixture=_generated

AgentName

Specifies a name for your agent.

public virtual string? AgentName { get; set; }

Property Value

string

Remarks

The activation process associates the agent with your AWS account .

For more information, see the following topics in the AWS DataSync User Guide :

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

CloudformationResource: AWS::DataSync::Agent

ExampleMetadata: fixture=_generated

AgentRef

A reference to a Agent resource.

public virtual IAgentReference AgentRef { get; }

Property Value

IAgentReference

Remarks

The activation process associates the agent with your AWS account .

For more information, see the following topics in the AWS DataSync User Guide :

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

CloudformationResource: AWS::DataSync::Agent

ExampleMetadata: fixture=_generated

AttrAgentArn

The Amazon Resource Name (ARN) of the agent.

public virtual string AttrAgentArn { get; }

Property Value

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

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

string

Remarks

The activation process associates the agent with your AWS account .

For more information, see the following topics in the AWS DataSync User Guide :

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

CloudformationResource: AWS::DataSync::Agent

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::DataSync::Agent resource activates an AWS DataSync agent that you've deployed for storage discovery or data transfers.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

The activation process associates the agent with your AWS account .

For more information, see the following topics in the AWS DataSync User Guide :

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

CloudformationResource: AWS::DataSync::Agent

ExampleMetadata: fixture=_generated

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

string[]

Remarks

The activation process associates the agent with your AWS account .

For more information, see the following topics in the AWS DataSync User Guide :

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

CloudformationResource: AWS::DataSync::Agent

ExampleMetadata: fixture=_generated

SubnetArns

Specifies the ARN of the subnet where your VPC service endpoint is located.

public virtual string[]? SubnetArns { get; set; }

Property Value

string[]

Remarks

The activation process associates the agent with your AWS account .

For more information, see the following topics in the AWS DataSync User Guide :

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

CloudformationResource: AWS::DataSync::Agent

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

The activation process associates the agent with your AWS account .

For more information, see the following topics in the AWS DataSync User Guide :

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

CloudformationResource: AWS::DataSync::Agent

ExampleMetadata: fixture=_generated

TagsRaw

Specifies labels that help you categorize, filter, and search for your AWS resources.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

The activation process associates the agent with your AWS account .

For more information, see the following topics in the AWS DataSync User Guide :

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

CloudformationResource: AWS::DataSync::Agent

ExampleMetadata: fixture=_generated

VpcEndpointId

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

public virtual string? VpcEndpointId { get; set; }

Property Value

string

Remarks

The activation process associates the agent with your AWS account .

For more information, see the following topics in the AWS DataSync User Guide :

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

CloudformationResource: AWS::DataSync::Agent

ExampleMetadata: fixture=_generated

Methods

ArnForAgent(IAgentRef)

The AWS::DataSync::Agent resource activates an AWS DataSync agent that you've deployed for storage discovery or data transfers.

public static string ArnForAgent(IAgentRef resource)

Parameters

resource IAgentRef

Returns

string

Remarks

The activation process associates the agent with your AWS account .

For more information, see the following topics in the AWS DataSync User Guide :

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

CloudformationResource: AWS::DataSync::Agent

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"
             });

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.

Remarks

The activation process associates the agent with your AWS account .

For more information, see the following topics in the AWS DataSync User Guide :

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

CloudformationResource: AWS::DataSync::Agent

ExampleMetadata: fixture=_generated

IsCfnAgent(object)

Checks whether the given object is a CfnAgent.

public static bool IsCfnAgent(object x)

Parameters

x object

Returns

bool

Remarks

The activation process associates the agent with your AWS account .

For more information, see the following topics in the AWS DataSync User Guide :

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

CloudformationResource: AWS::DataSync::Agent

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::DataSync::Agent resource activates an AWS DataSync agent that you've deployed for storage discovery or data transfers.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

The activation process associates the agent with your AWS account .

For more information, see the following topics in the AWS DataSync User Guide :

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

CloudformationResource: AWS::DataSync::Agent

ExampleMetadata: fixture=_generated

Implements

IInspectable

IAgentRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable