CfnLink

class aws_cdk.aws_rtbfabric.CfnLink(scope, id, *, gateway_id, link_log_settings, peer_gateway_id, http_responder_allowed=None, link_attributes=None, module_configuration_list=None, tags=None)

Bases: CfnResource

Creates a new link between gateways.

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-link.html
CloudformationResource:: AWS::RTBFabric::Link
ExampleMetadata:: fixture=_generated

Example:

from aws_cdk import CfnTag
# 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 = rtbfabric.CfnLink(self, "MyCfnLink",
    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"
    )]
)

Create a new AWS::RTBFabric::Link.

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
gateway_id (str) – The unique identifier of the gateway.
link_log_settings (Union[IResolvable, LinkLogSettingsProperty, Dict[str, Any]]) – Settings for the application logs.
peer_gateway_id (str) – The unique identifier of the peer gateway.
http_responder_allowed (Union[bool, IResolvable, None]) – Boolean to specify if an HTTP responder is allowed.
link_attributes (Union[IResolvable, LinkAttributesProperty, Dict[str, Any], None]) – Attributes of the link.
module_configuration_list (Union[IResolvable, Sequence[Union[IResolvable, ModuleConfigurationProperty, Dict[str, Any]]], None])
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A map of the key-value pairs of the tag or tags to assign to the resource.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:: target (CfnResource)
Deprecated:: use addDependency
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::RTBFabric::Link'

attr_arn

Arn

Type:: cloudformationAttribute

attr_created_timestamp

CreatedTimestamp

Type:: cloudformationAttribute

attr_link_direction

LinkDirection

Type:: cloudformationAttribute

attr_link_id

The unique identifier of the link.

CloudformationAttribute:: LinkId

attr_link_status

LinkStatus

Type:: cloudformationAttribute

attr_updated_timestamp

UpdatedTimestamp

Type:: cloudformationAttribute

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

env

gateway_id: The unique identifier of the gateway.

http_responder_allowed: Boolean to specify if an HTTP responder is allowed.

link_attributes: Attributes of the link.

link_log_settings: Settings for the application logs.

link_ref: A reference to a Link resource.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

module_configuration_list

node: The tree node.

peer_gateway_id: The unique identifier of the peer gateway.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

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

Static Methods

classmethod arn_for_link(resource)

Parameters:: resource (ILinkRef)
Return type:: str

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_link(x)

Checks whether the given object is a CfnLink.

Parameters:: x (Any)
Return type:: bool

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

ActionProperty

class CfnLink.ActionProperty(*, header_tag, no_bid)

Bases: object

Describes a bid action.

Parameters:

header_tag (Union[IResolvable, HeaderTagActionProperty, Dict[str, Any]]) – Describes the header tag for a bid action.
no_bid (Union[IResolvable, NoBidActionProperty, Dict[str, Any]]) – Describes the parameters of a no bid module.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-action.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

action_property = rtbfabric.CfnLink.ActionProperty(
    header_tag=rtbfabric.CfnLink.HeaderTagActionProperty(
        name="name",
        value="value"
    ),
    no_bid=rtbfabric.CfnLink.NoBidActionProperty(
        no_bid_reason_code=123
    )
)

Attributes

header_tag

Describes the header tag for a bid action.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-action.html#cfn-rtbfabric-link-action-headertag

no_bid

Describes the parameters of a no bid module.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-action.html#cfn-rtbfabric-link-action-nobid

ApplicationLogsProperty

class CfnLink.ApplicationLogsProperty(*, link_application_log_sampling)

Bases: object

Describes the configuration of a link application log.

Parameters:: link_application_log_sampling (Union[IResolvable, LinkApplicationLogSamplingProperty, Dict[str, Any]]) – Describes a link application log sample.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-applicationlogs.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

application_logs_property = rtbfabric.CfnLink.ApplicationLogsProperty(
    link_application_log_sampling=rtbfabric.CfnLink.LinkApplicationLogSamplingProperty(
        error_log=123,
        filter_log=123
    )
)

Attributes

link_application_log_sampling

Describes a link application log sample.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-applicationlogs.html#cfn-rtbfabric-link-applicationlogs-linkapplicationlogsampling

FilterCriterionProperty

class CfnLink.FilterCriterionProperty(*, path, values)

Bases: object

Describes the criteria for a filter.

Parameters:

path (str) – The path to filter.
values (Sequence[str]) – The value to filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-filtercriterion.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

filter_criterion_property = rtbfabric.CfnLink.FilterCriterionProperty(
    path="path",
    values=["values"]
)

Attributes

path

The path to filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-filtercriterion.html#cfn-rtbfabric-link-filtercriterion-path

values

The value to filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-filtercriterion.html#cfn-rtbfabric-link-filtercriterion-values

FilterProperty

class CfnLink.FilterProperty(*, criteria)

Bases: object

