Interface CfnAgentProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.165Z") @Stability(Stable) public interface CfnAgentProps extends
Properties for defining a CfnAgent.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnAgentProps cfnAgentProps = CfnAgentProps.builder()
  • Method Details

    • getActivationKey

      @Stability(Stable) @Nullable default String getActivationKey()
      Specifies your DataSync agent's activation key.

      If you don't have an activation key, see Activate your agent .

    • getAgentName

      @Stability(Stable) @Nullable default String getAgentName()
      Specifies a name for your agent.

      You can see this name in the DataSync console.

    • getSecurityGroupArns

      @Stability(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(Stable) @Nullable default List<String> getSubnetArns()
      Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint.

      This is the subnet where DataSync creates and manages the network interfaces for your transfer.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      Specifies labels that help you categorize, filter, and search for your AWS resources.

      We recommend creating at least one tag for your agent.

    • getVpcEndpointId

      @Stability(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(Stable) static CfnAgentProps.Builder builder()
      a CfnAgentProps.Builder of CfnAgentProps