Package software.amazon.awscdk.services.rtbfabric

Class CfnLink

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.rtbfabric.CfnLink

All Implemented Interfaces:

IEnvironmentAware, IInspectable, ITaggableV2, ILinkRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-10T13:40:13.924Z")
@Stability(Stable)
public class CfnLink
extends CfnResource
implements IInspectable, ILinkRef, ITaggableV2

Resource Type definition for AWS::RTBFabric::Link Resource Type.

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.rtbfabric.*;
 CfnLink cfnLink = CfnLink.Builder.create(this, "MyCfnLink")
         .gatewayId("gatewayId")
         .linkLogSettings(LinkLogSettingsProperty.builder()
                 .applicationLogs(ApplicationLogsProperty.builder()
                         .linkApplicationLogSampling(LinkApplicationLogSamplingProperty.builder()
                                 .errorLog(123)
                                 .filterLog(123)
                                 .build())
                         .build())
                 .build())
         .peerGatewayId("peerGatewayId")
         // the properties below are optional
         .httpResponderAllowed(false)
         .linkAttributes(LinkAttributesProperty.builder()
                 .customerProvidedId("customerProvidedId")
                 .responderErrorMasking(List.of(ResponderErrorMaskingForHttpCodeProperty.builder()
                         .action("action")
                         .httpCode("httpCode")
                         .loggingTypes(List.of("loggingTypes"))
                         // the properties below are optional
                         .responseLoggingPercentage(123)
                         .build()))
                 .build())
         .moduleConfigurationList(List.of(ModuleConfigurationProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .dependsOn(List.of("dependsOn"))
                 .moduleParameters(ModuleParametersProperty.builder()
                         .noBid(NoBidModuleParametersProperty.builder()
                                 .passThroughPercentage(123)
                                 .reason("reason")
                                 .reasonCode(123)
                                 .build())
                         .openRtbAttribute(OpenRtbAttributeModuleParametersProperty.builder()
                                 .action(ActionProperty.builder()
                                         .headerTag(HeaderTagActionProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build())
                                         .noBid(NoBidActionProperty.builder()
                                                 .noBidReasonCode(123)
                                                 .build())
                                         .build())
                                 .filterConfiguration(List.of(FilterProperty.builder()
                                         .criteria(List.of(FilterCriterionProperty.builder()
                                                 .path("path")
                                                 .values(List.of("values"))
                                                 .build()))
                                         .build()))
                                 .filterType("filterType")
                                 .holdbackPercentage(123)
                                 .build())
                         .build())
                 .version("version")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-link.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnLink.ActionProperty	Example:
static interface	CfnLink.ApplicationLogsProperty	Example:
static final class	CfnLink.Builder	A fluent builder for CfnLink.
static interface	CfnLink.FilterCriterionProperty	Example:
static interface	CfnLink.FilterProperty	Example:
static interface	CfnLink.HeaderTagActionProperty	Example:
static interface	CfnLink.LinkApplicationLogSamplingProperty	Example:
static interface	CfnLink.LinkAttributesProperty	Example:
static interface	CfnLink.LinkLogSettingsProperty	Example:
static interface	CfnLink.ModuleConfigurationProperty	Example:
static interface	CfnLink.ModuleParametersProperty	Example:
static interface	CfnLink.NoBidActionProperty	Example:
static interface	CfnLink.NoBidModuleParametersProperty	Example:
static interface	CfnLink.OpenRtbAttributeModuleParametersProperty	Example:
static interface	CfnLink.ResponderErrorMaskingForHttpCodeProperty	Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rtbfabric.ILinkRef

ILinkRef.Jsii$Default, ILinkRef.Jsii$Proxy

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

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnLink(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnLink(software.amazon.jsii.JsiiObjectRef objRef)
	CfnLink(software.constructs.Construct scope, String id, CfnLinkProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()
String	getAttrCreatedTimestamp()
String	getAttrLinkDirection()
String	getAttrLinkId()
String	getAttrLinkStatus()
String	getAttrUpdatedTimestamp()
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getGatewayId()
Object	getHttpResponderAllowed()	Returns union: either Boolean or IResolvable
Object	getLinkAttributes()	Returns union: either IResolvable or CfnLink.LinkAttributesProperty
Object	getLinkLogSettings()	Returns union: either IResolvable or CfnLink.LinkLogSettingsProperty
LinkReference	getLinkRef()	A reference to a Link resource.
Object	getModuleConfigurationList()	Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnLink.ModuleConfigurationProperty>
String	getPeerGatewayId()
List<CfnTag>	getTags()	Tags to assign to the Link.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setGatewayId(String value)
void	setHttpResponderAllowed(Boolean value)
void	setHttpResponderAllowed(IResolvable value)
void	setLinkAttributes(IResolvable value)
void	setLinkAttributes(CfnLink.LinkAttributesProperty value)
void	setLinkLogSettings(IResolvable value)
void	setLinkLogSettings(CfnLink.LinkLogSettingsProperty value)
void	setModuleConfigurationList(List<Object> value)
void	setModuleConfigurationList(IResolvable value)
void	setPeerGatewayId(String value)
void	setTags(List<CfnTag> value)	Tags to assign to the Link.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnLink

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

CfnLink

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

CfnLink

@Stability(Stable)
public CfnLink(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnLinkProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

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

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

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

getAttrCreatedTimestamp

@Stability(Stable)
@NotNull
public String getAttrCreatedTimestamp()

getAttrLinkDirection

@Stability(Stable)
@NotNull
public String getAttrLinkDirection()

getAttrLinkId

@Stability(Stable)
@NotNull
public String getAttrLinkId()

getAttrLinkStatus

@Stability(Stable)
@NotNull
public String getAttrLinkStatus()

getAttrUpdatedTimestamp

@Stability(Stable)
@NotNull
public String getAttrUpdatedTimestamp()

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getLinkRef

@Stability(Stable)
@NotNull
public LinkReference getLinkRef()

A reference to a Link resource.

Specified by:

getLinkRef in interface ILinkRef

getGatewayId

@Stability(Stable)
@NotNull
public String getGatewayId()

setGatewayId

@Stability(Stable)
public void setGatewayId(@NotNull
 String value)

getLinkLogSettings

@Stability(Stable)
@NotNull
public Object getLinkLogSettings()

Returns union: either IResolvable or CfnLink.LinkLogSettingsProperty

setLinkLogSettings

@Stability(Stable)
public void setLinkLogSettings(@NotNull
 IResolvable value)

setLinkLogSettings

@Stability(Stable)
public void setLinkLogSettings(@NotNull
 CfnLink.LinkLogSettingsProperty value)

getPeerGatewayId

@Stability(Stable)
@NotNull
public String getPeerGatewayId()

setPeerGatewayId

@Stability(Stable)
public void setPeerGatewayId(@NotNull
 String value)

getHttpResponderAllowed

@Stability(Stable)
@Nullable
public Object getHttpResponderAllowed()

Returns union: either Boolean or IResolvable

setHttpResponderAllowed

@Stability(Stable)
public void setHttpResponderAllowed(@Nullable
 Boolean value)

setHttpResponderAllowed

@Stability(Stable)
public void setHttpResponderAllowed(@Nullable
 IResolvable value)

getLinkAttributes

@Stability(Stable)
@Nullable
public Object getLinkAttributes()

Returns union: either IResolvable or CfnLink.LinkAttributesProperty

setLinkAttributes

@Stability(Stable)
public void setLinkAttributes(@Nullable
 IResolvable value)

setLinkAttributes

@Stability(Stable)
public void setLinkAttributes(@Nullable
 CfnLink.LinkAttributesProperty value)

getModuleConfigurationList

@Stability(Stable)
@Nullable
public Object getModuleConfigurationList()

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnLink.ModuleConfigurationProperty>

setModuleConfigurationList

@Stability(Stable)
public void setModuleConfigurationList(@Nullable
 IResolvable value)

setModuleConfigurationList

@Stability(Stable)
public void setModuleConfigurationList(@Nullable
 List<Object> value)

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

Tags to assign to the Link.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

Tags to assign to the Link.