Class CfnAnalysisTemplateProps

Properties for defining a CfnAnalysisTemplate.

Inheritance

object

CfnAnalysisTemplateProps

Implements

ICfnAnalysisTemplateProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AwsCleanrooms

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAnalysisTemplateProps : ICfnAnalysisTemplateProps

Syntax (vb)

Public Class CfnAnalysisTemplateProps Implements ICfnAnalysisTemplateProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.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_cleanrooms;

             var cfnAnalysisTemplateProps = new CfnAnalysisTemplateProps {
                 Format = "format",
                 MembershipIdentifier = "membershipIdentifier",
                 Name = "name",
                 Source = new AnalysisSourceProperty {
                     Artifacts = new AnalysisTemplateArtifactsProperty {
                         EntryPoint = new AnalysisTemplateArtifactProperty {
                             Location = new S3LocationProperty {
                                 Bucket = "bucket",
                                 Key = "key"
                             }
                         },
                         RoleArn = "roleArn",

                         // the properties below are optional
                         AdditionalArtifacts = new [] { new AnalysisTemplateArtifactProperty {
                             Location = new S3LocationProperty {
                                 Bucket = "bucket",
                                 Key = "key"
                             }
                         } }
                     },
                     Text = "text"
                 },

                 // the properties below are optional
                 AnalysisParameters = new [] { new AnalysisParameterProperty {
                     Name = "name",
                     Type = "type",

                     // the properties below are optional
                     DefaultValue = "defaultValue"
                 } },
                 Description = "description",
                 Schema = new AnalysisSchemaProperty {
                     ReferencedTables = new [] { "referencedTables" }
                 },
                 SourceMetadata = new AnalysisSourceMetadataProperty {
                     Artifacts = new AnalysisTemplateArtifactMetadataProperty {
                         EntryPointHash = new HashProperty {
                             Sha256 = "sha256"
                         },

                         // the properties below are optional
                         AdditionalArtifactHashes = new [] { new HashProperty {
                             Sha256 = "sha256"
                         } }
                     }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnAnalysisTemplateProps()

Properties for defining a CfnAnalysisTemplate.

Properties

AnalysisParameters	The parameters of the analysis template.
Description	The description of the analysis template.
Format	The format of the analysis template.
MembershipIdentifier	The identifier for a membership resource.
Name	The name of the analysis template.
Schema	The entire schema object.
Source	The source of the analysis template.
SourceMetadata	The source metadata for the analysis template.
Tags	An optional label that you can assign to a resource when you create it.

Constructors

CfnAnalysisTemplateProps()

Properties for defining a CfnAnalysisTemplate.

public CfnAnalysisTemplateProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.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_cleanrooms;

             var cfnAnalysisTemplateProps = new CfnAnalysisTemplateProps {
                 Format = "format",
                 MembershipIdentifier = "membershipIdentifier",
                 Name = "name",
                 Source = new AnalysisSourceProperty {
                     Artifacts = new AnalysisTemplateArtifactsProperty {
                         EntryPoint = new AnalysisTemplateArtifactProperty {
                             Location = new S3LocationProperty {
                                 Bucket = "bucket",
                                 Key = "key"
                             }
                         },
                         RoleArn = "roleArn",

                         // the properties below are optional
                         AdditionalArtifacts = new [] { new AnalysisTemplateArtifactProperty {
                             Location = new S3LocationProperty {
                                 Bucket = "bucket",
                                 Key = "key"
                             }
                         } }
                     },
                     Text = "text"
                 },

                 // the properties below are optional
                 AnalysisParameters = new [] { new AnalysisParameterProperty {
                     Name = "name",
                     Type = "type",

                     // the properties below are optional
                     DefaultValue = "defaultValue"
                 } },
                 Description = "description",
                 Schema = new AnalysisSchemaProperty {
                     ReferencedTables = new [] { "referencedTables" }
                 },
                 SourceMetadata = new AnalysisSourceMetadataProperty {
                     Artifacts = new AnalysisTemplateArtifactMetadataProperty {
                         EntryPointHash = new HashProperty {
                             Sha256 = "sha256"
                         },

                         // the properties below are optional
                         AdditionalArtifactHashes = new [] { new HashProperty {
                             Sha256 = "sha256"
                         } }
                     }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

AnalysisParameters

The parameters of the analysis template.

public object? AnalysisParameters { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-analysisparameters

Description

The description of the analysis template.

public string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-description

Format

The format of the analysis template.

public string Format { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-format

MembershipIdentifier

The identifier for a membership resource.

public string MembershipIdentifier { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-membershipidentifier

Name

The name of the analysis template.

public string Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-name

Schema

The entire schema object.

public object? Schema { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-schema

Source

The source of the analysis template.

public object Source { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-source

SourceMetadata

The source metadata for the analysis template.

public object? SourceMetadata { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-sourcemetadata

Tags

An optional label that you can assign to a resource when you create it.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-tags

Implements

ICfnAnalysisTemplateProps