@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
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();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnAgreement.Builder
A fluent builder for
CfnAgreement. |
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$ProxyIConstruct.Jsii$Default| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| 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) |
| 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`.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdgetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validatejsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnAgreement(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnAgreement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnAgreement(@NotNull
Construct scope,
@NotNull
String id,
@NotNull
CfnAgreementProps props)
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.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrAgreementId()
@Stability(value=Stable) @NotNull public String getAttrArn()
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
@Stability(value=Stable) @NotNull public String getAccessRole()
@Stability(value=Stable)
public void setAccessRole(@NotNull
String value)
@Stability(value=Stable) @NotNull public String getBaseDirectory()
@Stability(value=Stable)
public void setBaseDirectory(@NotNull
String value)
@Stability(value=Stable) @NotNull public String getLocalProfileId()
@Stability(value=Stable)
public void setLocalProfileId(@NotNull
String value)
@Stability(value=Stable) @NotNull public String getPartnerProfileId()
@Stability(value=Stable)
public void setPartnerProfileId(@NotNull
String value)
@Stability(value=Stable) @NotNull public String getServerId()
@Stability(value=Stable)
public void setServerId(@NotNull
String value)
@Stability(value=Stable) @Nullable public String getDescription()
@Stability(value=Stable)
public void setDescription(@Nullable
String value)
@Stability(value=Stable) @Nullable public String getStatus()
@Stability(value=Stable)
public void setStatus(@Nullable
String value)
Copyright © 2022. All rights reserved.