software.amazon.awscdk.services.datasync

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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.757Z")
 @Stability(value=Stable)
public class CfnAgent
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DataSync::Agent`.

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")
         // 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	Class and Description
static class	CfnAgent.Builder A fluent builder for CfnAgent.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAgent(software.constructs.Construct scope, String id, CfnAgentProps props) Create a new `AWS::DataSync::Agent`.
protected	CfnAgent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAgent(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getActivationKey() `AWS::DataSync::Agent.ActivationKey`.
String	getAgentName() `AWS::DataSync::Agent.AgentName`.
String	getAttrAgentArn()
String	getAttrEndpointType()
protected Map<String,Object>	getCfnProperties()
List<String>	getSecurityGroupArns() `AWS::DataSync::Agent.SecurityGroupArns`.
List<String>	getSubnetArns() `AWS::DataSync::Agent.SubnetArns`.
TagManager	getTags() `AWS::DataSync::Agent.Tags`.
String	getVpcEndpointId() `AWS::DataSync::Agent.VpcEndpointId`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActivationKey(String value) `AWS::DataSync::Agent.ActivationKey`.
void	setAgentName(String value) `AWS::DataSync::Agent.AgentName`.
void	setSecurityGroupArns(List<String> value) `AWS::DataSync::Agent.SecurityGroupArns`.
void	setSubnetArns(List<String> value) `AWS::DataSync::Agent.SubnetArns`.
void	setVpcEndpointId(String value) `AWS::DataSync::Agent.VpcEndpointId`.

Methods inherited from class software.amazon.awscdk.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.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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAgent

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

CfnAgent

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

CfnAgent

@Stability(value=Stable)
public CfnAgent(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         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. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getActivationKey

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

`AWS::DataSync::Agent.ActivationKey`.

setActivationKey

@Stability(value=Stable)
public void setActivationKey(@NotNull
                                                      String value)

`AWS::DataSync::Agent.ActivationKey`.

getAgentName

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

`AWS::DataSync::Agent.AgentName`.

setAgentName

@Stability(value=Stable)
public void setAgentName(@Nullable
                                                  String value)

`AWS::DataSync::Agent.AgentName`.

getAttrAgentArn

@Stability(value=Stable)
 @NotNull
public String getAttrAgentArn()

getAttrEndpointType

@Stability(value=Stable)
 @NotNull
public String getAttrEndpointType()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getSecurityGroupArns

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

`AWS::DataSync::Agent.SecurityGroupArns`.

setSecurityGroupArns

@Stability(value=Stable)
public void setSecurityGroupArns(@Nullable
                                                          List<String> value)

`AWS::DataSync::Agent.SecurityGroupArns`.

getSubnetArns

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

`AWS::DataSync::Agent.SubnetArns`.

setSubnetArns

@Stability(value=Stable)
public void setSubnetArns(@Nullable
                                                   List<String> value)

`AWS::DataSync::Agent.SubnetArns`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::DataSync::Agent.Tags`.

getVpcEndpointId

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

`AWS::DataSync::Agent.VpcEndpointId`.

setVpcEndpointId

@Stability(value=Stable)
public void setVpcEndpointId(@Nullable
                                                      String value)

`AWS::DataSync::Agent.VpcEndpointId`.