software.amazon.awscdk.services.transfer

Class CfnAgreement

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.transfer.CfnAgreement

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:57.576Z")
 @Stability(value=Stable)
public class CfnAgreement
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Transfer::Agreement`.

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.transfer.*;
 CfnAgreement cfnAgreement = CfnAgreement.Builder.create(this, "MyCfnAgreement")
         .accessRole("accessRole")
         .baseDirectory("baseDirectory")
         .localProfileId("localProfileId")
         .partnerProfileId("partnerProfileId")
         .serverId("serverId")
         // the properties below are optional
         .description("description")
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnAgreement.Builder A fluent builder for CfnAgreement.

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.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

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
	CfnAgreement(Construct scope, String id, CfnAgreementProps props) Create a new `AWS::Transfer::Agreement`.
protected	CfnAgreement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAgreement(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAccessRole() `AWS::Transfer::Agreement.AccessRole`.
String	getAttrAgreementId()
String	getAttrArn()
String	getBaseDirectory() `AWS::Transfer::Agreement.BaseDirectory`.
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::Transfer::Agreement.Description`.
String	getLocalProfileId() `AWS::Transfer::Agreement.LocalProfileId`.
String	getPartnerProfileId() `AWS::Transfer::Agreement.PartnerProfileId`.
String	getServerId() `AWS::Transfer::Agreement.ServerId`.
String	getStatus() `AWS::Transfer::Agreement.Status`.
TagManager	getTags() `AWS::Transfer::Agreement.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessRole(String value) `AWS::Transfer::Agreement.AccessRole`.
void	setBaseDirectory(String value) `AWS::Transfer::Agreement.BaseDirectory`.
void	setDescription(String value) `AWS::Transfer::Agreement.Description`.
void	setLocalProfileId(String value) `AWS::Transfer::Agreement.LocalProfileId`.
void	setPartnerProfileId(String value) `AWS::Transfer::Agreement.PartnerProfileId`.
void	setServerId(String value) `AWS::Transfer::Agreement.ServerId`.
void	setStatus(String value) `AWS::Transfer::Agreement.Status`.

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 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

CfnAgreement

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

CfnAgreement

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

CfnAgreement

@Stability(value=Stable)
public CfnAgreement(@NotNull
                                             Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             CfnAgreementProps props)

Create a new `AWS::Transfer::Agreement`.

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.

getAttrAgreementId

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

getAttrArn

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

`AWS::Transfer::Agreement.Tags`.

getAccessRole

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

`AWS::Transfer::Agreement.AccessRole`.

setAccessRole

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

`AWS::Transfer::Agreement.AccessRole`.

getBaseDirectory

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

`AWS::Transfer::Agreement.BaseDirectory`.

setBaseDirectory

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

`AWS::Transfer::Agreement.BaseDirectory`.

getLocalProfileId

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

`AWS::Transfer::Agreement.LocalProfileId`.

setLocalProfileId

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

`AWS::Transfer::Agreement.LocalProfileId`.

getPartnerProfileId

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

`AWS::Transfer::Agreement.PartnerProfileId`.

setPartnerProfileId

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

`AWS::Transfer::Agreement.PartnerProfileId`.

getServerId

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

`AWS::Transfer::Agreement.ServerId`.

setServerId

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

`AWS::Transfer::Agreement.ServerId`.

getDescription

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

`AWS::Transfer::Agreement.Description`.

setDescription

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

`AWS::Transfer::Agreement.Description`.

getStatus

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

`AWS::Transfer::Agreement.Status`.

setStatus

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

`AWS::Transfer::Agreement.Status`.