class CfnLaunch (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.Evidently.CfnLaunch`
Java	`software.amazon.awscdk.services.evidently.CfnLaunch`
Python	`aws_cdk.aws_evidently.CfnLaunch`
TypeScript	`@aws-cdk/aws-evidently` » `CfnLaunch`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::Evidently::Launch.

Creates or updates a launch of a given feature. Before you create a launch, you must create the feature to use for the launch.

You can use a launch to safely validate new features by serving them to a specified percentage of your users while you roll out the feature. You can monitor the performance of the new feature to help you decide when to ramp up traffic to more users. This helps you reduce risk and identify unintended consequences before you fully launch the feature.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as evidently from '@aws-cdk/aws-evidently';
const cfnLaunch = new evidently.CfnLaunch(this, 'MyCfnLaunch', {
  groups: [{
    feature: 'feature',
    groupName: 'groupName',
    variation: 'variation',

    // the properties below are optional
    description: 'description',
  }],
  name: 'name',
  project: 'project',
  scheduledSplitsConfig: [{
    groupWeights: [{
      groupName: 'groupName',
      splitWeight: 123,
    }],
    startTime: 'startTime',

    // the properties below are optional
    segmentOverrides: [{
      evaluationOrder: 123,
      segment: 'segment',
      weights: [{
        groupName: 'groupName',
        splitWeight: 123,
      }],
    }],
  }],

  // the properties below are optional
  description: 'description',
  executionStatus: {
    status: 'status',

    // the properties below are optional
    desiredState: 'desiredState',
    reason: 'reason',
  },
  metricMonitors: [{
    entityIdKey: 'entityIdKey',
    metricName: 'metricName',
    valueKey: 'valueKey',

    // the properties below are optional
    eventPattern: 'eventPattern',
    unitLabel: 'unitLabel',
  }],
  randomizationSalt: 'randomizationSalt',
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnLaunch(scope: Construct, id: string, props: CfnLaunchProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnLaunchProps — - resource properties.

Create a new AWS::Evidently::Launch.

Construct Props

Name	Type	Description
groups	`IResolvable` `\|` `IResolvable` `\|` `LaunchGroupObjectProperty[]`	An array of structures that contains the feature and variations that are to be used for the launch.
name	`string`	The name for the launch.
project	`string`	The name or ARN of the project that you want to create the launch in.
scheduledSplitsConfig	`IResolvable` `\|` `IResolvable` `\|` `StepConfigProperty[]`	An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
description?	`string`	An optional description for the launch.
executionStatus?	`IResolvable` `\|` `ExecutionStatusObjectProperty`	A structure that you can use to start and stop the launch.
metricMonitors?	`IResolvable` `\|` `IResolvable` `\|` `MetricDefinitionObjectProperty[]`	An array of structures that define the metrics that will be used to monitor the launch performance.
randomizationSalt?	`string`	When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served.
tags?	`CfnTag[]`	Assigns one or more tags (key-value pairs) to the launch.

groups

Type: IResolvable | IResolvable | LaunchGroupObjectProperty[]

An array of structures that contains the feature and variations that are to be used for the launch.

You can up to five launch groups in a launch.

name

Type: string

The name for the launch.

It can include up to 127 characters.

project

Type: string

The name or ARN of the project that you want to create the launch in.

scheduledSplitsConfig

Type: IResolvable | IResolvable | StepConfigProperty[]

An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

description?

Type: string (optional)

An optional description for the launch.

executionStatus?

Type: IResolvable | ExecutionStatusObjectProperty (optional)

A structure that you can use to start and stop the launch.

metricMonitors?

Type: IResolvable | IResolvable | MetricDefinitionObjectProperty[] (optional)

An array of structures that define the metrics that will be used to monitor the launch performance.

You can have up to three metric monitors in the array.

randomizationSalt?

Type: string (optional)

When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served.

This randomization ID is a combination of the entity ID and randomizationSalt . If you omit randomizationSalt , Evidently uses the launch name as the randomizationsSalt .

tags?

Type: CfnTag[] (optional)

Assigns one or more tags (key-value pairs) to the launch.

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 launch.

For more information, see Tagging AWS resources .

Properties

Name	Type	Description
attrArn	`string`	The ARN of the launch.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
groups	`IResolvable` `\|` `IResolvable` `\|` `LaunchGroupObjectProperty[]`	An array of structures that contains the feature and variations that are to be used for the launch.
logicalId	`string`	The logical ID for this CloudFormation stack element.
name	`string`	The name for the launch.
node	`ConstructNode`	The construct tree node associated with this construct.
project	`string`	The name or ARN of the project that you want to create the launch in.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
scheduledSplitsConfig	`IResolvable` `\|` `IResolvable` `\|` `StepConfigProperty[]`	An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Assigns one or more tags (key-value pairs) to the launch.
description?	`string`	An optional description for the launch.
executionStatus?	`IResolvable` `\|` `ExecutionStatusObjectProperty`	A structure that you can use to start and stop the launch.
metricMonitors?	`IResolvable` `\|` `IResolvable` `\|` `MetricDefinitionObjectProperty[]`	An array of structures that define the metrics that will be used to monitor the launch performance.
randomizationSalt?	`string`	When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrArn

Type: string

The ARN of the launch.

For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/launch/myLaunch

cfnOptions

Type: ICfnResourceOptions

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

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

groups

Type: IResolvable | IResolvable | LaunchGroupObjectProperty[]

An array of structures that contains the feature and variations that are to be used for the launch.

You can up to five launch groups in a launch.

logicalId

Type: string

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).

name

Type: string

The name for the launch.

It can include up to 127 characters.

node

Type: ConstructNode

The construct tree node associated with this construct.

project

Type: string

The name or ARN of the project that you want to create the launch in.

ref

Type: string

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 }).

scheduledSplitsConfig

Type: IResolvable | IResolvable | StepConfigProperty[]

An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

stack

Type: Stack

The stack in which this element is defined.

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

description?

Type: string (optional)

An optional description for the launch.

executionStatus?

Type: IResolvable | ExecutionStatusObjectProperty (optional)

A structure that you can use to start and stop the launch.

metricMonitors?

Type: IResolvable | IResolvable | MetricDefinitionObjectProperty[] (optional)

An array of structures that define the metrics that will be used to monitor the launch performance.

You can have up to three metric monitors in the array.

randomizationSalt?

Type: string (optional)

When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served.

This randomization ID is a combination of the entity ID and randomizationSalt . If you omit randomizationSalt , Evidently uses the launch name as the randomizationsSalt .

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

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.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

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.](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.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The 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,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"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.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

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

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

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

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

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).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

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.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

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)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

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

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }