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:
IInspectable, IEnvironmentAware, ILinkRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:16.988Z") @Stability(Stable) public class CfnLink extends CfnResource implements IInspectable, ILinkRef, ITaggableV2
Creates a new link between gateways.

Establishes a connection that allows gateways to communicate and exchange bid requests and responses.

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:

  • 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)
      Create a new AWS::RTBFabric::Link.

      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

    • arnForLink

      @Stability(Stable) @NotNull public static String arnForLink(@NotNull ILinkRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnLink

      @Stability(Stable) @NotNull public static Boolean isCfnLink(@NotNull Object x)
      Checks whether the given object is a CfnLink.

      Parameters:
      x - This parameter is required.

    • 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()
      The unique identifier of the link.

    • 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()
      The unique identifier of the gateway.

    • setGatewayId

      @Stability(Stable) public void setGatewayId(@NotNull String value)
      The unique identifier of the gateway.

    • getLinkLogSettings

      @Stability(Stable) @NotNull public Object getLinkLogSettings()
      Settings for the application logs.

      Returns union: either IResolvable or CfnLink.LinkLogSettingsProperty

    • setLinkLogSettings

      @Stability(Stable) public void setLinkLogSettings(@NotNull IResolvable value)
      Settings for the application logs.

    • setLinkLogSettings

      @Stability(Stable) public void setLinkLogSettings(@NotNull CfnLink.LinkLogSettingsProperty value)
      Settings for the application logs.

    • getPeerGatewayId

      @Stability(Stable) @NotNull public String getPeerGatewayId()
      The unique identifier of the peer gateway.

    • setPeerGatewayId

      @Stability(Stable) public void setPeerGatewayId(@NotNull String value)
      The unique identifier of the peer gateway.

    • getHttpResponderAllowed

      @Stability(Stable) @Nullable public Object getHttpResponderAllowed()
      Boolean to specify if an HTTP responder is allowed.

      Returns union: either Boolean or IResolvable

    • setHttpResponderAllowed

      @Stability(Stable) public void setHttpResponderAllowed(@Nullable Boolean value)
      Boolean to specify if an HTTP responder is allowed.

    • setHttpResponderAllowed

      @Stability(Stable) public void setHttpResponderAllowed(@Nullable IResolvable value)
      Boolean to specify if an HTTP responder is allowed.

    • getLinkAttributes

      @Stability(Stable) @Nullable public Object getLinkAttributes()
      Attributes of the link.

      Returns union: either IResolvable or CfnLink.LinkAttributesProperty

    • setLinkAttributes

      @Stability(Stable) public void setLinkAttributes(@Nullable IResolvable value)
      Attributes of the link.

    • setLinkAttributes

      @Stability(Stable) public void setLinkAttributes(@Nullable CfnLink.LinkAttributesProperty value)
      Attributes of the link.

    • 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()
      A map of the key-value pairs of the tag or tags to assign to the resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A map of the key-value pairs of the tag or tags to assign to the resource.