CfnAgentProps

class aws_cdk.aws_datasync.CfnAgentProps(*, activation_key=None, agent_name=None, security_group_arns=None, subnet_arns=None, tags=None, vpc_endpoint_id=None)

Bases: object

Properties for defining a CfnAgent.

Parameters:

  • activation_key (Optional[str]) – Specifies your DataSync agent’s activation key. If you don’t have an activation key, see Activating your agent .

  • agent_name (Optional[str]) – Specifies a name for your agent. We recommend specifying a name that you can remember.

  • security_group_arns (Optional[Sequence[str]]) – 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/.*$

  • subnet_arns (Optional[Sequence[str]]) – Specifies the ARN of the subnet where your VPC service endpoint is located. You can only specify one ARN.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least one tag for your agent.

  • vpc_endpoint_id (Optional[str]) – 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 .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datasync as datasync

cfn_agent_props = datasync.CfnAgentProps(
    activation_key="activationKey",
    agent_name="agentName",
    security_group_arns=["securityGroupArns"],
    subnet_arns=["subnetArns"],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_endpoint_id="vpcEndpointId"
)

Attributes

activation_key

Specifies your DataSync agent’s activation key.

If you don’t have an activation key, see Activating your agent .

See:

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

agent_name

Specifies a name for your agent.

We recommend specifying a name that you can remember.

See:

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

security_group_arns

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/.*$

See:

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

subnet_arns

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

You can only specify one ARN.

See:

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

tags

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

We recommend creating at least one tag for your agent.

See:

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

vpc_endpoint_id

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 .

See:

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