Class CfnAnalysisTemplate

Creates a new analysis template.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnAnalysisTemplate
Inherited Members
Namespace: Amazon.CDK.AwsCleanrooms
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAnalysisTemplate : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnAnalysisTemplate
    Inherits CfnResource
    Implements IInspectable, ITaggableV2
Remarks

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

CloudformationResource: AWS::CleanRooms::AnalysisTemplate

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 cfnAnalysisTemplate = new CfnAnalysisTemplate(this, "MyCfnAnalysisTemplate", 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

CfnAnalysisTemplate(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnAnalysisTemplate(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnAnalysisTemplate(Construct, String, ICfnAnalysisTemplateProps)

Properties

AnalysisParameters

The parameters of the analysis template.
AttrAnalysisTemplateIdentifier

Returns the identifier for the analysis template.
AttrArn

Returns the Amazon Resource Name (ARN) of the analysis template.
AttrCollaborationArn

Returns the unique ARN for the analysis template’s associated collaboration.
AttrCollaborationIdentifier

Returns the unique ID for the associated collaboration of the analysis template.
AttrMembershipArn

Returns the Amazon Resource Name (ARN) of the member who created the analysis template.
AttrSchema
AttrSchemaReferencedTables
CdkTagManager

Tag Manager which manages the tags for this resource.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
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.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnAnalysisTemplate(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnAnalysisTemplate(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnAnalysisTemplate(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnAnalysisTemplate(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnAnalysisTemplate(Construct, String, ICfnAnalysisTemplateProps)

public CfnAnalysisTemplate(Construct scope, string id, ICfnAnalysisTemplateProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnAnalysisTemplateProps

Resource properties.

Properties

AnalysisParameters

The parameters of the analysis template.

public virtual object AnalysisParameters { get; set; }
Property Value

System.Object

AttrAnalysisTemplateIdentifier

Returns the identifier for the analysis template.

public virtual string AttrAnalysisTemplateIdentifier { get; }
Property Value

System.String

Remarks

Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

CloudformationAttribute: AnalysisTemplateIdentifier

AttrArn

Returns the Amazon Resource Name (ARN) of the analysis template.

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

Example: arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/analysistemplates/a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

CloudformationAttribute: Arn

AttrCollaborationArn

Returns the unique ARN for the analysis template’s associated collaboration.

public virtual string AttrCollaborationArn { get; }
Property Value

System.String

Remarks

Example: arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

CloudformationAttribute: CollaborationArn

AttrCollaborationIdentifier

Returns the unique ID for the associated collaboration of the analysis template.

public virtual string AttrCollaborationIdentifier { get; }
Property Value

System.String

Remarks

Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

CloudformationAttribute: CollaborationIdentifier

AttrMembershipArn

Returns the Amazon Resource Name (ARN) of the member who created the analysis template.

public virtual string AttrMembershipArn { get; }
Property Value

System.String

Remarks

Example: arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

CloudformationAttribute: MembershipArn

AttrSchema

public virtual IResolvable AttrSchema { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: Schema

AttrSchemaReferencedTables

public virtual string[] AttrSchemaReferencedTables { get; }
Property Value

System.String[]

Remarks

CloudformationAttribute: Schema.ReferencedTables

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

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

Description

The description of the analysis template.

public virtual string Description { get; set; }
Property Value

System.String

Format

The format of the analysis template.

public virtual string Format { get; set; }
Property Value

System.String

MembershipIdentifier

The identifier for a membership resource.

public virtual string MembershipIdentifier { get; set; }
Property Value

System.String

Name

The name of the analysis template.

public virtual string Name { get; set; }
Property Value

System.String

Schema

The entire schema object.

public virtual object Schema { get; set; }
Property Value

System.Object

Source

The source of the analysis template.

public virtual object Source { get; set; }
Property Value

System.Object

SourceMetadata

The source metadata for the analysis template.

public virtual object SourceMetadata { get; set; }
Property Value

System.Object

Tags

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

public virtual ICfnTag[] Tags { get; set; }
Property Value

ICfnTag[]

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>

Overrides

Implements