software.amazon.awscdk.services.datasync

Interface CfnAgentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAgentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.862Z")
 @Stability(value=Stable)
public interface CfnAgentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnAgent`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.datasync.*;
 CfnAgentProps cfnAgentProps = CfnAgentProps.builder()
         .activationKey("activationKey")
         // the properties below are optional
         .agentName("agentName")
         .securityGroupArns(List.of("securityGroupArns"))
         .subnetArns(List.of("subnetArns"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcEndpointId("vpcEndpointId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnAgentProps.Builder A builder for CfnAgentProps
static class	CfnAgentProps.Jsii$Proxy An implementation for CfnAgentProps

Method Summary

Modifier and Type	Method and Description
static CfnAgentProps.Builder	builder()
String	getActivationKey() Your agent activation key.
default String	getAgentName() The name you configured for your agent.
default List<String>	getSecurityGroupArns() The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets.
default List<String>	getSubnetArns() The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
default List<CfnTag>	getTags() The key-value pair that represents the tag that you want to associate with the agent.
default String	getVpcEndpointId() The ID of the virtual private cloud (VPC) endpoint that the agent has access to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getActivationKey

@Stability(value=Stable)
 @NotNull
String getActivationKey()

Your agent activation key.

You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the DataSync console.

The redirect URL returned in the response provides you the activation key for your agent in the query string parameter activationKey . It might also include other activation-related parameters; however, these are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent.

For more information, see Creating and activating an agent in the AWS DataSync User Guide.

getAgentName

@Stability(value=Stable)
 @Nullable
default String getAgentName()

The name you configured for your agent.

This value is a text reference that is used to identify the agent in the console.

getSecurityGroupArns

@Stability(value=Stable)
 @Nullable
default List<String> getSecurityGroupArns()

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

getSubnetArns

@Stability(value=Stable)
 @Nullable
default List<String> getSubnetArns()

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.

The agent that runs a task must be private. When you start a task that is associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this case, DataSync creates four network interfaces for each task in your subnet. For a data transfer to work, the agent must be able to route to all these four network interfaces.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

The key-value pair that represents the tag that you want to associate with the agent.

The value can be an empty string. This value helps you manage, filter, and search for your agents.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.

getVpcEndpointId

@Stability(value=Stable)
 @Nullable
default String getVpcEndpointId()

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 .

builder

@Stability(value=Stable)
static CfnAgentProps.Builder builder()

Returns:

a CfnAgentProps.Builder of CfnAgentProps