Class: AWSCDK::Evidently::CfnProjectProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
evidently/cfn_project_props.rb

Overview

Properties for defining a CfnProject.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, app_config_resource: nil, data_delivery: nil, description: nil, tags: nil) ⇒ CfnProjectProps

Returns a new instance of CfnProjectProps.

Parameters:



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'evidently/cfn_project_props.rb', line 14

def initialize(name:, app_config_resource: nil, data_delivery: nil, description: nil, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @app_config_resource = app_config_resource.is_a?(Hash) ? ::AWSCDK::Evidently::CfnProject::AppConfigResourceObjectProperty.new(**app_config_resource.transform_keys(&:to_sym)) : app_config_resource
  Jsii::Type.check_type(@app_config_resource, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldmlkZW50bHkuQ2ZuUHJvamVjdC5BcHBDb25maWdSZXNvdXJjZU9iamVjdFByb3BlcnR5In1dfX0=")), "appConfigResource") unless @app_config_resource.nil?
  @data_delivery = data_delivery.is_a?(Hash) ? ::AWSCDK::Evidently::CfnProject::DataDeliveryObjectProperty.new(**data_delivery.transform_keys(&:to_sym)) : data_delivery
  Jsii::Type.check_type(@data_delivery, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldmlkZW50bHkuQ2ZuUHJvamVjdC5EYXRhRGVsaXZlcnlPYmplY3RQcm9wZXJ0eSJ9XX19")), "dataDelivery") unless @data_delivery.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#app_config_resource ⇒ AWSCDK::IResolvable, ... (readonly)

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.

Returns:

See Also:



44
45
46
 
# File 'evidently/cfn_project_props.rb', line 44

def app_config_resource
  @app_config_resource
end

#data_delivery ⇒ AWSCDK::IResolvable, ... (readonly)

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 and S3Destination in the same operation.

Returns:

See Also:



53
54
55
 
# File 'evidently/cfn_project_props.rb', line 53

def data_delivery
  @data_delivery
end

#description ⇒ String? (readonly)

An optional description of the project.

Returns:

  • (String, nil)

See Also:



58
59
60
 
# File 'evidently/cfn_project_props.rb', line 58

def description
  @description
end

#name ⇒ String (readonly)

The name for the project.

It can include up to 127 characters.

Returns:

  • (String)

See Also:



33
34
35
 
# File 'evidently/cfn_project_props.rb', line 33

def name
  @name
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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 .

Returns:

See Also:



71
72
73
 
# File 'evidently/cfn_project_props.rb', line 71

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



73
74
75
76
77
78
79
80
81
 
# File 'evidently/cfn_project_props.rb', line 73

def self.jsii_properties
  {
    :name => "name",
    :app_config_resource => "appConfigResource",
    :data_delivery => "dataDelivery",
    :description => "description",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
 
# File 'evidently/cfn_project_props.rb', line 83

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "appConfigResource" => @app_config_resource,
    "dataDelivery" => @data_delivery,
    "description" => @description,
    "tags" => @tags,
  })
  result.compact
end