Describes the configuration of a filter.

Parameters:: criteria (Union[IResolvable, Sequence[Union[IResolvable, FilterCriterionProperty, Dict[str, Any]]]]) – Describes the criteria for a filter.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-filter.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

filter_property = rtbfabric.CfnLink.FilterProperty(
    criteria=[rtbfabric.CfnLink.FilterCriterionProperty(
        path="path",
        values=["values"]
    )]
)

Attributes

criteria

Describes the criteria for a filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-filter.html#cfn-rtbfabric-link-filter-criteria

HeaderTagActionProperty

class CfnLink.HeaderTagActionProperty(*, name, value)

Bases: object

Describes the header tag for a bid action.

Parameters:

name (str) – The name of the bid action.
value (str) – The value of the bid action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-headertagaction.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

header_tag_action_property = rtbfabric.CfnLink.HeaderTagActionProperty(
    name="name",
    value="value"
)

Attributes

name

The name of the bid action.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-headertagaction.html#cfn-rtbfabric-link-headertagaction-name

value

The value of the bid action.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-headertagaction.html#cfn-rtbfabric-link-headertagaction-value

LinkApplicationLogSamplingProperty

class CfnLink.LinkApplicationLogSamplingProperty(*, error_log, filter_log)

Bases: object

Describes a link application log sample.

Parameters:

error_log (Union[int, float]) – An error log entry.
filter_log (Union[int, float]) – A filter log entry.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-linkapplicationlogsampling.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

link_application_log_sampling_property = rtbfabric.CfnLink.LinkApplicationLogSamplingProperty(
    error_log=123,
    filter_log=123
)

Attributes

error_log

An error log entry.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-linkapplicationlogsampling.html#cfn-rtbfabric-link-linkapplicationlogsampling-errorlog

filter_log

A filter log entry.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-linkapplicationlogsampling.html#cfn-rtbfabric-link-linkapplicationlogsampling-filterlog

LinkAttributesProperty

class CfnLink.LinkAttributesProperty(*, customer_provided_id=None, responder_error_masking=None)

Bases: object

Describes the attributes of a link.

Parameters:

customer_provided_id (Optional[str]) – The customer-provided unique identifier of the link.
responder_error_masking (Union[IResolvable, Sequence[Union[IResolvable, ResponderErrorMaskingForHttpCodeProperty, Dict[str, Any]]], None]) – Describes the masking for HTTP error codes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-linkattributes.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

link_attributes_property = 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
    )]
)

Attributes

customer_provided_id

The customer-provided unique identifier of the link.

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

responder_error_masking

Describes the masking for HTTP error codes.

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

LinkLogSettingsProperty

class CfnLink.LinkLogSettingsProperty(*, application_logs)

Bases: object

Describes the settings for a link log.

Parameters:: application_logs (Union[IResolvable, ApplicationLogsProperty, Dict[str, Any]]) – Describes the configuration of a link application log.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-linklogsettings.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

link_log_settings_property = rtbfabric.CfnLink.LinkLogSettingsProperty(
    application_logs=rtbfabric.CfnLink.ApplicationLogsProperty(
        link_application_log_sampling=rtbfabric.CfnLink.LinkApplicationLogSamplingProperty(
            error_log=123,
            filter_log=123
        )
    )
)

Attributes

application_logs

Describes the configuration of a link application log.

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

ModuleConfigurationProperty

class CfnLink.ModuleConfigurationProperty(*, name, depends_on=None, module_parameters=None, version=None)

Bases: object

Describes the configuration of a module.

Parameters:

name (str) – The name of the module.
depends_on (Optional[Sequence[str]]) – The dependencies of the module.
module_parameters (Union[IResolvable, ModuleParametersProperty, Dict[str, Any], None]) – Describes the parameters of a module.
version (Optional[str]) – The version of the module.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-moduleconfiguration.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

module_configuration_property = 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"
)

Attributes

depends_on

The dependencies of the module.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-moduleconfiguration.html#cfn-rtbfabric-link-moduleconfiguration-dependson

module_parameters

Describes the parameters of a module.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-moduleconfiguration.html#cfn-rtbfabric-link-moduleconfiguration-moduleparameters

name

The name of the module.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-moduleconfiguration.html#cfn-rtbfabric-link-moduleconfiguration-name

version

The version of the module.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-moduleconfiguration.html#cfn-rtbfabric-link-moduleconfiguration-version

ModuleParametersProperty

class CfnLink.ModuleParametersProperty(*, no_bid=None, open_rtb_attribute=None)

Bases: object

Describes the parameters of a module.

Parameters:

no_bid (Union[IResolvable, NoBidModuleParametersProperty, Dict[str, Any], None]) – Describes the parameters of a no bid module.
open_rtb_attribute (Union[IResolvable, OpenRtbAttributeModuleParametersProperty, Dict[str, Any], None]) – Describes the parameters of an open RTB attribute module.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-moduleparameters.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

