Class CfnAgent
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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();
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCreate a newAWS::DataSync::Agent
.CfnAgent
(Construct scope, String id, CfnAgentProps props) Create a newAWS::DataSync::Agent
.protected
CfnAgent
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnAgent
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionSpecifies your DataSync agent's activation key.Specifies a name for your agent.The Amazon Resource Name (ARN) of the agent.The type of endpoint that your agent is connected to.The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets.Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint.getTags()
Specifies labels that help you categorize, filter, and search for your AWS resources.The ID of the virtual private cloud (VPC) endpoint that the agent has access to.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setActivationKey
(String value) Specifies your DataSync agent's activation key.void
setAgentName
(String value) Specifies a name for your agent.void
setSecurityGroupArns
(List<String> value) The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets.void
setSubnetArns
(List<String> value) Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint.void
setVpcEndpointId
(String value) The ID of the virtual private cloud (VPC) endpoint that the agent has access to.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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 newAWS::DataSync::Agent
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
CfnAgent
Create a newAWS::DataSync::Agent
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
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
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
- Overrides:
getCfnProperties
in classCfnResource
-
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
Specifies your DataSync agent's activation key.If you don't have an activation key, see Activate your agent .
-
setActivationKey
Specifies your DataSync agent's activation key.If you don't have an activation key, see Activate your agent .
-
getAgentName
Specifies a name for your agent.You can see this name in the DataSync console.
-
setAgentName
Specifies a name for your agent.You can see this name in the DataSync console.
-
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
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
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
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
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
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
.
-