CfnLinkProps

class aws_cdk.aws_rtbfabric.CfnLinkProps(*, gateway_id, link_log_settings, peer_gateway_id, http_responder_allowed=None, link_attributes=None, module_configuration_list=None, tags=None)

Bases: object

Properties for defining a CfnLink.

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rtbfabric as rtbfabric

cfn_link_props = rtbfabric.CfnLinkProps(
    gateway_id="gatewayId",
    link_log_settings=rtbfabric.CfnLink.LinkLogSettingsProperty(
        application_logs=rtbfabric.CfnLink.ApplicationLogsProperty(
            link_application_log_sampling=rtbfabric.CfnLink.LinkApplicationLogSamplingProperty(
                error_log=123,
                filter_log=123
            )
        )
    ),
    peer_gateway_id="peerGatewayId",

    # the properties below are optional
    http_responder_allowed=False,
    link_attributes=rtbfabric.CfnLink.LinkAttributesProperty(
        customer_provided_id="customerProvidedId",
        responder_error_masking=[rtbfabric.CfnLink.ResponderErrorMaskingForHttpCodeProperty(
            action="action",
            http_code="httpCode",
            logging_types=["loggingTypes"],

            # the properties below are optional
            response_logging_percentage=123
        )]
    ),
    module_configuration_list=[rtbfabric.CfnLink.ModuleConfigurationProperty(
        name="name",

        # the properties below are optional
        depends_on=["dependsOn"],
        module_parameters=rtbfabric.CfnLink.ModuleParametersProperty(
            no_bid=rtbfabric.CfnLink.NoBidModuleParametersProperty(
                pass_through_percentage=123,
                reason="reason",
                reason_code=123
            ),
            open_rtb_attribute=rtbfabric.CfnLink.OpenRtbAttributeModuleParametersProperty(
                action=rtbfabric.CfnLink.ActionProperty(
                    header_tag=rtbfabric.CfnLink.HeaderTagActionProperty(
                        name="name",
                        value="value"
                    ),
                    no_bid=rtbfabric.CfnLink.NoBidActionProperty(
                        no_bid_reason_code=123
                    )
                ),
                filter_configuration=[rtbfabric.CfnLink.FilterProperty(
                    criteria=[rtbfabric.CfnLink.FilterCriterionProperty(
                        path="path",
                        values=["values"]
                    )]
                )],
                filter_type="filterType",
                holdback_percentage=123
            )
        ),
        version="version"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

gateway_id

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

Type:

see

http_responder_allowed

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

Type:

see

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

Type:

see

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

Type:

see

module_configuration_list

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

Type:

see

peer_gateway_id

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

Type:

see

tags

Tags to assign to the Link.

See:

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