module_parameters_property = 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
    )
)

Attributes

no_bid

Describes the parameters of a no bid module.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-moduleparameters.html#cfn-rtbfabric-link-moduleparameters-nobid

open_rtb_attribute

Describes the parameters of an open RTB attribute module.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-moduleparameters.html#cfn-rtbfabric-link-moduleparameters-openrtbattribute

NoBidActionProperty

class CfnLink.NoBidActionProperty(*, no_bid_reason_code=None)

Bases: object

Describes a no bid action.

Parameters:: no_bid_reason_code (Union[int, float, None]) – The reason code for the no bid action.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-nobidaction.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

no_bid_action_property = rtbfabric.CfnLink.NoBidActionProperty(
    no_bid_reason_code=123
)

Attributes

no_bid_reason_code

The reason code for the no bid action.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-nobidaction.html#cfn-rtbfabric-link-nobidaction-nobidreasoncode

NoBidModuleParametersProperty

class CfnLink.NoBidModuleParametersProperty(*, pass_through_percentage=None, reason=None, reason_code=None)

Bases: object

Describes the parameters of a no bid module.

Parameters:

pass_through_percentage (Union[int, float, None]) – The pass through percentage.
reason (Optional[str]) – The reason description.
reason_code (Union[int, float, None]) – The reason code.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-nobidmoduleparameters.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

no_bid_module_parameters_property = rtbfabric.CfnLink.NoBidModuleParametersProperty(
    pass_through_percentage=123,
    reason="reason",
    reason_code=123
)

Attributes

pass_through_percentage

The pass through percentage.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-nobidmoduleparameters.html#cfn-rtbfabric-link-nobidmoduleparameters-passthroughpercentage

reason

The reason description.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-nobidmoduleparameters.html#cfn-rtbfabric-link-nobidmoduleparameters-reason

reason_code

The reason code.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-nobidmoduleparameters.html#cfn-rtbfabric-link-nobidmoduleparameters-reasoncode

OpenRtbAttributeModuleParametersProperty

class CfnLink.OpenRtbAttributeModuleParametersProperty(*, action, filter_configuration, filter_type, holdback_percentage)

Bases: object

Describes the parameters of an open RTB attribute module.

Parameters:

action (Union[IResolvable, ActionProperty, Dict[str, Any]]) – Describes a bid action.
filter_configuration (Union[IResolvable, Sequence[Union[IResolvable, FilterProperty, Dict[str, Any]]]]) – Describes the configuration of a filter.
filter_type (str) – The filter type.
holdback_percentage (Union[int, float]) – The hold back percentage.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-openrtbattributemoduleparameters.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

open_rtb_attribute_module_parameters_property = 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
)

Attributes

action

Describes a bid action.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-openrtbattributemoduleparameters.html#cfn-rtbfabric-link-openrtbattributemoduleparameters-action

filter_configuration

Describes the configuration of a filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-openrtbattributemoduleparameters.html#cfn-rtbfabric-link-openrtbattributemoduleparameters-filterconfiguration

filter_type

The filter type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-openrtbattributemoduleparameters.html#cfn-rtbfabric-link-openrtbattributemoduleparameters-filtertype

holdback_percentage

The hold back percentage.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-openrtbattributemoduleparameters.html#cfn-rtbfabric-link-openrtbattributemoduleparameters-holdbackpercentage

ResponderErrorMaskingForHttpCodeProperty

class CfnLink.ResponderErrorMaskingForHttpCodeProperty(*, action, http_code, logging_types, response_logging_percentage=None)

Bases: object

Describes the masking for HTTP error codes.

Parameters:

action (str) – The action for the error..
http_code (str) – The HTTP error code.
logging_types (Sequence[str]) – The error log type.
response_logging_percentage (Union[int, float, None]) – The percentage of response logging.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-respondererrormaskingforhttpcode.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

responder_error_masking_for_http_code_property = rtbfabric.CfnLink.ResponderErrorMaskingForHttpCodeProperty(
    action="action",
    http_code="httpCode",
    logging_types=["loggingTypes"],

    # the properties below are optional
    response_logging_percentage=123
)

Attributes

action

The action for the error..

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-respondererrormaskingforhttpcode.html#cfn-rtbfabric-link-respondererrormaskingforhttpcode-action

http_code

The HTTP error code.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-respondererrormaskingforhttpcode.html#cfn-rtbfabric-link-respondererrormaskingforhttpcode-httpcode

logging_types

The error log type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-respondererrormaskingforhttpcode.html#cfn-rtbfabric-link-respondererrormaskingforhttpcode-loggingtypes

response_logging_percentage

The percentage of response logging.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-link-respondererrormaskingforhttpcode.html#cfn-rtbfabric-link-respondererrormaskingforhttpcode-responseloggingpercentage