projects

Creates, updates, deletes or gets a project resource or lists projects in a region

Overview

Name	projects
Type	Resource
Description	Resource Type definition for AWS::Evidently::Project
Id	awscc.evidently.projects

Fields

Name	Datatype	Description
arn	string
name	string
description	string
▶data_delivery	object	Destinations for data.
▶app_config_resource	object
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

For more information, see AWS::Evidently::Project.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, region
delete_resource	DELETE	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual project.

SELECT
  region,
  arn,
  name,
  description,
  data_delivery,
  app_config_resource,
  tags
FROM awscc.evidently.projects
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

INSERT example

Use the following StackQL query and manifest file to create a new project resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.evidently.projects (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.evidently.projects (
  Name,
  Description,
  DataDelivery,
  AppConfigResource,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ data_delivery }}',
  '{{ app_config_resource }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: project
    props:
      - name: name
        value: '{{ name }}'
      - name: description
        value: '{{ description }}'
      - name: data_delivery
        value:
          s3:
            bucket_name: '{{ bucket_name }}'
            prefix: '{{ prefix }}'
          log_group: '{{ log_group }}'
      - name: app_config_resource
        value:
          application_id: '{{ application_id }}'
          environment_id: '{{ environment_id }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a project resource, using stack-deploy.

/*+ update */
UPDATE awscc.evidently.projects
SET PatchDocument = string('{{ {
    "Description": description,
    "DataDelivery": data_delivery,
    "AppConfigResource": app_config_resource,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.evidently.projects
WHERE
  Identifier = '{{ arn }}' AND
  region = 'us-east-1';

Permissions

To operate on the projects resource, the following permissions are required:

Create

evidently:CreateProject,
evidently:GetProject,
logs:CreateLogDelivery,
logs:GetLogDelivery,
logs:ListLogDeliveries,
s3:PutBucketPolicy,
s3:GetBucketPolicy,
evidently:TagResource,
evidently:ExportProjectAsConfiguration,
appconfig:GetEnvironment,
appconfig:CreateConfigurationProfile,
appconfig:CreateHostedConfigurationVersion,
appconfig:CreateExtensionAssociation,
appconfig:TagResource,
iam:GetRole,
iam:CreateServiceLinkedRole

Read

evidently:GetProject,
logs:GetLogDelivery,
logs:ListLogDeliveries,
s3:GetBucketPolicy,
logs:DescribeResourcePolicies,
logs:DescribeLogGroups,
evidently:ListTagsForResource

Update

evidently:UpdateProject,
evidently:UpdateProjectDataDelivery,
logs:GetLogDelivery,
logs:UpdateLogDelivery,
logs:ListLogDeliveries,
s3:PutBucketPolicy,
s3:GetBucketPolicy,
logs:PutResourcePolicy,
logs:DescribeResourcePolicies,
logs:DescribeLogGroups,
evidently:TagResource,
evidently:UntagResource,
evidently:ListTagsForResource,
evidently:GetProject,
evidently:ExportProjectAsConfiguration,
appconfig:GetEnvironment,
appconfig:CreateConfigurationProfile,
appconfig:CreateHostedConfigurationVersion,
appconfig:CreateExtensionAssociation,
appconfig:TagResource,
iam:GetRole,
iam:CreateServiceLinkedRole

Delete

evidently:DeleteProject,
evidently:GetProject,
logs:CreateLogDelivery,
logs:GetLogDelivery,
logs:DeleteLogDelivery,
logs:ListLogDeliveries,
s3:GetBucketPolicy,
logs:DescribeResourcePolicies,
logs:DescribeLogGroups,
evidently:UntagResource,
appconfig:DeleteHostedConfigurationVersion,
appconfig:DeleteExtensionAssociation,
appconfig:DeleteConfigurationProfile