software.amazon.awscdk.services.transfer

Interface CfnAgreementProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAgreementProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:57.577Z")
 @Stability(value=Stable)
public interface CfnAgreementProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnAgreement`.

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.*;
 CfnAgreementProps cfnAgreementProps = CfnAgreementProps.builder()
         .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	Interface and Description
static class	CfnAgreementProps.Builder A builder for CfnAgreementProps
static class	CfnAgreementProps.Jsii$Proxy An implementation for CfnAgreementProps

Method Summary

Modifier and Type	Method and Description
static CfnAgreementProps.Builder	builder()
String	getAccessRole() `AWS::Transfer::Agreement.AccessRole`.
String	getBaseDirectory() `AWS::Transfer::Agreement.BaseDirectory`.
default String	getDescription() `AWS::Transfer::Agreement.Description`.
String	getLocalProfileId() `AWS::Transfer::Agreement.LocalProfileId`.
String	getPartnerProfileId() `AWS::Transfer::Agreement.PartnerProfileId`.
String	getServerId() `AWS::Transfer::Agreement.ServerId`.
default String	getStatus() `AWS::Transfer::Agreement.Status`.
default List<CfnTag>	getTags() `AWS::Transfer::Agreement.Tags`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAccessRole

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

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

getBaseDirectory

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

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

getLocalProfileId

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

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

getPartnerProfileId

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

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

getServerId

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

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

getDescription

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

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

getStatus

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

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

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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

builder

@Stability(value=Stable)
static CfnAgreementProps.Builder builder()

Returns:

a CfnAgreementProps.Builder of CfnAgreementProps