interface CfnAgentProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.DataSync.CfnAgentProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsdatasync#CfnAgentProps |
![]() | software.amazon.awscdk.services.datasync.CfnAgentProps |
![]() | aws_cdk.aws_datasync.CfnAgentProps |
![]() | aws-cdk-lib » aws_datasync » CfnAgentProps |
Properties for defining a CfnAgent
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_datasync as datasync } from 'aws-cdk-lib';
const cfnAgentProps: datasync.CfnAgentProps = {
activationKey: 'activationKey',
agentName: 'agentName',
securityGroupArns: ['securityGroupArns'],
subnetArns: ['subnetArns'],
tags: [{
key: 'key',
value: 'value',
}],
vpcEndpointId: 'vpcEndpointId',
};
Properties
Name | Type | Description |
---|---|---|
activation | string | Specifies your DataSync agent's activation key. |
agent | string | Specifies a name for your agent. |
security | string[] | The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets. |
subnet | string[] | Specifies the ARN of the subnet where your VPC service endpoint is located. |
tags? | Cfn [] | Specifies labels that help you categorize, filter, and search for your AWS resources. |
vpc | string | The ID of the virtual private cloud (VPC) endpoint that the agent has access to. |
activationKey?
Type:
string
(optional)
Specifies your DataSync agent's activation key.
If you don't have an activation key, see Activating your agent .
agentName?
Type:
string
(optional)
Specifies a name for your agent.
We recommend specifying a name that you can remember.
securityGroupArns?
Type:
string[]
(optional)
The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets.
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?
Type:
string[]
(optional)
Specifies the ARN of the subnet where your VPC service endpoint is located.
You can only specify one ARN.
tags?
Type:
Cfn
[]
(optional)
Specifies labels that help you categorize, filter, and search for your AWS resources.
We recommend creating at least one tag for your agent.
vpcEndpointId?
Type:
string
(optional)
The ID of the virtual private cloud (VPC) endpoint that the agent has access to.
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
.