Package software.amazon.awscdk.services.transfer

Interface AgreementReference

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AgreementReference.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:51.813Z")
@Stability(Stable)
public interface AgreementReference
extends software.amazon.jsii.JsiiSerializable

A reference to a Agreement resource.

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.*;
 AgreementReference agreementReference = AgreementReference.builder()
         .agreementArn("agreementArn")
         .agreementId("agreementId")
         .serverId("serverId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AgreementReference.Builder	A builder for AgreementReference
static final class	AgreementReference.Jsii$Proxy	An implementation for AgreementReference

Method Summary

Modifier and Type	Method	Description
static AgreementReference.Builder	builder()
String	getAgreementArn()	The ARN of the Agreement resource.
String	getAgreementId()	The AgreementId of the Agreement resource.
String	getServerId()	The ServerId of the Agreement resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAgreementArn

@Stability(Stable)
@NotNull
String getAgreementArn()

The ARN of the Agreement resource.

getAgreementId

@Stability(Stable)
@NotNull
String getAgreementId()

The AgreementId of the Agreement resource.

getServerId

@Stability(Stable)
@NotNull
String getServerId()

The ServerId of the Agreement resource.

builder

@Stability(Stable)
static AgreementReference.Builder builder()

Returns:

a AgreementReference.Builder of AgreementReference