CfnProject
- class aws_cdk.aws_evidently.CfnProject(scope, id, *, name, app_config_resource=None, data_delivery=None, description=None, tags=None)
Bases:
CfnResource
A CloudFormation
AWS::Evidently::Project
.Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments. Use projects to group similar features together.
- CloudformationResource:
AWS::Evidently::Project
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.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_project = evidently.CfnProject(self, "MyCfnProject", name="name", # the properties below are optional app_config_resource=evidently.CfnProject.AppConfigResourceObjectProperty( application_id="applicationId", environment_id="environmentId" ), data_delivery=evidently.CfnProject.DataDeliveryObjectProperty( log_group="logGroup", s3=evidently.CfnProject.S3DestinationProperty( bucket_name="bucketName", # the properties below are optional prefix="prefix" ) ), description="description", tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::Evidently::Project
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
name (
str
) – The name for the project. It can include up to 127 characters.app_config_resource (
Union
[IResolvable
,AppConfigResourceObjectProperty
,Dict
[str
,Any
],None
]) – Use this parameter if the project will use client-side evaluation powered by AWS AppConfig . Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation. This mitigates the latency and availability risks that come with an API call. For more information, see Use client-side evaluation - powered by AWS AppConfig . This parameter is a structure that contains information about the AWS AppConfig application that will be used as for client-side evaluation. To create a project that uses client-side evaluation, you must have theevidently:ExportProjectAsConfiguration
permission.data_delivery (
Union
[IResolvable
,DataDeliveryObjectProperty
,Dict
[str
,Any
],None
]) – A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so. If you choose not to store these events, Evidently deletes them after using them to produce metrics and other experiment results that you can view. You can’t specify bothCloudWatchLogs
andS3Destination
in the same operation.description (
Optional
[str
]) – An optional description of the project.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – Assigns one or more tags (key-value pairs) to the project. 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 project. 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
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 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
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
- 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::Project'
- app_config_resource
Use this parameter if the project will use client-side evaluation powered by AWS AppConfig .
Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation. This mitigates the latency and availability risks that come with an API call. For more information, see Use client-side evaluation - powered by AWS AppConfig .
This parameter is a structure that contains information about the AWS AppConfig application that will be used as for client-side evaluation.
To create a project that uses client-side evaluation, you must have the
evidently:ExportProjectAsConfiguration
permission.
- attr_arn
The ARN of the project.
For example,
arn:aws:evidently:us-west-2:0123455678912:project/myProject
- 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.
- data_delivery
A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so.
If you choose not to store these events, Evidently deletes them after using them to produce metrics and other experiment results that you can view.
You can’t specify both
CloudWatchLogs
andS3Destination
in the same operation.
- description
An optional description of the project.
- 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 project.
It can include up to 127 characters.
- node
The construct tree node associated with this construct.
- 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 project.
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 project.
For more information, see Tagging AWS resources .
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
AppConfigResourceObjectProperty
- class CfnProject.AppConfigResourceObjectProperty(*, application_id, environment_id)
Bases:
object
This is a structure that defines the configuration of how your application integrates with AWS AppConfig to run client-side evaluation.
- Parameters:
application_id (
str
) – The ID of the AWS AppConfig application to use for client-side evaluation.environment_id (
str
) – The ID of the AWS AppConfig environment to use for client-side evaluation.
- 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 app_config_resource_object_property = evidently.CfnProject.AppConfigResourceObjectProperty( application_id="applicationId", environment_id="environmentId" )
Attributes
- application_id
The ID of the AWS AppConfig application to use for client-side evaluation.
- environment_id
The ID of the AWS AppConfig environment to use for client-side evaluation.
DataDeliveryObjectProperty
- class CfnProject.DataDeliveryObjectProperty(*, log_group=None, s3=None)
Bases:
object
A structure that contains information about where Evidently is to store evaluation events for longer term storage.
- Parameters:
log_group (
Optional
[str
]) – If the project stores evaluation events in CloudWatch Logs , this structure stores the log group name.s3 (
Union
[IResolvable
,S3DestinationProperty
,Dict
[str
,Any
],None
]) – If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
- 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 data_delivery_object_property = evidently.CfnProject.DataDeliveryObjectProperty( log_group="logGroup", s3=evidently.CfnProject.S3DestinationProperty( bucket_name="bucketName", # the properties below are optional prefix="prefix" ) )
Attributes
- log_group
If the project stores evaluation events in CloudWatch Logs , this structure stores the log group name.
- s3
If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
S3DestinationProperty
- class CfnProject.S3DestinationProperty(*, bucket_name, prefix=None)
Bases:
object
If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
- Parameters:
bucket_name (
str
) – The name of the bucket in which Evidently stores evaluation events.prefix (
Optional
[str
]) – The bucket prefix in which Evidently stores evaluation events.
- 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 s3_destination_property = evidently.CfnProject.S3DestinationProperty( bucket_name="bucketName", # the properties below are optional prefix="prefix" )
Attributes
- bucket_name
The name of the bucket in which Evidently stores evaluation events.
- prefix
The bucket prefix in which Evidently stores evaluation events.