Class CfnAgent
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.datasync.CfnAgent
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-11T15:55:55.863Z")
@Stability(Stable)
public class CfnAgent
extends CfnResource
implements IInspectable, ITaggable
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();
- See Also:
-
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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnAgent
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnAgent
(software.amazon.jsii.JsiiObjectRef objRef) CfnAgent
(software.constructs.Construct scope, String id, CfnAgentProps props) -
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 your VPC service endpoint is located.getTags()
Tag Manager which manages the tags for this resource.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 your VPC service endpoint is located.void
setTagsRaw
(List<CfnTag> value) Specifies labels that help you categorize, filter, and search for your AWS resources.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.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
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 software.constructs.Construct scope, @NotNull String id, @Nullable CfnAgentProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties.
-
CfnAgent
@Stability(Stable) public CfnAgent(@NotNull software.constructs.Construct scope, @NotNull String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 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
Tag Manager which manages the tags for this resource. -
getActivationKey
Specifies your DataSync agent's activation key. -
setActivationKey
Specifies your DataSync agent's activation key. -
getAgentName
Specifies a name for your agent. -
setAgentName
Specifies a name for your agent. -
getSecurityGroupArns
The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets. -
setSecurityGroupArns
The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets. -
getSubnetArns
Specifies the ARN of the subnet where your VPC service endpoint is located. -
setSubnetArns
Specifies the ARN of the subnet where your VPC service endpoint is located. -
getTagsRaw
Specifies labels that help you categorize, filter, and search for your AWS resources. -
setTagsRaw
Specifies labels that help you categorize, filter, and search for your AWS resources. -
getVpcEndpointId
The ID of the virtual private cloud (VPC) endpoint that the agent has access to. -
setVpcEndpointId
The ID of the virtual private cloud (VPC) endpoint that the agent has access to.
-