Show / Hide Table of Contents

Interface ICfnAnalysisTemplateProps

Properties for defining a CfnAnalysisTemplate.

Namespace: Amazon.CDK.AwsCleanrooms
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnAnalysisTemplateProps
Syntax (vb)
Public Interface 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

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.

Properties

AnalysisParameters

The parameters of the analysis template.

object? AnalysisParameters { get; }
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.

string? Description { get; }
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.

string Format { get; }
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.

string MembershipIdentifier { get; }
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.

string Name { get; }
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.

object? Schema { get; }
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.

object Source { get; }
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.

object? SourceMetadata { get; }
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.

ICfnTag[]? Tags { get; }
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

Back to top Generated by DocFX