Documentation ¶
Index ¶
- func CfnCollaboration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCollaboration_IsCfnElement(x interface{}) *bool
- func CfnCollaboration_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnCollaboration_IsConstruct(x interface{}) *bool
- func CfnConfiguredTableAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnConfiguredTableAssociation_IsCfnElement(x interface{}) *bool
- func CfnConfiguredTableAssociation_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnConfiguredTableAssociation_IsConstruct(x interface{}) *bool
- func CfnConfiguredTable_CFN_RESOURCE_TYPE_NAME() *string
- func CfnConfiguredTable_IsCfnElement(x interface{}) *bool
- func CfnConfiguredTable_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnConfiguredTable_IsConstruct(x interface{}) *bool
- func CfnMembership_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMembership_IsCfnElement(x interface{}) *bool
- func CfnMembership_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnMembership_IsConstruct(x interface{}) *bool
- func NewCfnCollaboration_Override(c CfnCollaboration, scope constructs.Construct, id *string, ...)
- func NewCfnConfiguredTableAssociation_Override(c CfnConfiguredTableAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnConfiguredTable_Override(c CfnConfiguredTable, scope constructs.Construct, id *string, ...)
- func NewCfnMembership_Override(c CfnMembership, scope constructs.Construct, id *string, ...)
- type CfnCollaboration
- type CfnCollaborationProps
- type CfnCollaboration_DataEncryptionMetadataProperty
- type CfnCollaboration_MemberSpecificationProperty
- type CfnConfiguredTable
- type CfnConfiguredTableAssociation
- type CfnConfiguredTableAssociationProps
- type CfnConfiguredTableProps
- type CfnConfiguredTable_AggregateColumnProperty
- type CfnConfiguredTable_AggregationConstraintProperty
- type CfnConfiguredTable_AnalysisRuleAggregationProperty
- type CfnConfiguredTable_AnalysisRuleListProperty
- type CfnConfiguredTable_AnalysisRuleProperty
- type CfnConfiguredTable_ConfiguredTableAnalysisRulePolicyProperty
- type CfnConfiguredTable_ConfiguredTableAnalysisRulePolicyV1Property
- type CfnConfiguredTable_GlueTableReferenceProperty
- type CfnConfiguredTable_TableReferenceProperty
- type CfnMembership
- type CfnMembershipProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnCollaboration_CFN_RESOURCE_TYPE_NAME ¶
func CfnCollaboration_CFN_RESOURCE_TYPE_NAME() *string
func CfnCollaboration_IsCfnElement ¶
func CfnCollaboration_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnCollaboration_IsCfnResource ¶
func CfnCollaboration_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnCollaboration_IsConstruct ¶
func CfnCollaboration_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnConfiguredTableAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnConfiguredTableAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnConfiguredTableAssociation_IsCfnElement ¶
func CfnConfiguredTableAssociation_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnConfiguredTableAssociation_IsCfnResource ¶
func CfnConfiguredTableAssociation_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnConfiguredTableAssociation_IsConstruct ¶
func CfnConfiguredTableAssociation_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnConfiguredTable_CFN_RESOURCE_TYPE_NAME ¶
func CfnConfiguredTable_CFN_RESOURCE_TYPE_NAME() *string
func CfnConfiguredTable_IsCfnElement ¶
func CfnConfiguredTable_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnConfiguredTable_IsCfnResource ¶
func CfnConfiguredTable_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnConfiguredTable_IsConstruct ¶
func CfnConfiguredTable_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnMembership_CFN_RESOURCE_TYPE_NAME ¶
func CfnMembership_CFN_RESOURCE_TYPE_NAME() *string
func CfnMembership_IsCfnElement ¶
func CfnMembership_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnMembership_IsCfnResource ¶
func CfnMembership_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnMembership_IsConstruct ¶
func CfnMembership_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnCollaboration_Override ¶
func NewCfnCollaboration_Override(c CfnCollaboration, scope constructs.Construct, id *string, props *CfnCollaborationProps)
func NewCfnConfiguredTableAssociation_Override ¶
func NewCfnConfiguredTableAssociation_Override(c CfnConfiguredTableAssociation, scope constructs.Construct, id *string, props *CfnConfiguredTableAssociationProps)
func NewCfnConfiguredTable_Override ¶
func NewCfnConfiguredTable_Override(c CfnConfiguredTable, scope constructs.Construct, id *string, props *CfnConfiguredTableProps)
func NewCfnMembership_Override ¶
func NewCfnMembership_Override(c CfnMembership, scope constructs.Construct, id *string, props *CfnMembershipProps)
Types ¶
type CfnCollaboration ¶
type CfnCollaboration interface { awscdk.CfnResource awscdk.IInspectable // Returns the Amazon Resource Name (ARN) of the specified collaboration. // // Example: `arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. AttrArn() *string // Returns the unique identifier of the specified collaboration. // // Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. AttrCollaborationIdentifier() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A display name of the collaboration creator. CreatorDisplayName() *string SetCreatorDisplayName(val *string) // The abilities granted to the collaboration creator. CreatorMemberAbilities() *[]*string SetCreatorMemberAbilities(val *[]*string) // The settings for client-side encryption for cryptographic computing. DataEncryptionMetadata() interface{} SetDataEncryptionMetadata(val interface{}) // A description of the collaboration provided by the collaboration owner. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // A list of initial members, not including the creator. Members() interface{} SetMembers(val interface{}) // A human-readable identifier provided by the collaboration owner. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // An indicator as to whether query logging has been enabled or disabled for the collaboration. QueryLogStatus() *string SetQueryLogStatus(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // An optional label that you can assign to a resource when you create it. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a new collaboration.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnCollaboration := awscdk.Aws_cleanrooms.NewCfnCollaboration(this, jsii.String("MyCfnCollaboration"), &CfnCollaborationProps{ CreatorDisplayName: jsii.String("creatorDisplayName"), CreatorMemberAbilities: []*string{ jsii.String("creatorMemberAbilities"), }, Description: jsii.String("description"), Members: []interface{}{ &MemberSpecificationProperty{ AccountId: jsii.String("accountId"), DisplayName: jsii.String("displayName"), MemberAbilities: []*string{ jsii.String("memberAbilities"), }, }, }, Name: jsii.String("name"), QueryLogStatus: jsii.String("queryLogStatus"), // the properties below are optional DataEncryptionMetadata: &DataEncryptionMetadataProperty{ AllowCleartext: jsii.Boolean(false), AllowDuplicates: jsii.Boolean(false), AllowJoinsOnColumnsWithDifferentNames: jsii.Boolean(false), PreserveNulls: jsii.Boolean(false), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnCollaboration ¶
func NewCfnCollaboration(scope constructs.Construct, id *string, props *CfnCollaborationProps) CfnCollaboration
type CfnCollaborationProps ¶
type CfnCollaborationProps struct { // A display name of the collaboration creator. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-creatordisplayname // CreatorDisplayName *string `field:"required" json:"creatorDisplayName" yaml:"creatorDisplayName"` // The abilities granted to the collaboration creator. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-creatormemberabilities // CreatorMemberAbilities *[]*string `field:"required" json:"creatorMemberAbilities" yaml:"creatorMemberAbilities"` // A description of the collaboration provided by the collaboration owner. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-description // Description *string `field:"required" json:"description" yaml:"description"` // A list of initial members, not including the creator. // // This list is immutable. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-members // Members interface{} `field:"required" json:"members" yaml:"members"` // A human-readable identifier provided by the collaboration owner. // // Display names are not unique. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-name // Name *string `field:"required" json:"name" yaml:"name"` // An indicator as to whether query logging has been enabled or disabled for the collaboration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-querylogstatus // QueryLogStatus *string `field:"required" json:"queryLogStatus" yaml:"queryLogStatus"` // The settings for client-side encryption for cryptographic computing. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-dataencryptionmetadata // DataEncryptionMetadata interface{} `field:"optional" json:"dataEncryptionMetadata" yaml:"dataEncryptionMetadata"` // An optional label that you can assign to a resource when you create it. // // 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-collaboration.html#cfn-cleanrooms-collaboration-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnCollaboration`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnCollaborationProps := &CfnCollaborationProps{ CreatorDisplayName: jsii.String("creatorDisplayName"), CreatorMemberAbilities: []*string{ jsii.String("creatorMemberAbilities"), }, Description: jsii.String("description"), Members: []interface{}{ &MemberSpecificationProperty{ AccountId: jsii.String("accountId"), DisplayName: jsii.String("displayName"), MemberAbilities: []*string{ jsii.String("memberAbilities"), }, }, }, Name: jsii.String("name"), QueryLogStatus: jsii.String("queryLogStatus"), // the properties below are optional DataEncryptionMetadata: &DataEncryptionMetadataProperty{ AllowCleartext: jsii.Boolean(false), AllowDuplicates: jsii.Boolean(false), AllowJoinsOnColumnsWithDifferentNames: jsii.Boolean(false), PreserveNulls: jsii.Boolean(false), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnCollaboration_DataEncryptionMetadataProperty ¶
type CfnCollaboration_DataEncryptionMetadataProperty struct { // Indicates whether encrypted tables can contain cleartext data (true) or are to cryptographically process every column (false). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html#cfn-cleanrooms-collaboration-dataencryptionmetadata-allowcleartext // AllowCleartext interface{} `field:"required" json:"allowCleartext" yaml:"allowCleartext"` // Indicates whether Fingerprint columns can contain duplicate entries (true) or are to contain only non-repeated values (false). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html#cfn-cleanrooms-collaboration-dataencryptionmetadata-allowduplicates // AllowDuplicates interface{} `field:"required" json:"allowDuplicates" yaml:"allowDuplicates"` // Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (true) or can only be joined on Fingerprint columns of the same name (false). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html#cfn-cleanrooms-collaboration-dataencryptionmetadata-allowjoinsoncolumnswithdifferentnames // AllowJoinsOnColumnsWithDifferentNames interface{} `field:"required" json:"allowJoinsOnColumnsWithDifferentNames" yaml:"allowJoinsOnColumnsWithDifferentNames"` // Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-dataencryptionmetadata.html#cfn-cleanrooms-collaboration-dataencryptionmetadata-preservenulls // PreserveNulls interface{} `field:"required" json:"preserveNulls" yaml:"preserveNulls"` }
The settings for client-side encryption for cryptographic computing.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dataEncryptionMetadataProperty := &DataEncryptionMetadataProperty{ AllowCleartext: jsii.Boolean(false), AllowDuplicates: jsii.Boolean(false), AllowJoinsOnColumnsWithDifferentNames: jsii.Boolean(false), PreserveNulls: jsii.Boolean(false), }
type CfnCollaboration_MemberSpecificationProperty ¶
type CfnCollaboration_MemberSpecificationProperty struct { // The identifier used to reference members of the collaboration. // // Currently only supports AWS account ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html#cfn-cleanrooms-collaboration-memberspecification-accountid // AccountId *string `field:"required" json:"accountId" yaml:"accountId"` // The member's display name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html#cfn-cleanrooms-collaboration-memberspecification-displayname // DisplayName *string `field:"required" json:"displayName" yaml:"displayName"` // The abilities granted to the collaboration member. // // *Allowed Values* : `CAN_QUERY` | `CAN_RECEIVE_RESULTS`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html#cfn-cleanrooms-collaboration-memberspecification-memberabilities // MemberAbilities *[]*string `field:"required" json:"memberAbilities" yaml:"memberAbilities"` }
Basic metadata used to construct a new member.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" memberSpecificationProperty := &MemberSpecificationProperty{ AccountId: jsii.String("accountId"), DisplayName: jsii.String("displayName"), MemberAbilities: []*string{ jsii.String("memberAbilities"), }, }
type CfnConfiguredTable ¶
type CfnConfiguredTable interface { awscdk.CfnResource awscdk.IInspectable // The columns within the underlying AWS Glue table that can be utilized within collaborations. AllowedColumns() *[]*string SetAllowedColumns(val *[]*string) // The analysis method for the configured table. AnalysisMethod() *string SetAnalysisMethod(val *string) // The entire created analysis rule. AnalysisRules() interface{} SetAnalysisRules(val interface{}) // Returns the Amazon Resource Name (ARN) of the specified configured table. // // Example: `arn:aws:cleanrooms:us-east-1:111122223333:configuredtable/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. AttrArn() *string // Returns the unique identifier of the specified configured table. // // Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`. AttrConfiguredTableIdentifier() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A description for the configured table. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // A name for the configured table. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The AWS Glue table that this configured table represents. TableReference() interface{} SetTableReference(val interface{}) // An optional label that you can assign to a resource when you create it. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a new configured table resource.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnConfiguredTable := awscdk.Aws_cleanrooms.NewCfnConfiguredTable(this, jsii.String("MyCfnConfiguredTable"), &CfnConfiguredTableProps{ AllowedColumns: []*string{ jsii.String("allowedColumns"), }, AnalysisMethod: jsii.String("analysisMethod"), Name: jsii.String("name"), TableReference: &TableReferenceProperty{ Glue: &GlueTableReferenceProperty{ DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), }, }, // the properties below are optional AnalysisRules: []interface{}{ &AnalysisRuleProperty{ Policy: &ConfiguredTableAnalysisRulePolicyProperty{ V1: &ConfiguredTableAnalysisRulePolicyV1Property{ Aggregation: &AnalysisRuleAggregationProperty{ AggregateColumns: []interface{}{ &AggregateColumnProperty{ ColumnNames: []*string{ jsii.String("columnNames"), }, Function: jsii.String("function"), }, }, DimensionColumns: []*string{ jsii.String("dimensionColumns"), }, JoinColumns: []*string{ jsii.String("joinColumns"), }, OutputConstraints: []interface{}{ &AggregationConstraintProperty{ ColumnName: jsii.String("columnName"), Minimum: jsii.Number(123), Type: jsii.String("type"), }, }, ScalarFunctions: []*string{ jsii.String("scalarFunctions"), }, // the properties below are optional AllowedJoinOperators: []*string{ jsii.String("allowedJoinOperators"), }, JoinRequired: jsii.String("joinRequired"), }, List: &AnalysisRuleListProperty{ JoinColumns: []*string{ jsii.String("joinColumns"), }, ListColumns: []*string{ jsii.String("listColumns"), }, // the properties below are optional AllowedJoinOperators: []*string{ jsii.String("allowedJoinOperators"), }, }, }, }, Type: jsii.String("type"), }, }, Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnConfiguredTable ¶
func NewCfnConfiguredTable(scope constructs.Construct, id *string, props *CfnConfiguredTableProps) CfnConfiguredTable
type CfnConfiguredTableAssociation ¶
type CfnConfiguredTableAssociation interface { awscdk.CfnResource awscdk.IInspectable // Returns the Amazon Resource Name (ARN) of the specified configured table association. // // Example: `arn:aws:cleanrooms:us-east-1:111122223333:configuredtable/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`. AttrArn() *string // Returns the unique identifier of the specified configured table association. // // Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`. AttrConfiguredTableAssociationIdentifier() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // A unique identifier for the configured table to be associated to. ConfiguredTableIdentifier() *string SetConfiguredTableIdentifier(val *string) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A description of the configured table association. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The unique ID for the membership this configured table association belongs to. MembershipIdentifier() *string SetMembershipIdentifier(val *string) // The name of the configured table association, in lowercase. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The service will assume this role to access catalog metadata and query the table. RoleArn() *string SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // An optional label that you can assign to a resource when you create it. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a configured table association.
A configured table association links a configured table with a collaboration.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnConfiguredTableAssociation := awscdk.Aws_cleanrooms.NewCfnConfiguredTableAssociation(this, jsii.String("MyCfnConfiguredTableAssociation"), &CfnConfiguredTableAssociationProps{ ConfiguredTableIdentifier: jsii.String("configuredTableIdentifier"), MembershipIdentifier: jsii.String("membershipIdentifier"), Name: jsii.String("name"), RoleArn: jsii.String("roleArn"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnConfiguredTableAssociation ¶
func NewCfnConfiguredTableAssociation(scope constructs.Construct, id *string, props *CfnConfiguredTableAssociationProps) CfnConfiguredTableAssociation
type CfnConfiguredTableAssociationProps ¶
type CfnConfiguredTableAssociationProps struct { // A unique identifier for the configured table to be associated to. // // Currently accepts a configured table ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtableassociation.html#cfn-cleanrooms-configuredtableassociation-configuredtableidentifier // ConfiguredTableIdentifier *string `field:"required" json:"configuredTableIdentifier" yaml:"configuredTableIdentifier"` // The unique ID for the membership this configured table association belongs to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtableassociation.html#cfn-cleanrooms-configuredtableassociation-membershipidentifier // MembershipIdentifier *string `field:"required" json:"membershipIdentifier" yaml:"membershipIdentifier"` // The name of the configured table association, in lowercase. // // The table is identified by this name when running protected queries against the underlying data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtableassociation.html#cfn-cleanrooms-configuredtableassociation-name // Name *string `field:"required" json:"name" yaml:"name"` // The service will assume this role to access catalog metadata and query the table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtableassociation.html#cfn-cleanrooms-configuredtableassociation-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // A description of the configured table association. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtableassociation.html#cfn-cleanrooms-configuredtableassociation-description // Description *string `field:"optional" json:"description" yaml:"description"` // An optional label that you can assign to a resource when you create it. // // 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-configuredtableassociation.html#cfn-cleanrooms-configuredtableassociation-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnConfiguredTableAssociation`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnConfiguredTableAssociationProps := &CfnConfiguredTableAssociationProps{ ConfiguredTableIdentifier: jsii.String("configuredTableIdentifier"), MembershipIdentifier: jsii.String("membershipIdentifier"), Name: jsii.String("name"), RoleArn: jsii.String("roleArn"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnConfiguredTableProps ¶
type CfnConfiguredTableProps struct { // The columns within the underlying AWS Glue table that can be utilized within collaborations. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-allowedcolumns // AllowedColumns *[]*string `field:"required" json:"allowedColumns" yaml:"allowedColumns"` // The analysis method for the configured table. // // The only valid value is currently `DIRECT_QUERY`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-analysismethod // AnalysisMethod *string `field:"required" json:"analysisMethod" yaml:"analysisMethod"` // A name for the configured table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-name // Name *string `field:"required" json:"name" yaml:"name"` // The AWS Glue table that this configured table represents. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-tablereference // TableReference interface{} `field:"required" json:"tableReference" yaml:"tableReference"` // The entire created analysis rule. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-analysisrules // AnalysisRules interface{} `field:"optional" json:"analysisRules" yaml:"analysisRules"` // A description for the configured table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-description // Description *string `field:"optional" json:"description" yaml:"description"` // An optional label that you can assign to a resource when you create it. // // 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-configuredtable.html#cfn-cleanrooms-configuredtable-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnConfiguredTable`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnConfiguredTableProps := &CfnConfiguredTableProps{ AllowedColumns: []*string{ jsii.String("allowedColumns"), }, AnalysisMethod: jsii.String("analysisMethod"), Name: jsii.String("name"), TableReference: &TableReferenceProperty{ Glue: &GlueTableReferenceProperty{ DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), }, }, // the properties below are optional AnalysisRules: []interface{}{ &AnalysisRuleProperty{ Policy: &ConfiguredTableAnalysisRulePolicyProperty{ V1: &ConfiguredTableAnalysisRulePolicyV1Property{ Aggregation: &AnalysisRuleAggregationProperty{ AggregateColumns: []interface{}{ &AggregateColumnProperty{ ColumnNames: []*string{ jsii.String("columnNames"), }, Function: jsii.String("function"), }, }, DimensionColumns: []*string{ jsii.String("dimensionColumns"), }, JoinColumns: []*string{ jsii.String("joinColumns"), }, OutputConstraints: []interface{}{ &AggregationConstraintProperty{ ColumnName: jsii.String("columnName"), Minimum: jsii.Number(123), Type: jsii.String("type"), }, }, ScalarFunctions: []*string{ jsii.String("scalarFunctions"), }, // the properties below are optional AllowedJoinOperators: []*string{ jsii.String("allowedJoinOperators"), }, JoinRequired: jsii.String("joinRequired"), }, List: &AnalysisRuleListProperty{ JoinColumns: []*string{ jsii.String("joinColumns"), }, ListColumns: []*string{ jsii.String("listColumns"), }, // the properties below are optional AllowedJoinOperators: []*string{ jsii.String("allowedJoinOperators"), }, }, }, }, Type: jsii.String("type"), }, }, Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnConfiguredTable_AggregateColumnProperty ¶
type CfnConfiguredTable_AggregateColumnProperty struct { // Column names in configured table of aggregate columns. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-aggregatecolumn.html#cfn-cleanrooms-configuredtable-aggregatecolumn-columnnames // ColumnNames *[]*string `field:"required" json:"columnNames" yaml:"columnNames"` // Aggregation function that can be applied to aggregate column in query. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-aggregatecolumn.html#cfn-cleanrooms-configuredtable-aggregatecolumn-function // Function *string `field:"required" json:"function" yaml:"function"` }
Column in configured table that can be used in aggregate function in query.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" aggregateColumnProperty := &AggregateColumnProperty{ ColumnNames: []*string{ jsii.String("columnNames"), }, Function: jsii.String("function"), }
type CfnConfiguredTable_AggregationConstraintProperty ¶
type CfnConfiguredTable_AggregationConstraintProperty struct { // Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-aggregationconstraint.html#cfn-cleanrooms-configuredtable-aggregationconstraint-columnname // ColumnName *string `field:"required" json:"columnName" yaml:"columnName"` // The minimum number of distinct values that an output row must be an aggregation of. // // Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-aggregationconstraint.html#cfn-cleanrooms-configuredtable-aggregationconstraint-minimum // Minimum *float64 `field:"required" json:"minimum" yaml:"minimum"` // The type of aggregation the constraint allows. // // The only valid value is currently `COUNT_DISTINCT`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-aggregationconstraint.html#cfn-cleanrooms-configuredtable-aggregationconstraint-type // Type *string `field:"required" json:"type" yaml:"type"` }
Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" aggregationConstraintProperty := &AggregationConstraintProperty{ ColumnName: jsii.String("columnName"), Minimum: jsii.Number(123), Type: jsii.String("type"), }
type CfnConfiguredTable_AnalysisRuleAggregationProperty ¶
type CfnConfiguredTable_AnalysisRuleAggregationProperty struct { // The columns that query runners are allowed to use in aggregation queries. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-aggregatecolumns // AggregateColumns interface{} `field:"required" json:"aggregateColumns" yaml:"aggregateColumns"` // The columns that query runners are allowed to select, group by, or filter by. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-dimensioncolumns // DimensionColumns *[]*string `field:"required" json:"dimensionColumns" yaml:"dimensionColumns"` // Columns in configured table that can be used in join statements and/or as aggregate columns. // // They can never be outputted directly. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-joincolumns // JoinColumns *[]*string `field:"required" json:"joinColumns" yaml:"joinColumns"` // Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-outputconstraints // OutputConstraints interface{} `field:"required" json:"outputConstraints" yaml:"outputConstraints"` // Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-scalarfunctions // ScalarFunctions *[]*string `field:"required" json:"scalarFunctions" yaml:"scalarFunctions"` // Which logical operators (if any) are to be used in an INNER JOIN match condition. // // Default is `AND` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-allowedjoinoperators // AllowedJoinOperators *[]*string `field:"optional" json:"allowedJoinOperators" yaml:"allowedJoinOperators"` // Control that requires member who runs query to do a join with their configured table and/or other configured table in query. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-joinrequired // JoinRequired *string `field:"optional" json:"joinRequired" yaml:"joinRequired"` }
A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" analysisRuleAggregationProperty := &AnalysisRuleAggregationProperty{ AggregateColumns: []interface{}{ &AggregateColumnProperty{ ColumnNames: []*string{ jsii.String("columnNames"), }, Function: jsii.String("function"), }, }, DimensionColumns: []*string{ jsii.String("dimensionColumns"), }, JoinColumns: []*string{ jsii.String("joinColumns"), }, OutputConstraints: []interface{}{ &AggregationConstraintProperty{ ColumnName: jsii.String("columnName"), Minimum: jsii.Number(123), Type: jsii.String("type"), }, }, ScalarFunctions: []*string{ jsii.String("scalarFunctions"), }, // the properties below are optional AllowedJoinOperators: []*string{ jsii.String("allowedJoinOperators"), }, JoinRequired: jsii.String("joinRequired"), }
type CfnConfiguredTable_AnalysisRuleListProperty ¶
type CfnConfiguredTable_AnalysisRuleListProperty struct { // Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulelist.html#cfn-cleanrooms-configuredtable-analysisrulelist-joincolumns // JoinColumns *[]*string `field:"required" json:"joinColumns" yaml:"joinColumns"` // Columns that can be listed in the output. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulelist.html#cfn-cleanrooms-configuredtable-analysisrulelist-listcolumns // ListColumns *[]*string `field:"required" json:"listColumns" yaml:"listColumns"` // Which logical operators (if any) are to be used in an INNER JOIN match condition. // // Default is `AND` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulelist.html#cfn-cleanrooms-configuredtable-analysisrulelist-allowedjoinoperators // AllowedJoinOperators *[]*string `field:"optional" json:"allowedJoinOperators" yaml:"allowedJoinOperators"` }
A type of analysis rule that enables row-level analysis.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" analysisRuleListProperty := &AnalysisRuleListProperty{ JoinColumns: []*string{ jsii.String("joinColumns"), }, ListColumns: []*string{ jsii.String("listColumns"), }, // the properties below are optional AllowedJoinOperators: []*string{ jsii.String("allowedJoinOperators"), }, }
type CfnConfiguredTable_AnalysisRuleProperty ¶
type CfnConfiguredTable_AnalysisRuleProperty struct { // A policy that describes the associated data usage limitations. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrule.html#cfn-cleanrooms-configuredtable-analysisrule-policy // Policy interface{} `field:"required" json:"policy" yaml:"policy"` // The type of analysis rule. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrule.html#cfn-cleanrooms-configuredtable-analysisrule-type // Type *string `field:"required" json:"type" yaml:"type"` }
A specification about how data from the configured table can be used in a query.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" analysisRuleProperty := &AnalysisRuleProperty{ Policy: &ConfiguredTableAnalysisRulePolicyProperty{ V1: &ConfiguredTableAnalysisRulePolicyV1Property{ Aggregation: &AnalysisRuleAggregationProperty{ AggregateColumns: []interface{}{ &AggregateColumnProperty{ ColumnNames: []*string{ jsii.String("columnNames"), }, Function: jsii.String("function"), }, }, DimensionColumns: []*string{ jsii.String("dimensionColumns"), }, JoinColumns: []*string{ jsii.String("joinColumns"), }, OutputConstraints: []interface{}{ &AggregationConstraintProperty{ ColumnName: jsii.String("columnName"), Minimum: jsii.Number(123), Type: jsii.String("type"), }, }, ScalarFunctions: []*string{ jsii.String("scalarFunctions"), }, // the properties below are optional AllowedJoinOperators: []*string{ jsii.String("allowedJoinOperators"), }, JoinRequired: jsii.String("joinRequired"), }, List: &AnalysisRuleListProperty{ JoinColumns: []*string{ jsii.String("joinColumns"), }, ListColumns: []*string{ jsii.String("listColumns"), }, // the properties below are optional AllowedJoinOperators: []*string{ jsii.String("allowedJoinOperators"), }, }, }, }, Type: jsii.String("type"), }
type CfnConfiguredTable_ConfiguredTableAnalysisRulePolicyProperty ¶
type CfnConfiguredTable_ConfiguredTableAnalysisRulePolicyProperty struct { // Controls on the query specifications that can be run on a configured table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-configuredtableanalysisrulepolicy.html#cfn-cleanrooms-configuredtable-configuredtableanalysisrulepolicy-v1 // V1 interface{} `field:"required" json:"v1" yaml:"v1"` }
Controls on the query specifications that can be run on a configured table.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" configuredTableAnalysisRulePolicyProperty := &ConfiguredTableAnalysisRulePolicyProperty{ V1: &ConfiguredTableAnalysisRulePolicyV1Property{ Aggregation: &AnalysisRuleAggregationProperty{ AggregateColumns: []interface{}{ &AggregateColumnProperty{ ColumnNames: []*string{ jsii.String("columnNames"), }, Function: jsii.String("function"), }, }, DimensionColumns: []*string{ jsii.String("dimensionColumns"), }, JoinColumns: []*string{ jsii.String("joinColumns"), }, OutputConstraints: []interface{}{ &AggregationConstraintProperty{ ColumnName: jsii.String("columnName"), Minimum: jsii.Number(123), Type: jsii.String("type"), }, }, ScalarFunctions: []*string{ jsii.String("scalarFunctions"), }, // the properties below are optional AllowedJoinOperators: []*string{ jsii.String("allowedJoinOperators"), }, JoinRequired: jsii.String("joinRequired"), }, List: &AnalysisRuleListProperty{ JoinColumns: []*string{ jsii.String("joinColumns"), }, ListColumns: []*string{ jsii.String("listColumns"), }, // the properties below are optional AllowedJoinOperators: []*string{ jsii.String("allowedJoinOperators"), }, }, }, }
type CfnConfiguredTable_ConfiguredTableAnalysisRulePolicyV1Property ¶
type CfnConfiguredTable_ConfiguredTableAnalysisRulePolicyV1Property struct { // Analysis rule type that enables only aggregation queries on a configured table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1.html#cfn-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1-aggregation // Aggregation interface{} `field:"optional" json:"aggregation" yaml:"aggregation"` // Analysis rule type that enables only list queries on a configured table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1.html#cfn-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1-list // List interface{} `field:"optional" json:"list" yaml:"list"` }
Controls on the query specifications that can be run on a configured table.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" configuredTableAnalysisRulePolicyV1Property := &ConfiguredTableAnalysisRulePolicyV1Property{ Aggregation: &AnalysisRuleAggregationProperty{ AggregateColumns: []interface{}{ &AggregateColumnProperty{ ColumnNames: []*string{ jsii.String("columnNames"), }, Function: jsii.String("function"), }, }, DimensionColumns: []*string{ jsii.String("dimensionColumns"), }, JoinColumns: []*string{ jsii.String("joinColumns"), }, OutputConstraints: []interface{}{ &AggregationConstraintProperty{ ColumnName: jsii.String("columnName"), Minimum: jsii.Number(123), Type: jsii.String("type"), }, }, ScalarFunctions: []*string{ jsii.String("scalarFunctions"), }, // the properties below are optional AllowedJoinOperators: []*string{ jsii.String("allowedJoinOperators"), }, JoinRequired: jsii.String("joinRequired"), }, List: &AnalysisRuleListProperty{ JoinColumns: []*string{ jsii.String("joinColumns"), }, ListColumns: []*string{ jsii.String("listColumns"), }, // the properties below are optional AllowedJoinOperators: []*string{ jsii.String("allowedJoinOperators"), }, }, }
type CfnConfiguredTable_GlueTableReferenceProperty ¶
type CfnConfiguredTable_GlueTableReferenceProperty struct { // The name of the database the AWS Glue table belongs to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-gluetablereference.html#cfn-cleanrooms-configuredtable-gluetablereference-databasename // DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // The name of the AWS Glue table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-gluetablereference.html#cfn-cleanrooms-configuredtable-gluetablereference-tablename // TableName *string `field:"required" json:"tableName" yaml:"tableName"` }
A reference to a table within an AWS Glue data catalog.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" glueTableReferenceProperty := &GlueTableReferenceProperty{ DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), }
type CfnConfiguredTable_TableReferenceProperty ¶
type CfnConfiguredTable_TableReferenceProperty struct { // If present, a reference to the AWS Glue table referred to by this table reference. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-tablereference.html#cfn-cleanrooms-configuredtable-tablereference-glue // Glue interface{} `field:"required" json:"glue" yaml:"glue"` }
A pointer to the dataset that underlies this table.
Currently, this can only be an AWS Glue table.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" tableReferenceProperty := &TableReferenceProperty{ Glue: &GlueTableReferenceProperty{ DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), }, }
type CfnMembership ¶
type CfnMembership interface { awscdk.CfnResource awscdk.IInspectable // Returns the Amazon Resource Name (ARN) of the specified membership. // // Example: `arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. AttrArn() *string // Returns the Amazon Resource Name (ARN) of the specified collaboration. // // Example: `arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. AttrCollaborationArn() *string // Returns the unique identifier of the specified collaboration creator account. // // Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. AttrCollaborationCreatorAccountId() *string // Returns the unique identifier of the specified membership. // // Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`. AttrMembershipIdentifier() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The unique ID for the associated collaboration. CollaborationIdentifier() *string SetCollaborationIdentifier(val *string) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // An indicator as to whether query logging has been enabled or disabled for the collaboration. QueryLogStatus() *string SetQueryLogStatus(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // An optional label that you can assign to a resource when you create it. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a membership for a specific collaboration identifier and joins the collaboration.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnMembership := awscdk.Aws_cleanrooms.NewCfnMembership(this, jsii.String("MyCfnMembership"), &CfnMembershipProps{ CollaborationIdentifier: jsii.String("collaborationIdentifier"), QueryLogStatus: jsii.String("queryLogStatus"), // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnMembership ¶
func NewCfnMembership(scope constructs.Construct, id *string, props *CfnMembershipProps) CfnMembership
type CfnMembershipProps ¶
type CfnMembershipProps struct { // The unique ID for the associated collaboration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-collaborationidentifier // CollaborationIdentifier *string `field:"required" json:"collaborationIdentifier" yaml:"collaborationIdentifier"` // An indicator as to whether query logging has been enabled or disabled for the collaboration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-querylogstatus // QueryLogStatus *string `field:"required" json:"queryLogStatus" yaml:"queryLogStatus"` // An optional label that you can assign to a resource when you create it. // // 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-membership.html#cfn-cleanrooms-membership-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnMembership`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnMembershipProps := &CfnMembershipProps{ CollaborationIdentifier: jsii.String("collaborationIdentifier"), QueryLogStatus: jsii.String("queryLogStatus"), // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
Source Files ¶
- CfnCollaboration.go
- CfnCollaborationProps.go
- CfnCollaboration_DataEncryptionMetadataProperty.go
- CfnCollaboration_MemberSpecificationProperty.go
- CfnCollaboration__checks.go
- CfnConfiguredTable.go
- CfnConfiguredTableAssociation.go
- CfnConfiguredTableAssociationProps.go
- CfnConfiguredTableAssociation__checks.go
- CfnConfiguredTableProps.go
- CfnConfiguredTable_AggregateColumnProperty.go
- CfnConfiguredTable_AggregationConstraintProperty.go
- CfnConfiguredTable_AnalysisRuleAggregationProperty.go
- CfnConfiguredTable_AnalysisRuleListProperty.go
- CfnConfiguredTable_AnalysisRuleProperty.go
- CfnConfiguredTable_ConfiguredTableAnalysisRulePolicyProperty.go
- CfnConfiguredTable_ConfiguredTableAnalysisRulePolicyV1Property.go
- CfnConfiguredTable_GlueTableReferenceProperty.go
- CfnConfiguredTable_TableReferenceProperty.go
- CfnConfiguredTable__checks.go
- CfnMembership.go
- CfnMembershipProps.go
- CfnMembership__checks.go
- main.go