interface CfnLinkProps

Language	Type name
.NET	Amazon.CDK.AWS.RTBFabric.CfnLinkProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsrtbfabric#CfnLinkProps
Java	software.amazon.awscdk.services.rtbfabric.CfnLinkProps
Python	aws_cdk.aws_rtbfabric.CfnLinkProps
TypeScript	aws-cdk-lib » aws_rtbfabric » CfnLinkProps

Properties for defining a CfnLink.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_rtbfabric as rtbfabric } from 'aws-cdk-lib';
const cfnLinkProps: rtbfabric.CfnLinkProps = {
  gatewayId: 'gatewayId',
  linkLogSettings: {
    applicationLogs: {
      linkApplicationLogSampling: {
        errorLog: 123,
        filterLog: 123,
      },
    },
  },
  peerGatewayId: 'peerGatewayId',

  // the properties below are optional
  httpResponderAllowed: false,
  linkAttributes: {
    customerProvidedId: 'customerProvidedId',
    responderErrorMasking: [{
      action: 'action',
      httpCode: 'httpCode',
      loggingTypes: ['loggingTypes'],

      // the properties below are optional
      responseLoggingPercentage: 123,
    }],
  },
  moduleConfigurationList: [{
    name: 'name',

    // the properties below are optional
    dependsOn: ['dependsOn'],
    moduleParameters: {
      noBid: {
        passThroughPercentage: 123,
        reason: 'reason',
        reasonCode: 123,
      },
      openRtbAttribute: {
        action: {
          headerTag: {
            name: 'name',
            value: 'value',
          },
          noBid: {
            noBidReasonCode: 123,
          },
        },
        filterConfiguration: [{
          criteria: [{
            path: 'path',
            values: ['values'],
          }],
        }],
        filterType: 'filterType',
        holdbackPercentage: 123,
      },
    },
    version: 'version',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
gatewayId	string	The unique identifier of the gateway.
linkLogSettings	IResolvable | LinkLogSettingsProperty	Settings for the application logs.
peerGatewayId	string	The unique identifier of the peer gateway.
httpResponderAllowed?	boolean | IResolvable	Boolean to specify if an HTTP responder is allowed.
linkAttributes?	IResolvable | LinkAttributesProperty	Attributes of the link.
moduleConfigurationList?	IResolvable | (IResolvable | ModuleConfigurationProperty)[]
tags?	CfnTag[]	A map of the key-value pairs of the tag or tags to assign to the resource.

---

gatewayId

Type: string

The unique identifier of the gateway.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-link.html#cfn-rtbfabric-link-gatewayid

---

linkLogSettings

Type: IResolvable | LinkLogSettingsProperty

Settings for the application logs.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-link.html#cfn-rtbfabric-link-linklogsettings

---

peerGatewayId

Type: string

The unique identifier of the peer gateway.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-link.html#cfn-rtbfabric-link-peergatewayid

---

httpResponderAllowed?

Type: boolean | IResolvable (optional)

Boolean to specify if an HTTP responder is allowed.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-link.html#cfn-rtbfabric-link-httpresponderallowed

---

linkAttributes?

Type: IResolvable | LinkAttributesProperty (optional)

Attributes of the link.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-link.html#cfn-rtbfabric-link-linkattributes

---

moduleConfigurationList?

Type: IResolvable | (IResolvable | ModuleConfigurationProperty)[] (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-link.html#cfn-rtbfabric-link-moduleconfigurationlist

---

tags?

Type: CfnTag[] (optional)

A map of the key-value pairs of the tag or tags to assign to the resource.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-link.html#cfn-rtbfabric-link-tags