CfnFeature
- class aws_cdk.aws_evidently.CfnFeature(scope, id, *, name, project, variations, default_variation=None, description=None, entity_overrides=None, evaluation_strategy=None, tags=None)
Bases:
CfnResource
A CloudFormation
AWS::Evidently::Feature
.Creates or updates an Evidently feature that you want to launch or test. You can define up to five variations of a feature, and use these variations in your launches and experiments. A feature must be created in a project. For information about creating a project, see CreateProject .
- CloudformationResource:
AWS::Evidently::Feature
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_evidently as evidently cfn_feature = evidently.CfnFeature(self, "MyCfnFeature", name="name", project="project", variations=[evidently.CfnFeature.VariationObjectProperty( variation_name="variationName", # the properties below are optional boolean_value=False, double_value=123, long_value=123, string_value="stringValue" )], # the properties below are optional default_variation="defaultVariation", description="description", entity_overrides=[evidently.CfnFeature.EntityOverrideProperty( entity_id="entityId", variation="variation" )], evaluation_strategy="evaluationStrategy", tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::Evidently::Feature
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
name (
str
) – The name for the feature. It can include up to 127 characters.project (
str
) – The name or ARN of the project that is to contain the new feature.variations (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,VariationObjectProperty
,Dict
[str
,Any
]]]]) – An array of structures that contain the configuration of the feature’s different variations. EachVariationObject
in theVariations
array for a feature must have the same type of value (BooleanValue
,DoubleValue
,LongValue
orStringValue
).default_variation (
Optional
[str
]) – The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature. This variation must also be listed in theVariations
structure. If you omitDefaultVariation
, the first variation listed in theVariations
structure is used as the default variation.description (
Optional
[str
]) – An optional description of the feature.entity_overrides (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,EntityOverrideProperty
,Dict
[str
,Any
]]],None
]) – Specify users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.evaluation_strategy (
Optional
[str
]) – SpecifyALL_RULES
to activate the traffic allocation specified by any ongoing launches or experiments. SpecifyDEFAULT_VARIATION
to serve the default variation to all users instead.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – Assigns one or more tags (key-value pairs) to the feature. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don’t have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can associate as many as 50 tags with a feature. For more information, see Tagging AWS resources .
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_depends_on(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_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
)value (
Any
)
- See:
- Return type:
None
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 prefixpath
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 toaddOverride
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 intermdediate 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
).- Parameters:
policy (
Optional
[RemovalPolicy
])apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
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 resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
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.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
)- See:
- Return type:
Any
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
- 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
- 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::Evidently::Feature'
- attr_arn
The ARN of the feature.
For example,
arn:aws:evidently:us-west-2:0123455678912:project/myProject/feature/myFeature
.- CloudformationAttribute:
Arn
- 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.
- default_variation
The name of the variation to use as the default variation.
The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.
This variation must also be listed in the
Variations
structure.If you omit
DefaultVariation
, the first variation listed in theVariations
structure is used as the default variation.
- description
An optional description of the feature.
- entity_overrides
Specify users that should always be served a specific variation of a feature.
Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.
- evaluation_strategy
Specify
ALL_RULES
to activate the traffic allocation specified by any ongoing launches or experiments.Specify
DEFAULT_VARIATION
to serve the default variation to all users instead.
- 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.
- name
The name for the feature.
It can include up to 127 characters.
- node
The construct tree node associated with this construct.
- project
The name or ARN of the project that is to contain the new feature.
- 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
Assigns one or more tags (key-value pairs) to the feature.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don’t have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with a feature.
For more information, see Tagging AWS resources .
- variations
An array of structures that contain the configuration of the feature’s different variations.
Each
VariationObject
in theVariations
array for a feature must have the same type of value (BooleanValue
,DoubleValue
,LongValue
orStringValue
).
Static Methods
- 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_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct
)- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any
)- Return type:
bool
EntityOverrideProperty
- class CfnFeature.EntityOverrideProperty(*, entity_id=None, variation=None)
Bases:
object
A set of key-value pairs that specify users who should always be served a specific variation of a feature.
Each key specifies a user using their user ID, account ID, or some other identifier. The value specifies the name of the variation that the user is to be served.
- Parameters:
entity_id (
Optional
[str
]) – The entity ID to be served the variation specified inVariation
.variation (
Optional
[str
]) – The name of the variation to serve to the user session that matches theEntityId
.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_evidently as evidently entity_override_property = evidently.CfnFeature.EntityOverrideProperty( entity_id="entityId", variation="variation" )
Attributes
- entity_id
The entity ID to be served the variation specified in
Variation
.
- variation
The name of the variation to serve to the user session that matches the
EntityId
.
VariationObjectProperty
- class CfnFeature.VariationObjectProperty(*, variation_name, boolean_value=None, double_value=None, long_value=None, string_value=None)
Bases:
object
This structure contains the name and variation value of one variation of a feature.
It can contain only one of the following parameters:
BooleanValue
,DoubleValue
,LongValue
orStringValue
.- Parameters:
variation_name (
str
) – A name for the variation. It can include up to 127 characters.boolean_value (
Union
[bool
,IResolvable
,None
]) – The value assigned to this variation, if the variation type is boolean.double_value (
Union
[int
,float
,None
]) – The value assigned to this variation, if the variation type is a double.long_value (
Union
[int
,float
,None
]) – The value assigned to this variation, if the variation type is a long.string_value (
Optional
[str
]) – The value assigned to this variation, if the variation type is a string.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_evidently as evidently variation_object_property = evidently.CfnFeature.VariationObjectProperty( variation_name="variationName", # the properties below are optional boolean_value=False, double_value=123, long_value=123, string_value="stringValue" )
Attributes
- boolean_value
The value assigned to this variation, if the variation type is boolean.
- double_value
The value assigned to this variation, if the variation type is a double.
- long_value
The value assigned to this variation, if the variation type is a long.
- string_value
The value assigned to this variation, if the variation type is a string.
- variation_name
A name for the variation.
It can include up to 127 characters.