@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-14T16:25:21.756Z") public class CfnProject extends CfnResource implements IInspectable
Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments. Use projects to group similar features together.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.evidently.*; CfnProject cfnProject = CfnProject.Builder.create(this, "MyCfnProject") .name("name") // the properties below are optional .appConfigResource(AppConfigResourceObjectProperty.builder() .applicationId("applicationId") .environmentId("environmentId") .build()) .dataDelivery(DataDeliveryObjectProperty.builder() .logGroup("logGroup") .s3(S3DestinationProperty.builder() .bucketName("bucketName") // the properties below are optional .prefix("prefix") .build()) .build()) .description("description") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
Modifier and Type | Class and Description |
---|---|
static interface |
CfnProject.AppConfigResourceObjectProperty
This is a structure that defines the configuration of how your application integrates with AWS AppConfig to run client-side evaluation.
|
static class |
CfnProject.Builder
A fluent builder for
CfnProject . |
static interface |
CfnProject.DataDeliveryObjectProperty
A structure that contains information about where Evidently is to store evaluation events for longer term storage.
|
static interface |
CfnProject.S3DestinationProperty
If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnProject(Construct scope,
java.lang.String id,
CfnProjectProps props)
Create a new `AWS::Evidently::Project`.
|
protected |
CfnProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnProject(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
getAppConfigResource()
Use this parameter if the project will use *client-side evaluation powered by AWS AppConfig* .
|
java.lang.String |
getAttrArn()
The ARN of the project.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getDataDelivery()
A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so.
|
java.lang.String |
getDescription()
An optional description of the project.
|
java.lang.String |
getName()
The name for the project.
|
TagManager |
getTags()
Assigns one or more tags (key-value pairs) to the project.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAppConfigResource(CfnProject.AppConfigResourceObjectProperty value)
Use this parameter if the project will use *client-side evaluation powered by AWS AppConfig* .
|
void |
setAppConfigResource(IResolvable value)
Use this parameter if the project will use *client-side evaluation powered by AWS AppConfig* .
|
void |
setDataDelivery(CfnProject.DataDeliveryObjectProperty value)
A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so.
|
void |
setDataDelivery(IResolvable value)
A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so.
|
void |
setDescription(java.lang.String value)
An optional description of the project.
|
void |
setName(java.lang.String value)
The name for the project.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnProject(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnProject(Construct scope, java.lang.String id, CfnProjectProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
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 .
public java.lang.String getName()
It can include up to 127 characters.
public void setName(java.lang.String value)
It can include up to 127 characters.
public java.lang.Object getAppConfigResource()
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.
public void setAppConfigResource(IResolvable value)
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.
public void setAppConfigResource(CfnProject.AppConfigResourceObjectProperty value)
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.
public java.lang.Object getDataDelivery()
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
and S3Destination
in the same operation.
public void setDataDelivery(IResolvable value)
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
and S3Destination
in the same operation.
public void setDataDelivery(CfnProject.DataDeliveryObjectProperty value)
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
and S3Destination
in the same operation.
public java.lang.String getDescription()
public void setDescription(java.lang.String value)