Package software.amazon.awscdk.services.datasync

Class CfnAgent

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.datasync.CfnAgent
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.164Z") @Stability(Stable) public class CfnAgent extends CfnResource implements IInspectable
A CloudFormation AWS::DataSync::Agent.

The AWS::DataSync::Agent resource activates an AWS DataSync agent that you've deployed for storage discovery or data transfers. The activation process associates the agent with your AWS account .

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

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.*;
 CfnAgent cfnAgent = CfnAgent.Builder.create(this, "MyCfnAgent")
         .activationKey("activationKey")
         .agentName("agentName")
         .securityGroupArns(List.of("securityGroupArns"))
         .subnetArns(List.of("subnetArns"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcEndpointId("vpcEndpointId")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAgent

      protected CfnAgent(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAgent

      protected CfnAgent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAgent

      @Stability(Stable) public CfnAgent(@NotNull Construct scope, @NotNull String id, @Nullable CfnAgentProps props)
      Create a new AWS::DataSync::Agent.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnAgent

      @Stability(Stable) public CfnAgent(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::DataSync::Agent.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAgentArn

      @Stability(Stable) @NotNull public String getAttrAgentArn()
      The Amazon Resource Name (ARN) of the agent.

      Use the ListAgents operation to return a list of agents for your account and AWS Region .

    • getAttrEndpointType

      @Stability(Stable) @NotNull public String getAttrEndpointType()
      The type of endpoint that your agent is connected to.

      If the endpoint is a VPC endpoint, the agent is not accessible over the public internet.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Specifies labels that help you categorize, filter, and search for your AWS resources.

      We recommend creating at least one tag for your agent.

    • getActivationKey

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

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

    • setActivationKey

      @Stability(Stable) public void setActivationKey(@Nullable String value)
      Specifies your DataSync agent's activation key.

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

    • getAgentName

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

      You can see this name in the DataSync console.

    • setAgentName

      @Stability(Stable) public void setAgentName(@Nullable String value)
      Specifies a name for your agent.

      You can see this name in the DataSync console.

    • getSecurityGroupArns

      @Stability(Stable) @Nullable public 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/.*$

    • setSecurityGroupArns

      @Stability(Stable) public void setSecurityGroupArns(@Nullable List<String> value)
      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 public 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.

    • setSubnetArns

      @Stability(Stable) public void setSubnetArns(@Nullable List<String> value)
      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.

    • getVpcEndpointId

      @Stability(Stable) @Nullable public 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 .

    • setVpcEndpointId

      @Stability(Stable) public void setVpcEndpointId(@Nullable String value)
      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 .