CfnLinkPropsMixin
- class aws_cdk.mixins_preview.aws_rtbfabric.mixins.CfnLinkPropsMixin(props, *, strategy=None)
Bases:
MixinCreates 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
- Mixin:
true
- 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.mixins_preview import mixins from aws_cdk.mixins_preview.aws_rtbfabric import mixins as rtbfabric_mixins cfn_link_props_mixin = rtbfabric_mixins.CfnLinkPropsMixin(rtbfabric_mixins.CfnLinkMixinProps( gateway_id="gatewayId", http_responder_allowed=False, link_attributes=rtbfabric_mixins.CfnLinkPropsMixin.LinkAttributesProperty( customer_provided_id="customerProvidedId", responder_error_masking=[rtbfabric_mixins.CfnLinkPropsMixin.ResponderErrorMaskingForHttpCodeProperty( action="action", http_code="httpCode", logging_types=["loggingTypes"], response_logging_percentage=123 )] ), link_log_settings=rtbfabric_mixins.CfnLinkPropsMixin.LinkLogSettingsProperty( application_logs=rtbfabric_mixins.CfnLinkPropsMixin.ApplicationLogsProperty( link_application_log_sampling=rtbfabric_mixins.CfnLinkPropsMixin.LinkApplicationLogSamplingProperty( error_log=123, filter_log=123 ) ) ), module_configuration_list=[rtbfabric_mixins.CfnLinkPropsMixin.ModuleConfigurationProperty( depends_on=["dependsOn"], module_parameters=rtbfabric_mixins.CfnLinkPropsMixin.ModuleParametersProperty( no_bid=rtbfabric_mixins.CfnLinkPropsMixin.NoBidModuleParametersProperty( pass_through_percentage=123, reason="reason", reason_code=123 ), open_rtb_attribute=rtbfabric_mixins.CfnLinkPropsMixin.OpenRtbAttributeModuleParametersProperty( action=rtbfabric_mixins.CfnLinkPropsMixin.ActionProperty( header_tag=rtbfabric_mixins.CfnLinkPropsMixin.HeaderTagActionProperty( name="name", value="value" ), no_bid=rtbfabric_mixins.CfnLinkPropsMixin.NoBidActionProperty( no_bid_reason_code=123 ) ), filter_configuration=[rtbfabric_mixins.CfnLinkPropsMixin.FilterProperty( criteria=[rtbfabric_mixins.CfnLinkPropsMixin.FilterCriterionProperty( path="path", values=["values"] )] )], filter_type="filterType", holdback_percentage=123 ) ), name="name", version="version" )], peer_gateway_id="peerGatewayId", tags=[CfnTag( key="key", value="value" )] ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::RTBFabric::Link.- Parameters:
props (
Union[CfnLinkMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['gatewayId', 'httpResponderAllowed', 'linkAttributes', 'linkLogSettings', 'moduleConfigurationList', 'peerGatewayId', 'tags']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
ActionProperty
- class CfnLinkPropsMixin.ActionProperty(*, header_tag=None, no_bid=None)
Bases:
objectDescribes a bid action.
- Parameters:
header_tag (
Union[IResolvable,HeaderTagActionProperty,Dict[str,Any],None]) – Describes the header tag for a bid action.no_bid (
Union[IResolvable,NoBidActionProperty,Dict[str,Any],None]) – Describes the parameters of a no bid module.
- See:
- 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.mixins_preview.aws_rtbfabric import mixins as rtbfabric_mixins action_property = rtbfabric_mixins.CfnLinkPropsMixin.ActionProperty( header_tag=rtbfabric_mixins.CfnLinkPropsMixin.HeaderTagActionProperty( name="name", value="value" ), no_bid=rtbfabric_mixins.CfnLinkPropsMixin.NoBidActionProperty( no_bid_reason_code=123 ) )
Attributes
- header_tag
Describes the header tag for a bid action.
- no_bid
Describes the parameters of a no bid module.
ApplicationLogsProperty
- class CfnLinkPropsMixin.ApplicationLogsProperty(*, link_application_log_sampling=None)
Bases:
objectDescribes the configuration of a link application log.
- Parameters:
link_application_log_sampling (
Union[IResolvable,LinkApplicationLogSamplingProperty,Dict[str,Any],None]) – Describes a link application log sample.- See:
- 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.mixins_preview.aws_rtbfabric import mixins as rtbfabric_mixins application_logs_property = rtbfabric_mixins.CfnLinkPropsMixin.ApplicationLogsProperty( link_application_log_sampling=rtbfabric_mixins.CfnLinkPropsMixin.LinkApplicationLogSamplingProperty( error_log=123, filter_log=123 ) )
Attributes
- link_application_log_sampling
Describes a link application log sample.
FilterCriterionProperty
- class CfnLinkPropsMixin.FilterCriterionProperty(*, path=None, values=None)
Bases:
objectDescribes the criteria for a filter.
- Parameters:
path (
Optional[str]) – The path to filter.values (
Optional[Sequence[str]]) – The value to filter.
- See:
- 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.mixins_preview.aws_rtbfabric import mixins as rtbfabric_mixins filter_criterion_property = rtbfabric_mixins.CfnLinkPropsMixin.FilterCriterionProperty( path="path", values=["values"] )
Attributes
- path
The path to filter.
FilterProperty
- class CfnLinkPropsMixin.FilterProperty(*, criteria=None)
Bases:
objectDescribes the configuration of a filter.
- Parameters:
criteria (
Union[IResolvable,Sequence[Union[IResolvable,FilterCriterionProperty,Dict[str,Any]]],None]) – Describes the criteria for a filter.- See:
- 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.mixins_preview.aws_rtbfabric import mixins as rtbfabric_mixins filter_property = rtbfabric_mixins.CfnLinkPropsMixin.FilterProperty( criteria=[rtbfabric_mixins.CfnLinkPropsMixin.FilterCriterionProperty( path="path", values=["values"] )] )
Attributes
- criteria
Describes the criteria for a filter.
HeaderTagActionProperty
- class CfnLinkPropsMixin.HeaderTagActionProperty(*, name=None, value=None)
Bases:
objectDescribes the header tag for a bid action.
- Parameters:
name (
Optional[str]) – The name of the bid action.value (
Optional[str]) – The value of the bid action.
- See:
- 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.mixins_preview.aws_rtbfabric import mixins as rtbfabric_mixins header_tag_action_property = rtbfabric_mixins.CfnLinkPropsMixin.HeaderTagActionProperty( name="name", value="value" )
Attributes
- name
The name of the bid action.
- value
The value of the bid action.
LinkApplicationLogSamplingProperty
- class CfnLinkPropsMixin.LinkApplicationLogSamplingProperty(*, error_log=None, filter_log=None)
Bases:
objectDescribes a link application log sample.
- Parameters:
error_log (
Union[int,float,None]) – An error log entry.filter_log (
Union[int,float,None]) – A filter log entry.
- See:
- 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.mixins_preview.aws_rtbfabric import mixins as rtbfabric_mixins link_application_log_sampling_property = rtbfabric_mixins.CfnLinkPropsMixin.LinkApplicationLogSamplingProperty( error_log=123, filter_log=123 )
Attributes
- error_log
An error log entry.
LinkAttributesProperty
- class CfnLinkPropsMixin.LinkAttributesProperty(*, customer_provided_id=None, responder_error_masking=None)
Bases:
objectDescribes 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:
- 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.mixins_preview.aws_rtbfabric import mixins as rtbfabric_mixins link_attributes_property = rtbfabric_mixins.CfnLinkPropsMixin.LinkAttributesProperty( customer_provided_id="customerProvidedId", responder_error_masking=[rtbfabric_mixins.CfnLinkPropsMixin.ResponderErrorMaskingForHttpCodeProperty( action="action", http_code="httpCode", logging_types=["loggingTypes"], response_logging_percentage=123 )] )
Attributes
- customer_provided_id
The customer-provided unique identifier of the link.
- responder_error_masking
Describes the masking for HTTP error codes.
LinkLogSettingsProperty
- class CfnLinkPropsMixin.LinkLogSettingsProperty(*, application_logs=None)
Bases:
objectDescribes the settings for a link log.
- Parameters:
application_logs (
Union[IResolvable,ApplicationLogsProperty,Dict[str,Any],None]) – Describes the configuration of a link application log.- See:
- 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.mixins_preview.aws_rtbfabric import mixins as rtbfabric_mixins link_log_settings_property = rtbfabric_mixins.CfnLinkPropsMixin.LinkLogSettingsProperty( application_logs=rtbfabric_mixins.CfnLinkPropsMixin.ApplicationLogsProperty( link_application_log_sampling=rtbfabric_mixins.CfnLinkPropsMixin.LinkApplicationLogSamplingProperty( error_log=123, filter_log=123 ) ) )
Attributes
- application_logs
Describes the configuration of a link application log.
ModuleConfigurationProperty
- class CfnLinkPropsMixin.ModuleConfigurationProperty(*, depends_on=None, module_parameters=None, name=None, version=None)
Bases:
objectDescribes the configuration of a module.
- Parameters:
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.name (
Optional[str]) – The name of the module.version (
Optional[str]) – The version of the module.
- See:
- 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.mixins_preview.aws_rtbfabric import mixins as rtbfabric_mixins module_configuration_property = rtbfabric_mixins.CfnLinkPropsMixin.ModuleConfigurationProperty( depends_on=["dependsOn"], module_parameters=rtbfabric_mixins.CfnLinkPropsMixin.ModuleParametersProperty( no_bid=rtbfabric_mixins.CfnLinkPropsMixin.NoBidModuleParametersProperty( pass_through_percentage=123, reason="reason", reason_code=123 ), open_rtb_attribute=rtbfabric_mixins.CfnLinkPropsMixin.OpenRtbAttributeModuleParametersProperty( action=rtbfabric_mixins.CfnLinkPropsMixin.ActionProperty( header_tag=rtbfabric_mixins.CfnLinkPropsMixin.HeaderTagActionProperty( name="name", value="value" ), no_bid=rtbfabric_mixins.CfnLinkPropsMixin.NoBidActionProperty( no_bid_reason_code=123 ) ), filter_configuration=[rtbfabric_mixins.CfnLinkPropsMixin.FilterProperty( criteria=[rtbfabric_mixins.CfnLinkPropsMixin.FilterCriterionProperty( path="path", values=["values"] )] )], filter_type="filterType", holdback_percentage=123 ) ), name="name", version="version" )
Attributes
- depends_on
The dependencies of the module.
- module_parameters
Describes the parameters of a module.
- name
The name of the module.
ModuleParametersProperty
- class CfnLinkPropsMixin.ModuleParametersProperty(*, no_bid=None, open_rtb_attribute=None)
Bases:
objectDescribes 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:
- 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.mixins_preview.aws_rtbfabric import mixins as rtbfabric_mixins module_parameters_property = rtbfabric_mixins.CfnLinkPropsMixin.ModuleParametersProperty( no_bid=rtbfabric_mixins.CfnLinkPropsMixin.NoBidModuleParametersProperty( pass_through_percentage=123, reason="reason", reason_code=123 ), open_rtb_attribute=rtbfabric_mixins.CfnLinkPropsMixin.OpenRtbAttributeModuleParametersProperty( action=rtbfabric_mixins.CfnLinkPropsMixin.ActionProperty( header_tag=rtbfabric_mixins.CfnLinkPropsMixin.HeaderTagActionProperty( name="name", value="value" ), no_bid=rtbfabric_mixins.CfnLinkPropsMixin.NoBidActionProperty( no_bid_reason_code=123 ) ), filter_configuration=[rtbfabric_mixins.CfnLinkPropsMixin.FilterProperty( criteria=[rtbfabric_mixins.CfnLinkPropsMixin.FilterCriterionProperty( path="path", values=["values"] )] )], filter_type="filterType", holdback_percentage=123 ) )
Attributes
- no_bid
Describes the parameters of a no bid module.
- open_rtb_attribute
Describes the parameters of an open RTB attribute module.
NoBidActionProperty
- class CfnLinkPropsMixin.NoBidActionProperty(*, no_bid_reason_code=None)
Bases:
objectDescribes a no bid action.
- Parameters:
no_bid_reason_code (
Union[int,float,None]) – The reason code for the no bid action.- See:
- 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.mixins_preview.aws_rtbfabric import mixins as rtbfabric_mixins no_bid_action_property = rtbfabric_mixins.CfnLinkPropsMixin.NoBidActionProperty( no_bid_reason_code=123 )
Attributes
- no_bid_reason_code
The reason code for the no bid action.
NoBidModuleParametersProperty
- class CfnLinkPropsMixin.NoBidModuleParametersProperty(*, pass_through_percentage=None, reason=None, reason_code=None)
Bases:
objectDescribes 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:
- 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.mixins_preview.aws_rtbfabric import mixins as rtbfabric_mixins no_bid_module_parameters_property = rtbfabric_mixins.CfnLinkPropsMixin.NoBidModuleParametersProperty( pass_through_percentage=123, reason="reason", reason_code=123 )
Attributes
- pass_through_percentage
The pass through percentage.
- reason
The reason description.
OpenRtbAttributeModuleParametersProperty
- class CfnLinkPropsMixin.OpenRtbAttributeModuleParametersProperty(*, action=None, filter_configuration=None, filter_type=None, holdback_percentage=None)
Bases:
objectDescribes the parameters of an open RTB attribute module.
- Parameters:
action (
Union[IResolvable,ActionProperty,Dict[str,Any],None]) – Describes a bid action.filter_configuration (
Union[IResolvable,Sequence[Union[IResolvable,FilterProperty,Dict[str,Any]]],None]) – Describes the configuration of a filter.filter_type (
Optional[str]) – The filter type.holdback_percentage (
Union[int,float,None]) – The hold back percentage.
- See:
- 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.mixins_preview.aws_rtbfabric import mixins as rtbfabric_mixins open_rtb_attribute_module_parameters_property = rtbfabric_mixins.CfnLinkPropsMixin.OpenRtbAttributeModuleParametersProperty( action=rtbfabric_mixins.CfnLinkPropsMixin.ActionProperty( header_tag=rtbfabric_mixins.CfnLinkPropsMixin.HeaderTagActionProperty( name="name", value="value" ), no_bid=rtbfabric_mixins.CfnLinkPropsMixin.NoBidActionProperty( no_bid_reason_code=123 ) ), filter_configuration=[rtbfabric_mixins.CfnLinkPropsMixin.FilterProperty( criteria=[rtbfabric_mixins.CfnLinkPropsMixin.FilterCriterionProperty( path="path", values=["values"] )] )], filter_type="filterType", holdback_percentage=123 )
Attributes
- action
Describes a bid action.
- filter_configuration
Describes the configuration of a filter.
- filter_type
The filter type.
- holdback_percentage
The hold back percentage.
ResponderErrorMaskingForHttpCodeProperty
- class CfnLinkPropsMixin.ResponderErrorMaskingForHttpCodeProperty(*, action=None, http_code=None, logging_types=None, response_logging_percentage=None)
Bases:
objectDescribes the masking for HTTP error codes.
- Parameters:
action (
Optional[str]) – The action for the error..http_code (
Optional[str]) – The HTTP error code.logging_types (
Optional[Sequence[str]]) – The error log type.response_logging_percentage (
Union[int,float,None]) – The percentage of response logging.
- See:
- 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.mixins_preview.aws_rtbfabric import mixins as rtbfabric_mixins responder_error_masking_for_http_code_property = rtbfabric_mixins.CfnLinkPropsMixin.ResponderErrorMaskingForHttpCodeProperty( action="action", http_code="httpCode", logging_types=["loggingTypes"], response_logging_percentage=123 )
Attributes
- action
The action for the error..
- http_code
The HTTP error code.
- logging_types
The error log type.
- response_logging_percentage
The percentage of response logging.