Class CfnProject
A CloudFormation AWS::Evidently::Project
.
Inherited Members
Namespace: Amazon.CDK.AWS.Evidently
Assembly: Amazon.CDK.AWS.Evidently.dll
Syntax (csharp)
public class CfnProject : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnProject
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Evidently;
var cfnProject = new CfnProject(this, "MyCfnProject", new CfnProjectProps {
Name = "name",
// the properties below are optional
AppConfigResource = new AppConfigResourceObjectProperty {
ApplicationId = "applicationId",
EnvironmentId = "environmentId"
},
DataDelivery = new DataDeliveryObjectProperty {
LogGroup = "logGroup",
S3 = new S3DestinationProperty {
BucketName = "bucketName",
// the properties below are optional
Prefix = "prefix"
}
},
Description = "description",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnProject(Construct, String, ICfnProjectProps) | Create a new |
CfnProject(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnProject(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AppConfigResource | Use this parameter if the project will use client-side evaluation powered by AWS AppConfig . |
AttrArn | The ARN of the project. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DataDelivery | A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so. |
Description | An optional description of the project. |
Name | The name for the project. |
Tags | Assigns one or more tags (key-value pairs) to the project. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnProject(Construct, String, ICfnProjectProps)
Create a new AWS::Evidently::Project
.
public CfnProject(Construct scope, string id, ICfnProjectProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnProjectProps
- resource properties.
CfnProject(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnProject(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnProject(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnProject(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AppConfigResource
Use this parameter if the project will use client-side evaluation powered by AWS AppConfig .
public virtual object AppConfigResource { get; set; }
Property Value
System.Object
Remarks
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.
AttrArn
The ARN of the project.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DataDelivery
A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so.
public virtual object DataDelivery { get; set; }
Property Value
System.Object
Remarks
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.
Description
An optional description of the project.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Name
The name for the project.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
It can include up to 127 characters.
Tags
Assigns one or more tags (key-value pairs) to the project.
public virtual TagManager Tags { get; }
Property Value
Remarks
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
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>