README
¶
AWS::CleanRooms Construct Library
---
All classes with the
Cfnprefix in this module (CFN Resources) are always stable and safe to use.
This module is part of the AWS Cloud Development Kit project.
import cleanrooms "github.com/aws/aws-cdk-go/awscdk"
There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:
- Search Construct Hub for CleanRooms construct libraries
- Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::CleanRooms resources directly.
There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.
For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::CleanRooms.
(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)
Documentation
¶
Index ¶
- func CfnAnalysisTemplate_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAnalysisTemplate_IsCfnElement(x interface{}) *bool
- func CfnAnalysisTemplate_IsCfnResource(x interface{}) *bool
- func CfnAnalysisTemplate_IsConstruct(x interface{}) *bool
- func CfnCollaboration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCollaboration_IsCfnElement(x interface{}) *bool
- func CfnCollaboration_IsCfnResource(x interface{}) *bool
- func CfnCollaboration_IsConstruct(x interface{}) *bool
- func CfnConfiguredTableAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnConfiguredTableAssociation_IsCfnElement(x interface{}) *bool
- func CfnConfiguredTableAssociation_IsCfnResource(x interface{}) *bool
- func CfnConfiguredTableAssociation_IsConstruct(x interface{}) *bool
- func CfnConfiguredTable_CFN_RESOURCE_TYPE_NAME() *string
- func CfnConfiguredTable_IsCfnElement(x interface{}) *bool
- func CfnConfiguredTable_IsCfnResource(x interface{}) *bool
- func CfnConfiguredTable_IsConstruct(x interface{}) *bool
- func CfnIdMappingTable_CFN_RESOURCE_TYPE_NAME() *string
- func CfnIdMappingTable_IsCfnElement(x interface{}) *bool
- func CfnIdMappingTable_IsCfnResource(x interface{}) *bool
- func CfnIdMappingTable_IsConstruct(x interface{}) *bool
- func CfnIdNamespaceAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnIdNamespaceAssociation_IsCfnElement(x interface{}) *bool
- func CfnIdNamespaceAssociation_IsCfnResource(x interface{}) *bool
- func CfnIdNamespaceAssociation_IsConstruct(x interface{}) *bool
- func CfnMembership_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMembership_IsCfnElement(x interface{}) *bool
- func CfnMembership_IsCfnResource(x interface{}) *bool
- func CfnMembership_IsConstruct(x interface{}) *bool
- func CfnPrivacyBudgetTemplate_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPrivacyBudgetTemplate_IsCfnElement(x interface{}) *bool
- func CfnPrivacyBudgetTemplate_IsCfnResource(x interface{}) *bool
- func CfnPrivacyBudgetTemplate_IsConstruct(x interface{}) *bool
- func NewCfnAnalysisTemplate_Override(c CfnAnalysisTemplate, scope constructs.Construct, id *string, ...)
- 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 NewCfnIdMappingTable_Override(c CfnIdMappingTable, scope constructs.Construct, id *string, ...)
- func NewCfnIdNamespaceAssociation_Override(c CfnIdNamespaceAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnMembership_Override(c CfnMembership, scope constructs.Construct, id *string, ...)
- func NewCfnPrivacyBudgetTemplate_Override(c CfnPrivacyBudgetTemplate, scope constructs.Construct, id *string, ...)
- type CfnAnalysisTemplate
- type CfnAnalysisTemplateProps
- type CfnAnalysisTemplate_AnalysisParameterProperty
- type CfnAnalysisTemplate_AnalysisSchemaProperty
- type CfnAnalysisTemplate_AnalysisSourceProperty
- type CfnCollaboration
- type CfnCollaborationProps
- type CfnCollaboration_DataEncryptionMetadataProperty
- type CfnCollaboration_MemberSpecificationProperty
- type CfnCollaboration_PaymentConfigurationProperty
- type CfnCollaboration_QueryComputePaymentConfigProperty
- type CfnConfiguredTable
- type CfnConfiguredTableAssociation
- type CfnConfiguredTableAssociationProps
- type CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRuleAggregationProperty
- type CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRuleCustomProperty
- type CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRuleListProperty
- type CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRulePolicyProperty
- type CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRulePolicyV1Property
- type CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRuleProperty
- type CfnConfiguredTableProps
- type CfnConfiguredTable_AggregateColumnProperty
- type CfnConfiguredTable_AggregationConstraintProperty
- type CfnConfiguredTable_AnalysisRuleAggregationProperty
- type CfnConfiguredTable_AnalysisRuleCustomProperty
- type CfnConfiguredTable_AnalysisRuleListProperty
- type CfnConfiguredTable_AnalysisRuleProperty
- type CfnConfiguredTable_ConfiguredTableAnalysisRulePolicyProperty
- type CfnConfiguredTable_ConfiguredTableAnalysisRulePolicyV1Property
- type CfnConfiguredTable_DifferentialPrivacyColumnProperty
- type CfnConfiguredTable_DifferentialPrivacyProperty
- type CfnConfiguredTable_GlueTableReferenceProperty
- type CfnConfiguredTable_TableReferenceProperty
- type CfnIdMappingTable
- type CfnIdMappingTableProps
- type CfnIdMappingTable_IdMappingTableInputReferenceConfigProperty
- type CfnIdMappingTable_IdMappingTableInputReferencePropertiesProperty
- type CfnIdMappingTable_IdMappingTableInputSourceProperty
- type CfnIdNamespaceAssociation
- type CfnIdNamespaceAssociationProps
- type CfnIdNamespaceAssociation_IdMappingConfigProperty
- type CfnIdNamespaceAssociation_IdNamespaceAssociationInputReferenceConfigProperty
- type CfnIdNamespaceAssociation_IdNamespaceAssociationInputReferencePropertiesProperty
- type CfnMembership
- type CfnMembershipProps
- type CfnMembership_MembershipPaymentConfigurationProperty
- type CfnMembership_MembershipProtectedQueryOutputConfigurationProperty
- type CfnMembership_MembershipProtectedQueryResultConfigurationProperty
- type CfnMembership_MembershipQueryComputePaymentConfigProperty
- type CfnMembership_ProtectedQueryS3OutputConfigurationProperty
- type CfnPrivacyBudgetTemplate
- type CfnPrivacyBudgetTemplateProps
- type CfnPrivacyBudgetTemplate_ParametersProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnAnalysisTemplate_CFN_RESOURCE_TYPE_NAME ¶ added in v2.97.0
func CfnAnalysisTemplate_CFN_RESOURCE_TYPE_NAME() *string
func CfnAnalysisTemplate_IsCfnElement ¶ added in v2.97.0
func CfnAnalysisTemplate_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 CfnAnalysisTemplate_IsCfnResource ¶ added in v2.97.0
func CfnAnalysisTemplate_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnAnalysisTemplate_IsConstruct ¶ added in v2.97.0
func CfnAnalysisTemplate_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 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(x interface{}) *bool
Check whether the given object 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(x interface{}) *bool
Check whether the given object 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(x interface{}) *bool
Check whether the given object 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 CfnIdMappingTable_CFN_RESOURCE_TYPE_NAME ¶ added in v2.154.0
func CfnIdMappingTable_CFN_RESOURCE_TYPE_NAME() *string
func CfnIdMappingTable_IsCfnElement ¶ added in v2.154.0
func CfnIdMappingTable_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 CfnIdMappingTable_IsCfnResource ¶ added in v2.154.0
func CfnIdMappingTable_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnIdMappingTable_IsConstruct ¶ added in v2.154.0
func CfnIdMappingTable_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 CfnIdNamespaceAssociation_CFN_RESOURCE_TYPE_NAME ¶ added in v2.154.0
func CfnIdNamespaceAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnIdNamespaceAssociation_IsCfnElement ¶ added in v2.154.0
func CfnIdNamespaceAssociation_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 CfnIdNamespaceAssociation_IsCfnResource ¶ added in v2.154.0
func CfnIdNamespaceAssociation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnIdNamespaceAssociation_IsConstruct ¶ added in v2.154.0
func CfnIdNamespaceAssociation_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(x interface{}) *bool
Check whether the given object 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 CfnPrivacyBudgetTemplate_CFN_RESOURCE_TYPE_NAME ¶ added in v2.138.0
func CfnPrivacyBudgetTemplate_CFN_RESOURCE_TYPE_NAME() *string
func CfnPrivacyBudgetTemplate_IsCfnElement ¶ added in v2.138.0
func CfnPrivacyBudgetTemplate_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 CfnPrivacyBudgetTemplate_IsCfnResource ¶ added in v2.138.0
func CfnPrivacyBudgetTemplate_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPrivacyBudgetTemplate_IsConstruct ¶ added in v2.138.0
func CfnPrivacyBudgetTemplate_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 NewCfnAnalysisTemplate_Override ¶ added in v2.97.0
func NewCfnAnalysisTemplate_Override(c CfnAnalysisTemplate, scope constructs.Construct, id *string, props *CfnAnalysisTemplateProps)
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 NewCfnIdMappingTable_Override ¶ added in v2.154.0
func NewCfnIdMappingTable_Override(c CfnIdMappingTable, scope constructs.Construct, id *string, props *CfnIdMappingTableProps)
func NewCfnIdNamespaceAssociation_Override ¶ added in v2.154.0
func NewCfnIdNamespaceAssociation_Override(c CfnIdNamespaceAssociation, scope constructs.Construct, id *string, props *CfnIdNamespaceAssociationProps)
func NewCfnMembership_Override ¶
func NewCfnMembership_Override(c CfnMembership, scope constructs.Construct, id *string, props *CfnMembershipProps)
func NewCfnPrivacyBudgetTemplate_Override ¶ added in v2.138.0
func NewCfnPrivacyBudgetTemplate_Override(c CfnPrivacyBudgetTemplate, scope constructs.Construct, id *string, props *CfnPrivacyBudgetTemplateProps)
Types ¶
type CfnAnalysisTemplate ¶ added in v2.97.0
type CfnAnalysisTemplate interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggableV2
// The parameters of the analysis template.
AnalysisParameters() interface{}
SetAnalysisParameters(val interface{})
// Returns the identifier for the analysis template.
//
// Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE2222`.
AttrAnalysisTemplateIdentifier() *string
// Returns the Amazon Resource Name (ARN) of the analysis template.
//
// Example: `arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/analysistemplates/a1b2c3d4-5678-90ab-cdef-EXAMPLE2222`.
AttrArn() *string
// Returns the unique ARN for the analysis template’s associated collaboration.
//
// Example: `arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`.
AttrCollaborationArn() *string
// Returns the unique ID for the associated collaboration of the analysis template.
//
// Example: `a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`.
AttrCollaborationIdentifier() *string
// Returns the Amazon Resource Name (ARN) of the member who created the analysis template.
//
// Example: `arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.
AttrMembershipArn() *string
AttrSchema() awscdk.IResolvable
AttrSchemaReferencedTables() *[]*string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// 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
// The description of the analysis template.
Description() *string
SetDescription(val *string)
// The format of the analysis template.
Format() *string
SetFormat(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 identifier for a membership resource.
MembershipIdentifier() *string
SetMembershipIdentifier(val *string)
// The name of the analysis template.
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 source of the analysis template.
Source() interface{}
SetSource(val interface{})
// 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 analysis template.
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"
cfnAnalysisTemplate := awscdk.Aws_cleanrooms.NewCfnAnalysisTemplate(this, jsii.String("MyCfnAnalysisTemplate"), &CfnAnalysisTemplateProps{
Format: jsii.String("format"),
MembershipIdentifier: jsii.String("membershipIdentifier"),
Name: jsii.String("name"),
Source: &AnalysisSourceProperty{
Text: jsii.String("text"),
},
// the properties below are optional
AnalysisParameters: []interface{}{
&AnalysisParameterProperty{
Name: jsii.String("name"),
Type: jsii.String("type"),
// the properties below are optional
DefaultValue: jsii.String("defaultValue"),
},
},
Description: jsii.String("description"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnAnalysisTemplate ¶ added in v2.97.0
func NewCfnAnalysisTemplate(scope constructs.Construct, id *string, props *CfnAnalysisTemplateProps) CfnAnalysisTemplate
type CfnAnalysisTemplateProps ¶ added in v2.97.0
type CfnAnalysisTemplateProps struct {
// The format of the analysis template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-format
//
Format *string `field:"required" json:"format" yaml:"format"`
// The identifier for a membership resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-membershipidentifier
//
MembershipIdentifier *string `field:"required" json:"membershipIdentifier" yaml:"membershipIdentifier"`
// The name of the analysis template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The source of the analysis template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-source
//
Source interface{} `field:"required" json:"source" yaml:"source"`
// The parameters of the analysis template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-analysisparameters
//
AnalysisParameters interface{} `field:"optional" json:"analysisParameters" yaml:"analysisParameters"`
// The description of the analysis template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-analysistemplate.html#cfn-cleanrooms-analysistemplate-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-analysistemplate.html#cfn-cleanrooms-analysistemplate-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnAnalysisTemplate`.
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"
cfnAnalysisTemplateProps := &CfnAnalysisTemplateProps{
Format: jsii.String("format"),
MembershipIdentifier: jsii.String("membershipIdentifier"),
Name: jsii.String("name"),
Source: &AnalysisSourceProperty{
Text: jsii.String("text"),
},
// the properties below are optional
AnalysisParameters: []interface{}{
&AnalysisParameterProperty{
Name: jsii.String("name"),
Type: jsii.String("type"),
// the properties below are optional
DefaultValue: jsii.String("defaultValue"),
},
},
Description: jsii.String("description"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnAnalysisTemplate_AnalysisParameterProperty ¶ added in v2.97.0
type CfnAnalysisTemplate_AnalysisParameterProperty struct {
// The name of the parameter.
//
// The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisparameter.html#cfn-cleanrooms-analysistemplate-analysisparameter-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The type of parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisparameter.html#cfn-cleanrooms-analysistemplate-analysisparameter-type
//
Type *string `field:"required" json:"type" yaml:"type"`
// Optional.
//
// The default value that is applied in the analysis template. The member who can query can override this value in the query editor.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisparameter.html#cfn-cleanrooms-analysistemplate-analysisparameter-defaultvalue
//
DefaultValue *string `field:"optional" json:"defaultValue" yaml:"defaultValue"`
}
Optional.
The member who can query can provide this placeholder for a literal data value in an analysis template.
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"
analysisParameterProperty := &AnalysisParameterProperty{
Name: jsii.String("name"),
Type: jsii.String("type"),
// the properties below are optional
DefaultValue: jsii.String("defaultValue"),
}
type CfnAnalysisTemplate_AnalysisSchemaProperty ¶ added in v2.97.0
type CfnAnalysisTemplate_AnalysisSchemaProperty struct {
// The tables referenced in the analysis schema.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysisschema.html#cfn-cleanrooms-analysistemplate-analysisschema-referencedtables
//
ReferencedTables *[]*string `field:"required" json:"referencedTables" yaml:"referencedTables"`
}
A relation within an 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"
analysisSchemaProperty := &AnalysisSchemaProperty{
ReferencedTables: []*string{
jsii.String("referencedTables"),
},
}
type CfnAnalysisTemplate_AnalysisSourceProperty ¶ added in v2.97.0
type CfnAnalysisTemplate_AnalysisSourceProperty struct {
// The query text.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-analysistemplate-analysissource.html#cfn-cleanrooms-analysistemplate-analysissource-text
//
Text *string `field:"required" json:"text" yaml:"text"`
}
The structure that defines the body of the analysis template.
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"
analysisSourceProperty := &AnalysisSourceProperty{
Text: jsii.String("text"),
}
type CfnCollaboration ¶
type CfnCollaboration interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggableV2
// 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
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// 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)
// An object representing the collaboration member's payment responsibilities set by the collaboration creator.
CreatorPaymentConfiguration() interface{}
SetCreatorPaymentConfiguration(val interface{})
// 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"),
},
// the properties below are optional
PaymentConfiguration: &PaymentConfigurationProperty{
QueryCompute: &QueryComputePaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
},
},
},
Name: jsii.String("name"),
QueryLogStatus: jsii.String("queryLogStatus"),
// the properties below are optional
CreatorPaymentConfiguration: &PaymentConfigurationProperty{
QueryCompute: &QueryComputePaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
},
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.
//
// *Allowed values* `CAN_QUERY` | `CAN_RECEIVE_RESULTS`.
// 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"`
// An object representing the collaboration member's payment responsibilities set by the collaboration creator.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-collaboration.html#cfn-cleanrooms-collaboration-creatorpaymentconfiguration
//
CreatorPaymentConfiguration interface{} `field:"optional" json:"creatorPaymentConfiguration" yaml:"creatorPaymentConfiguration"`
// 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"),
},
// the properties below are optional
PaymentConfiguration: &PaymentConfigurationProperty{
QueryCompute: &QueryComputePaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
},
},
},
Name: jsii.String("name"),
QueryLogStatus: jsii.String("queryLogStatus"),
// the properties below are optional
CreatorPaymentConfiguration: &PaymentConfigurationProperty{
QueryCompute: &QueryComputePaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
},
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"`
// The collaboration member's payment responsibilities set by the collaboration creator.
//
// If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-memberspecification.html#cfn-cleanrooms-collaboration-memberspecification-paymentconfiguration
//
PaymentConfiguration interface{} `field:"optional" json:"paymentConfiguration" yaml:"paymentConfiguration"`
}
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"),
},
// the properties below are optional
PaymentConfiguration: &PaymentConfigurationProperty{
QueryCompute: &QueryComputePaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
},
}
type CfnCollaboration_PaymentConfigurationProperty ¶ added in v2.112.0
type CfnCollaboration_PaymentConfigurationProperty struct {
// The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-paymentconfiguration.html#cfn-cleanrooms-collaboration-paymentconfiguration-querycompute
//
QueryCompute interface{} `field:"required" json:"queryCompute" yaml:"queryCompute"`
}
An object representing the collaboration member's payment responsibilities set by the collaboration creator.
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"
paymentConfigurationProperty := &PaymentConfigurationProperty{
QueryCompute: &QueryComputePaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
}
type CfnCollaboration_QueryComputePaymentConfigProperty ¶ added in v2.112.0
type CfnCollaboration_QueryComputePaymentConfigProperty struct {
// Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs ( `TRUE` ) or has not configured the collaboration member to pay for query compute costs ( `FALSE` ).
//
// Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a `TRUE` value for more than one member in the collaboration.
//
// If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a `FALSE` value for the member who can query.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-collaboration-querycomputepaymentconfig.html#cfn-cleanrooms-collaboration-querycomputepaymentconfig-isresponsible
//
IsResponsible interface{} `field:"required" json:"isResponsible" yaml:"isResponsible"`
}
An object representing the collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
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"
queryComputePaymentConfigProperty := &QueryComputePaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
}
type CfnConfiguredTable ¶
type CfnConfiguredTable interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggableV2
// 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 analysis rule that was created for the configured table.
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
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// 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
AdditionalAnalyses: jsii.String("additionalAnalyses"),
AllowedJoinOperators: []*string{
jsii.String("allowedJoinOperators"),
},
JoinRequired: jsii.String("joinRequired"),
},
Custom: &AnalysisRuleCustomProperty{
AllowedAnalyses: []*string{
jsii.String("allowedAnalyses"),
},
// the properties below are optional
AdditionalAnalyses: jsii.String("additionalAnalyses"),
AllowedAnalysisProviders: []*string{
jsii.String("allowedAnalysisProviders"),
},
DifferentialPrivacy: &DifferentialPrivacyProperty{
Columns: []interface{}{
&DifferentialPrivacyColumnProperty{
Name: jsii.String("name"),
},
},
},
DisallowedOutputColumns: []*string{
jsii.String("disallowedOutputColumns"),
},
},
List: &AnalysisRuleListProperty{
JoinColumns: []*string{
jsii.String("joinColumns"),
},
ListColumns: []*string{
jsii.String("listColumns"),
},
// the properties below are optional
AdditionalAnalyses: jsii.String("additionalAnalyses"),
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
awscdk.ITaggableV2
// 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
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// An analysis rule for a configured table association.
ConfiguredTableAssociationAnalysisRules() interface{}
SetConfiguredTableAssociationAnalysisRules(val interface{})
// 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
ConfiguredTableAssociationAnalysisRules: []interface{}{
&ConfiguredTableAssociationAnalysisRuleProperty{
Policy: &ConfiguredTableAssociationAnalysisRulePolicyProperty{
V1: &ConfiguredTableAssociationAnalysisRulePolicyV1Property{
Aggregation: &ConfiguredTableAssociationAnalysisRuleAggregationProperty{
AllowedAdditionalAnalyses: []*string{
jsii.String("allowedAdditionalAnalyses"),
},
AllowedResultReceivers: []*string{
jsii.String("allowedResultReceivers"),
},
},
Custom: &ConfiguredTableAssociationAnalysisRuleCustomProperty{
AllowedAdditionalAnalyses: []*string{
jsii.String("allowedAdditionalAnalyses"),
},
AllowedResultReceivers: []*string{
jsii.String("allowedResultReceivers"),
},
},
List: &ConfiguredTableAssociationAnalysisRuleListProperty{
AllowedAdditionalAnalyses: []*string{
jsii.String("allowedAdditionalAnalyses"),
},
AllowedResultReceivers: []*string{
jsii.String("allowedResultReceivers"),
},
},
},
},
Type: jsii.String("type"),
},
},
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"`
// An analysis rule for a configured table association.
//
// This analysis rule specifies how data from the table can be used within its associated collaboration. In the console, the `ConfiguredTableAssociationAnalysisRule` is referred to as the *collaboration analysis rule* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtableassociation.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrules
//
ConfiguredTableAssociationAnalysisRules interface{} `field:"optional" json:"configuredTableAssociationAnalysisRules" yaml:"configuredTableAssociationAnalysisRules"`
// 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
ConfiguredTableAssociationAnalysisRules: []interface{}{
&ConfiguredTableAssociationAnalysisRuleProperty{
Policy: &ConfiguredTableAssociationAnalysisRulePolicyProperty{
V1: &ConfiguredTableAssociationAnalysisRulePolicyV1Property{
Aggregation: &ConfiguredTableAssociationAnalysisRuleAggregationProperty{
AllowedAdditionalAnalyses: []*string{
jsii.String("allowedAdditionalAnalyses"),
},
AllowedResultReceivers: []*string{
jsii.String("allowedResultReceivers"),
},
},
Custom: &ConfiguredTableAssociationAnalysisRuleCustomProperty{
AllowedAdditionalAnalyses: []*string{
jsii.String("allowedAdditionalAnalyses"),
},
AllowedResultReceivers: []*string{
jsii.String("allowedResultReceivers"),
},
},
List: &ConfiguredTableAssociationAnalysisRuleListProperty{
AllowedAdditionalAnalyses: []*string{
jsii.String("allowedAdditionalAnalyses"),
},
AllowedResultReceivers: []*string{
jsii.String("allowedResultReceivers"),
},
},
},
},
Type: jsii.String("type"),
},
},
Description: jsii.String("description"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRuleAggregationProperty ¶ added in v2.154.0
type CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRuleAggregationProperty struct {
// The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
//
// The `allowedAdditionalAnalyses` parameter is currently supported for the list analysis rule ( `AnalysisRuleList` ) and the custom analysis rule ( `AnalysisRuleCustom` ).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation-allowedadditionalanalyses
//
AllowedAdditionalAnalyses *[]*string `field:"optional" json:"allowedAdditionalAnalyses" yaml:"allowedAdditionalAnalyses"`
// The list of collaboration members who are allowed to receive results of queries run with this configured table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisruleaggregation-allowedresultreceivers
//
AllowedResultReceivers *[]*string `field:"optional" json:"allowedResultReceivers" yaml:"allowedResultReceivers"`
}
The configured table association analysis rule applied to a configured table with the aggregation analysis rule.
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"
configuredTableAssociationAnalysisRuleAggregationProperty := &ConfiguredTableAssociationAnalysisRuleAggregationProperty{
AllowedAdditionalAnalyses: []*string{
jsii.String("allowedAdditionalAnalyses"),
},
AllowedResultReceivers: []*string{
jsii.String("allowedResultReceivers"),
},
}
type CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRuleCustomProperty ¶ added in v2.154.0
type CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRuleCustomProperty struct {
// The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom-allowedadditionalanalyses
//
AllowedAdditionalAnalyses *[]*string `field:"optional" json:"allowedAdditionalAnalyses" yaml:"allowedAdditionalAnalyses"`
// The list of collaboration members who are allowed to receive results of queries run with this configured table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulecustom-allowedresultreceivers
//
AllowedResultReceivers *[]*string `field:"optional" json:"allowedResultReceivers" yaml:"allowedResultReceivers"`
}
The configured table association analysis rule applied to a configured table with the custom analysis rule.
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"
configuredTableAssociationAnalysisRuleCustomProperty := &ConfiguredTableAssociationAnalysisRuleCustomProperty{
AllowedAdditionalAnalyses: []*string{
jsii.String("allowedAdditionalAnalyses"),
},
AllowedResultReceivers: []*string{
jsii.String("allowedResultReceivers"),
},
}
type CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRuleListProperty ¶ added in v2.154.0
type CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRuleListProperty struct {
// The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist-allowedadditionalanalyses
//
AllowedAdditionalAnalyses *[]*string `field:"optional" json:"allowedAdditionalAnalyses" yaml:"allowedAdditionalAnalyses"`
// The list of collaboration members who are allowed to receive results of queries run with this configured table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulelist-allowedresultreceivers
//
AllowedResultReceivers *[]*string `field:"optional" json:"allowedResultReceivers" yaml:"allowedResultReceivers"`
}
The configured table association analysis rule applied to a configured table with the list analysis rule.
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"
configuredTableAssociationAnalysisRuleListProperty := &ConfiguredTableAssociationAnalysisRuleListProperty{
AllowedAdditionalAnalyses: []*string{
jsii.String("allowedAdditionalAnalyses"),
},
AllowedResultReceivers: []*string{
jsii.String("allowedResultReceivers"),
},
}
type CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRulePolicyProperty ¶ added in v2.154.0
type CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRulePolicyProperty struct {
// The policy for the configured table association analysis rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicy.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicy-v1
//
V1 interface{} `field:"required" json:"v1" yaml:"v1"`
}
Controls on the query specifications that can be run on an associated 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"
configuredTableAssociationAnalysisRulePolicyProperty := &ConfiguredTableAssociationAnalysisRulePolicyProperty{
V1: &ConfiguredTableAssociationAnalysisRulePolicyV1Property{
Aggregation: &ConfiguredTableAssociationAnalysisRuleAggregationProperty{
AllowedAdditionalAnalyses: []*string{
jsii.String("allowedAdditionalAnalyses"),
},
AllowedResultReceivers: []*string{
jsii.String("allowedResultReceivers"),
},
},
Custom: &ConfiguredTableAssociationAnalysisRuleCustomProperty{
AllowedAdditionalAnalyses: []*string{
jsii.String("allowedAdditionalAnalyses"),
},
AllowedResultReceivers: []*string{
jsii.String("allowedResultReceivers"),
},
},
List: &ConfiguredTableAssociationAnalysisRuleListProperty{
AllowedAdditionalAnalyses: []*string{
jsii.String("allowedAdditionalAnalyses"),
},
AllowedResultReceivers: []*string{
jsii.String("allowedResultReceivers"),
},
},
},
}
type CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRulePolicyV1Property ¶ added in v2.154.0
type CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRulePolicyV1Property 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-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1-aggregation
//
Aggregation interface{} `field:"optional" json:"aggregation" yaml:"aggregation"`
// Analysis rule type that enables the table owner to approve custom SQL queries on their configured tables.
//
// It supports differential privacy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1-custom
//
Custom interface{} `field:"optional" json:"custom" yaml:"custom"`
// Analysis rule type that enables only list queries on a configured table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrulepolicyv1-list
//
List interface{} `field:"optional" json:"list" yaml:"list"`
}
Controls on the query specifications that can be run on an associated 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"
configuredTableAssociationAnalysisRulePolicyV1Property := &ConfiguredTableAssociationAnalysisRulePolicyV1Property{
Aggregation: &ConfiguredTableAssociationAnalysisRuleAggregationProperty{
AllowedAdditionalAnalyses: []*string{
jsii.String("allowedAdditionalAnalyses"),
},
AllowedResultReceivers: []*string{
jsii.String("allowedResultReceivers"),
},
},
Custom: &ConfiguredTableAssociationAnalysisRuleCustomProperty{
AllowedAdditionalAnalyses: []*string{
jsii.String("allowedAdditionalAnalyses"),
},
AllowedResultReceivers: []*string{
jsii.String("allowedResultReceivers"),
},
},
List: &ConfiguredTableAssociationAnalysisRuleListProperty{
AllowedAdditionalAnalyses: []*string{
jsii.String("allowedAdditionalAnalyses"),
},
AllowedResultReceivers: []*string{
jsii.String("allowedResultReceivers"),
},
},
}
type CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRuleProperty ¶ added in v2.154.0
type CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRuleProperty struct {
// The policy of the configured table association analysis rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule-policy
//
Policy interface{} `field:"required" json:"policy" yaml:"policy"`
// The type of the configured table association analysis rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule.html#cfn-cleanrooms-configuredtableassociation-configuredtableassociationanalysisrule-type
//
Type *string `field:"required" json:"type" yaml:"type"`
}
An analysis rule for a configured table association.
This analysis rule specifies how data from the table can be used within its associated collaboration. In the console, the `ConfiguredTableAssociationAnalysisRule` is referred to as the *collaboration analysis rule* .
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"
configuredTableAssociationAnalysisRuleProperty := &ConfiguredTableAssociationAnalysisRuleProperty{
Policy: &ConfiguredTableAssociationAnalysisRulePolicyProperty{
V1: &ConfiguredTableAssociationAnalysisRulePolicyV1Property{
Aggregation: &ConfiguredTableAssociationAnalysisRuleAggregationProperty{
AllowedAdditionalAnalyses: []*string{
jsii.String("allowedAdditionalAnalyses"),
},
AllowedResultReceivers: []*string{
jsii.String("allowedResultReceivers"),
},
},
Custom: &ConfiguredTableAssociationAnalysisRuleCustomProperty{
AllowedAdditionalAnalyses: []*string{
jsii.String("allowedAdditionalAnalyses"),
},
AllowedResultReceivers: []*string{
jsii.String("allowedResultReceivers"),
},
},
List: &ConfiguredTableAssociationAnalysisRuleListProperty{
AllowedAdditionalAnalyses: []*string{
jsii.String("allowedAdditionalAnalyses"),
},
AllowedResultReceivers: []*string{
jsii.String("allowedResultReceivers"),
},
},
},
},
Type: jsii.String("type"),
}
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 analysis rule that was created for the configured table.
// 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
AdditionalAnalyses: jsii.String("additionalAnalyses"),
AllowedJoinOperators: []*string{
jsii.String("allowedJoinOperators"),
},
JoinRequired: jsii.String("joinRequired"),
},
Custom: &AnalysisRuleCustomProperty{
AllowedAnalyses: []*string{
jsii.String("allowedAnalyses"),
},
// the properties below are optional
AdditionalAnalyses: jsii.String("additionalAnalyses"),
AllowedAnalysisProviders: []*string{
jsii.String("allowedAnalysisProviders"),
},
DifferentialPrivacy: &DifferentialPrivacyProperty{
Columns: []interface{}{
&DifferentialPrivacyColumnProperty{
Name: jsii.String("name"),
},
},
},
DisallowedOutputColumns: []*string{
jsii.String("disallowedOutputColumns"),
},
},
List: &AnalysisRuleListProperty{
JoinColumns: []*string{
jsii.String("joinColumns"),
},
ListColumns: []*string{
jsii.String("listColumns"),
},
// the properties below are optional
AdditionalAnalyses: jsii.String("additionalAnalyses"),
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"`
// An indicator as to whether additional analyses (such as AWS Clean Rooms ML) can be applied to the output of the direct query.
//
// The `additionalAnalyses` parameter is currently supported for the list analysis rule ( `AnalysisRuleList` ) and the custom analysis rule ( `AnalysisRuleCustom` ).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-additionalanalyses
//
AdditionalAnalyses *string `field:"optional" json:"additionalAnalyses" yaml:"additionalAnalyses"`
// 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
AdditionalAnalyses: jsii.String("additionalAnalyses"),
AllowedJoinOperators: []*string{
jsii.String("allowedJoinOperators"),
},
JoinRequired: jsii.String("joinRequired"),
}
type CfnConfiguredTable_AnalysisRuleCustomProperty ¶ added in v2.95.0
type CfnConfiguredTable_AnalysisRuleCustomProperty struct {
// The ARN of the analysis templates that are allowed by the custom analysis rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulecustom.html#cfn-cleanrooms-configuredtable-analysisrulecustom-allowedanalyses
//
AllowedAnalyses *[]*string `field:"required" json:"allowedAnalyses" yaml:"allowedAnalyses"`
// An indicator as to whether additional analyses (such as AWS Clean Rooms ML) can be applied to the output of the direct query.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulecustom.html#cfn-cleanrooms-configuredtable-analysisrulecustom-additionalanalyses
//
AdditionalAnalyses *string `field:"optional" json:"additionalAnalyses" yaml:"additionalAnalyses"`
// The IDs of the AWS accounts that are allowed to query by the custom analysis rule.
//
// Required when `allowedAnalyses` is `ANY_QUERY` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulecustom.html#cfn-cleanrooms-configuredtable-analysisrulecustom-allowedanalysisproviders
//
AllowedAnalysisProviders *[]*string `field:"optional" json:"allowedAnalysisProviders" yaml:"allowedAnalysisProviders"`
// The differential privacy configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulecustom.html#cfn-cleanrooms-configuredtable-analysisrulecustom-differentialprivacy
//
DifferentialPrivacy interface{} `field:"optional" json:"differentialPrivacy" yaml:"differentialPrivacy"`
// A list of columns that aren't allowed to be shown in the query output.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulecustom.html#cfn-cleanrooms-configuredtable-analysisrulecustom-disallowedoutputcolumns
//
DisallowedOutputColumns *[]*string `field:"optional" json:"disallowedOutputColumns" yaml:"disallowedOutputColumns"`
}
A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables.
It supports differential privacy.
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"
analysisRuleCustomProperty := &AnalysisRuleCustomProperty{
AllowedAnalyses: []*string{
jsii.String("allowedAnalyses"),
},
// the properties below are optional
AdditionalAnalyses: jsii.String("additionalAnalyses"),
AllowedAnalysisProviders: []*string{
jsii.String("allowedAnalysisProviders"),
},
DifferentialPrivacy: &DifferentialPrivacyProperty{
Columns: []interface{}{
&DifferentialPrivacyColumnProperty{
Name: jsii.String("name"),
},
},
},
DisallowedOutputColumns: []*string{
jsii.String("disallowedOutputColumns"),
},
}
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"`
// An indicator as to whether additional analyses (such as AWS Clean Rooms ML) can be applied to the output of the direct query.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisrulelist.html#cfn-cleanrooms-configuredtable-analysisrulelist-additionalanalyses
//
AdditionalAnalyses *string `field:"optional" json:"additionalAnalyses" yaml:"additionalAnalyses"`
// The logical operators (if any) that 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
AdditionalAnalyses: jsii.String("additionalAnalyses"),
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
AdditionalAnalyses: jsii.String("additionalAnalyses"),
AllowedJoinOperators: []*string{
jsii.String("allowedJoinOperators"),
},
JoinRequired: jsii.String("joinRequired"),
},
Custom: &AnalysisRuleCustomProperty{
AllowedAnalyses: []*string{
jsii.String("allowedAnalyses"),
},
// the properties below are optional
AdditionalAnalyses: jsii.String("additionalAnalyses"),
AllowedAnalysisProviders: []*string{
jsii.String("allowedAnalysisProviders"),
},
DifferentialPrivacy: &DifferentialPrivacyProperty{
Columns: []interface{}{
&DifferentialPrivacyColumnProperty{
Name: jsii.String("name"),
},
},
},
DisallowedOutputColumns: []*string{
jsii.String("disallowedOutputColumns"),
},
},
List: &AnalysisRuleListProperty{
JoinColumns: []*string{
jsii.String("joinColumns"),
},
ListColumns: []*string{
jsii.String("listColumns"),
},
// the properties below are optional
AdditionalAnalyses: jsii.String("additionalAnalyses"),
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
AdditionalAnalyses: jsii.String("additionalAnalyses"),
AllowedJoinOperators: []*string{
jsii.String("allowedJoinOperators"),
},
JoinRequired: jsii.String("joinRequired"),
},
Custom: &AnalysisRuleCustomProperty{
AllowedAnalyses: []*string{
jsii.String("allowedAnalyses"),
},
// the properties below are optional
AdditionalAnalyses: jsii.String("additionalAnalyses"),
AllowedAnalysisProviders: []*string{
jsii.String("allowedAnalysisProviders"),
},
DifferentialPrivacy: &DifferentialPrivacyProperty{
Columns: []interface{}{
&DifferentialPrivacyColumnProperty{
Name: jsii.String("name"),
},
},
},
DisallowedOutputColumns: []*string{
jsii.String("disallowedOutputColumns"),
},
},
List: &AnalysisRuleListProperty{
JoinColumns: []*string{
jsii.String("joinColumns"),
},
ListColumns: []*string{
jsii.String("listColumns"),
},
// the properties below are optional
AdditionalAnalyses: jsii.String("additionalAnalyses"),
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 custom SQL queries on a configured table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1.html#cfn-cleanrooms-configuredtable-configuredtableanalysisrulepolicyv1-custom
//
Custom interface{} `field:"optional" json:"custom" yaml:"custom"`
// 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
AdditionalAnalyses: jsii.String("additionalAnalyses"),
AllowedJoinOperators: []*string{
jsii.String("allowedJoinOperators"),
},
JoinRequired: jsii.String("joinRequired"),
},
Custom: &AnalysisRuleCustomProperty{
AllowedAnalyses: []*string{
jsii.String("allowedAnalyses"),
},
// the properties below are optional
AdditionalAnalyses: jsii.String("additionalAnalyses"),
AllowedAnalysisProviders: []*string{
jsii.String("allowedAnalysisProviders"),
},
DifferentialPrivacy: &DifferentialPrivacyProperty{
Columns: []interface{}{
&DifferentialPrivacyColumnProperty{
Name: jsii.String("name"),
},
},
},
DisallowedOutputColumns: []*string{
jsii.String("disallowedOutputColumns"),
},
},
List: &AnalysisRuleListProperty{
JoinColumns: []*string{
jsii.String("joinColumns"),
},
ListColumns: []*string{
jsii.String("listColumns"),
},
// the properties below are optional
AdditionalAnalyses: jsii.String("additionalAnalyses"),
AllowedJoinOperators: []*string{
jsii.String("allowedJoinOperators"),
},
},
}
type CfnConfiguredTable_DifferentialPrivacyColumnProperty ¶ added in v2.135.0
type CfnConfiguredTable_DifferentialPrivacyColumnProperty struct {
// The name of the column, such as user_id, that contains the unique identifier of your users, whose privacy you want to protect.
//
// If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-differentialprivacycolumn.html#cfn-cleanrooms-configuredtable-differentialprivacycolumn-name
//
Name *string `field:"required" json:"name" yaml:"name"`
}
Specifies the name of the column that contains the unique identifier of your users, whose privacy you want to protect.
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"
differentialPrivacyColumnProperty := &DifferentialPrivacyColumnProperty{
Name: jsii.String("name"),
}
type CfnConfiguredTable_DifferentialPrivacyProperty ¶ added in v2.135.0
type CfnConfiguredTable_DifferentialPrivacyProperty struct {
// The name of the column, such as user_id, that contains the unique identifier of your users, whose privacy you want to protect.
//
// If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-differentialprivacy.html#cfn-cleanrooms-configuredtable-differentialprivacy-columns
//
Columns interface{} `field:"required" json:"columns" yaml:"columns"`
}
The analysis method for the configured tables.
The only valid value is currently `DIRECT_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"
differentialPrivacyProperty := &DifferentialPrivacyProperty{
Columns: []interface{}{
&DifferentialPrivacyColumnProperty{
Name: jsii.String("name"),
},
},
}
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 CfnIdMappingTable ¶ added in v2.154.0
type CfnIdMappingTable interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggableV2
// The Amazon Resource Name (ARN) of the ID mapping table.
AttrArn() *string
// The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.
AttrCollaborationArn() *string
AttrCollaborationIdentifier() *string
AttrIdMappingTableIdentifier() *string
AttrInputReferenceProperties() awscdk.IResolvable
// The Amazon Resource Name (ARN) of the membership resource for the ID mapping table.
AttrMembershipArn() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// 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
// The description of the ID mapping table.
Description() *string
SetDescription(val *string)
// The input reference configuration for the ID mapping table.
InputReferenceConfig() interface{}
SetInputReferenceConfig(val interface{})
// The Amazon Resource Name (ARN) of the AWS KMS key.
KmsKeyArn() *string
SetKmsKeyArn(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 identifier of the membership resource for the ID mapping table.
MembershipIdentifier() *string
SetMembershipIdentifier(val *string)
// The name of the ID mapping 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
// 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{})
}
Describes information about the ID mapping 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"
cfnIdMappingTable := awscdk.Aws_cleanrooms.NewCfnIdMappingTable(this, jsii.String("MyCfnIdMappingTable"), &CfnIdMappingTableProps{
InputReferenceConfig: &IdMappingTableInputReferenceConfigProperty{
InputReferenceArn: jsii.String("inputReferenceArn"),
ManageResourcePolicies: jsii.Boolean(false),
},
MembershipIdentifier: jsii.String("membershipIdentifier"),
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
KmsKeyArn: jsii.String("kmsKeyArn"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnIdMappingTable ¶ added in v2.154.0
func NewCfnIdMappingTable(scope constructs.Construct, id *string, props *CfnIdMappingTableProps) CfnIdMappingTable
type CfnIdMappingTableProps ¶ added in v2.154.0
type CfnIdMappingTableProps struct {
// The input reference configuration for the ID mapping table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html#cfn-cleanrooms-idmappingtable-inputreferenceconfig
//
InputReferenceConfig interface{} `field:"required" json:"inputReferenceConfig" yaml:"inputReferenceConfig"`
// The unique identifier of the membership resource for the ID mapping table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html#cfn-cleanrooms-idmappingtable-membershipidentifier
//
MembershipIdentifier *string `field:"required" json:"membershipIdentifier" yaml:"membershipIdentifier"`
// The name of the ID mapping table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html#cfn-cleanrooms-idmappingtable-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The description of the ID mapping table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html#cfn-cleanrooms-idmappingtable-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The Amazon Resource Name (ARN) of the AWS KMS key.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idmappingtable.html#cfn-cleanrooms-idmappingtable-kmskeyarn
//
KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"`
// 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-idmappingtable.html#cfn-cleanrooms-idmappingtable-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnIdMappingTable`.
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"
cfnIdMappingTableProps := &CfnIdMappingTableProps{
InputReferenceConfig: &IdMappingTableInputReferenceConfigProperty{
InputReferenceArn: jsii.String("inputReferenceArn"),
ManageResourcePolicies: jsii.Boolean(false),
},
MembershipIdentifier: jsii.String("membershipIdentifier"),
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
KmsKeyArn: jsii.String("kmsKeyArn"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnIdMappingTable_IdMappingTableInputReferenceConfigProperty ¶ added in v2.154.0
type CfnIdMappingTable_IdMappingTableInputReferenceConfigProperty struct {
// The Amazon Resource Name (ARN) of the referenced resource in AWS Entity Resolution .
//
// Valid values are ID mapping workflow ARNs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idmappingtable-idmappingtableinputreferenceconfig.html#cfn-cleanrooms-idmappingtable-idmappingtableinputreferenceconfig-inputreferencearn
//
InputReferenceArn *string `field:"required" json:"inputReferenceArn" yaml:"inputReferenceArn"`
// When `TRUE` , AWS Clean Rooms manages permissions for the ID mapping table resource.
//
// When `FALSE` , the resource owner manages permissions for the ID mapping table resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idmappingtable-idmappingtableinputreferenceconfig.html#cfn-cleanrooms-idmappingtable-idmappingtableinputreferenceconfig-manageresourcepolicies
//
ManageResourcePolicies interface{} `field:"required" json:"manageResourcePolicies" yaml:"manageResourcePolicies"`
}
Provides the input reference configuration for the ID mapping 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"
idMappingTableInputReferenceConfigProperty := &IdMappingTableInputReferenceConfigProperty{
InputReferenceArn: jsii.String("inputReferenceArn"),
ManageResourcePolicies: jsii.Boolean(false),
}
type CfnIdMappingTable_IdMappingTableInputReferencePropertiesProperty ¶ added in v2.154.0
type CfnIdMappingTable_IdMappingTableInputReferencePropertiesProperty struct {
// The input source of the ID mapping table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idmappingtable-idmappingtableinputreferenceproperties.html#cfn-cleanrooms-idmappingtable-idmappingtableinputreferenceproperties-idmappingtableinputsource
//
IdMappingTableInputSource interface{} `field:"required" json:"idMappingTableInputSource" yaml:"idMappingTableInputSource"`
}
The input reference properties for the ID mapping 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"
idMappingTableInputReferencePropertiesProperty := &IdMappingTableInputReferencePropertiesProperty{
IdMappingTableInputSource: []interface{}{
&IdMappingTableInputSourceProperty{
IdNamespaceAssociationId: jsii.String("idNamespaceAssociationId"),
Type: jsii.String("type"),
},
},
}
type CfnIdMappingTable_IdMappingTableInputSourceProperty ¶ added in v2.154.0
type CfnIdMappingTable_IdMappingTableInputSourceProperty struct {
// The unique identifier of the ID namespace association.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idmappingtable-idmappingtableinputsource.html#cfn-cleanrooms-idmappingtable-idmappingtableinputsource-idnamespaceassociationid
//
IdNamespaceAssociationId *string `field:"required" json:"idNamespaceAssociationId" yaml:"idNamespaceAssociationId"`
// The type of the input source of the ID mapping table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idmappingtable-idmappingtableinputsource.html#cfn-cleanrooms-idmappingtable-idmappingtableinputsource-type
//
Type *string `field:"required" json:"type" yaml:"type"`
}
The input source of the ID mapping 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"
idMappingTableInputSourceProperty := &IdMappingTableInputSourceProperty{
IdNamespaceAssociationId: jsii.String("idNamespaceAssociationId"),
Type: jsii.String("type"),
}
type CfnIdNamespaceAssociation ¶ added in v2.154.0
type CfnIdNamespaceAssociation interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggableV2
// The Amazon Resource Name (ARN) of the ID namespace association.
AttrArn() *string
// The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association.
AttrCollaborationArn() *string
AttrCollaborationIdentifier() *string
AttrIdNamespaceAssociationIdentifier() *string
AttrInputReferenceProperties() awscdk.IResolvable
// The Amazon Resource Name (ARN) of the membership resource for this ID namespace association.
AttrMembershipArn() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// 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
// The description of the ID namespace association.
Description() *string
SetDescription(val *string)
// The configuration settings for the ID mapping table.
IdMappingConfig() interface{}
SetIdMappingConfig(val interface{})
// The input reference configuration for the ID namespace association.
InputReferenceConfig() interface{}
SetInputReferenceConfig(val interface{})
// 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 identifier of the membership that contains the ID namespace association.
MembershipIdentifier() *string
SetMembershipIdentifier(val *string)
// The name of this ID namespace association.
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
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{})
}
Provides information to create the ID namespace association.
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"
cfnIdNamespaceAssociation := awscdk.Aws_cleanrooms.NewCfnIdNamespaceAssociation(this, jsii.String("MyCfnIdNamespaceAssociation"), &CfnIdNamespaceAssociationProps{
InputReferenceConfig: &IdNamespaceAssociationInputReferenceConfigProperty{
InputReferenceArn: jsii.String("inputReferenceArn"),
ManageResourcePolicies: jsii.Boolean(false),
},
MembershipIdentifier: jsii.String("membershipIdentifier"),
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
IdMappingConfig: &IdMappingConfigProperty{
AllowUseAsDimensionColumn: jsii.Boolean(false),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnIdNamespaceAssociation ¶ added in v2.154.0
func NewCfnIdNamespaceAssociation(scope constructs.Construct, id *string, props *CfnIdNamespaceAssociationProps) CfnIdNamespaceAssociation
type CfnIdNamespaceAssociationProps ¶ added in v2.154.0
type CfnIdNamespaceAssociationProps struct {
// The input reference configuration for the ID namespace association.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#cfn-cleanrooms-idnamespaceassociation-inputreferenceconfig
//
InputReferenceConfig interface{} `field:"required" json:"inputReferenceConfig" yaml:"inputReferenceConfig"`
// The unique identifier of the membership that contains the ID namespace association.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#cfn-cleanrooms-idnamespaceassociation-membershipidentifier
//
MembershipIdentifier *string `field:"required" json:"membershipIdentifier" yaml:"membershipIdentifier"`
// The name of this ID namespace association.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#cfn-cleanrooms-idnamespaceassociation-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The description of the ID namespace association.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#cfn-cleanrooms-idnamespaceassociation-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The configuration settings for the ID mapping table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#cfn-cleanrooms-idnamespaceassociation-idmappingconfig
//
IdMappingConfig interface{} `field:"optional" json:"idMappingConfig" yaml:"idMappingConfig"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-idnamespaceassociation.html#cfn-cleanrooms-idnamespaceassociation-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnIdNamespaceAssociation`.
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"
cfnIdNamespaceAssociationProps := &CfnIdNamespaceAssociationProps{
InputReferenceConfig: &IdNamespaceAssociationInputReferenceConfigProperty{
InputReferenceArn: jsii.String("inputReferenceArn"),
ManageResourcePolicies: jsii.Boolean(false),
},
MembershipIdentifier: jsii.String("membershipIdentifier"),
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
IdMappingConfig: &IdMappingConfigProperty{
AllowUseAsDimensionColumn: jsii.Boolean(false),
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnIdNamespaceAssociation_IdMappingConfigProperty ¶ added in v2.154.0
type CfnIdNamespaceAssociation_IdMappingConfigProperty struct {
// An indicator as to whether you can use your column as a dimension column in the ID mapping table ( `TRUE` ) or not ( `FALSE` ).
//
// Default is `FALSE` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idnamespaceassociation-idmappingconfig.html#cfn-cleanrooms-idnamespaceassociation-idmappingconfig-allowuseasdimensioncolumn
//
AllowUseAsDimensionColumn interface{} `field:"required" json:"allowUseAsDimensionColumn" yaml:"allowUseAsDimensionColumn"`
}
The configuration settings for the ID mapping 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"
idMappingConfigProperty := &IdMappingConfigProperty{
AllowUseAsDimensionColumn: jsii.Boolean(false),
}
type CfnIdNamespaceAssociation_IdNamespaceAssociationInputReferenceConfigProperty ¶ added in v2.154.0
type CfnIdNamespaceAssociation_IdNamespaceAssociationInputReferenceConfigProperty struct {
// The Amazon Resource Name (ARN) of the AWS Entity Resolution resource that is being associated to the collaboration.
//
// Valid resource ARNs are from the ID namespaces that you own.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceconfig.html#cfn-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceconfig-inputreferencearn
//
InputReferenceArn *string `field:"required" json:"inputReferenceArn" yaml:"inputReferenceArn"`
// When `TRUE` , AWS Clean Rooms manages permissions for the ID namespace association resource.
//
// When `FALSE` , the resource owner manages permissions for the ID namespace association resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceconfig.html#cfn-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceconfig-manageresourcepolicies
//
ManageResourcePolicies interface{} `field:"required" json:"manageResourcePolicies" yaml:"manageResourcePolicies"`
}
Provides the information for the ID namespace association input reference configuration.
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"
idNamespaceAssociationInputReferenceConfigProperty := &IdNamespaceAssociationInputReferenceConfigProperty{
InputReferenceArn: jsii.String("inputReferenceArn"),
ManageResourcePolicies: jsii.Boolean(false),
}
type CfnIdNamespaceAssociation_IdNamespaceAssociationInputReferencePropertiesProperty ¶ added in v2.154.0
type CfnIdNamespaceAssociation_IdNamespaceAssociationInputReferencePropertiesProperty struct {
// Defines how ID mapping workflows are supported for this ID namespace association.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceproperties.html#cfn-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceproperties-idmappingworkflowssupported
//
IdMappingWorkflowsSupported interface{} `field:"optional" json:"idMappingWorkflowsSupported" yaml:"idMappingWorkflowsSupported"`
// The ID namespace type for this ID namespace association.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceproperties.html#cfn-cleanrooms-idnamespaceassociation-idnamespaceassociationinputreferenceproperties-idnamespacetype
//
IdNamespaceType *string `field:"optional" json:"idNamespaceType" yaml:"idNamespaceType"`
}
Provides the information for the ID namespace association input reference properties.
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"
var idMappingWorkflowsSupported interface{}
idNamespaceAssociationInputReferencePropertiesProperty := &IdNamespaceAssociationInputReferencePropertiesProperty{
IdMappingWorkflowsSupported: []interface{}{
idMappingWorkflowsSupported,
},
IdNamespaceType: jsii.String("idNamespaceType"),
}
type CfnMembership ¶
type CfnMembership interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggableV2
// 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
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// 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 default protected query result configuration as specified by the member who can receive results.
DefaultResultConfiguration() interface{}
SetDefaultResultConfiguration(val interface{})
// 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
// The payment responsibilities accepted by the collaboration member.
PaymentConfiguration() interface{}
SetPaymentConfiguration(val interface{})
// An indicator as to whether query logging has been enabled or disabled for the membership.
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
DefaultResultConfiguration: &MembershipProtectedQueryResultConfigurationProperty{
OutputConfiguration: &MembershipProtectedQueryOutputConfigurationProperty{
S3: &ProtectedQueryS3OutputConfigurationProperty{
Bucket: jsii.String("bucket"),
ResultFormat: jsii.String("resultFormat"),
// the properties below are optional
KeyPrefix: jsii.String("keyPrefix"),
},
},
// the properties below are optional
RoleArn: jsii.String("roleArn"),
},
PaymentConfiguration: &MembershipPaymentConfigurationProperty{
QueryCompute: &MembershipQueryComputePaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
},
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 membership.
// 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"`
// The default protected query result configuration as specified by the member who can receive results.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-defaultresultconfiguration
//
DefaultResultConfiguration interface{} `field:"optional" json:"defaultResultConfiguration" yaml:"defaultResultConfiguration"`
// The payment responsibilities accepted by the collaboration member.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-membership.html#cfn-cleanrooms-membership-paymentconfiguration
//
PaymentConfiguration interface{} `field:"optional" json:"paymentConfiguration" yaml:"paymentConfiguration"`
// 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
DefaultResultConfiguration: &MembershipProtectedQueryResultConfigurationProperty{
OutputConfiguration: &MembershipProtectedQueryOutputConfigurationProperty{
S3: &ProtectedQueryS3OutputConfigurationProperty{
Bucket: jsii.String("bucket"),
ResultFormat: jsii.String("resultFormat"),
// the properties below are optional
KeyPrefix: jsii.String("keyPrefix"),
},
},
// the properties below are optional
RoleArn: jsii.String("roleArn"),
},
PaymentConfiguration: &MembershipPaymentConfigurationProperty{
QueryCompute: &MembershipQueryComputePaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnMembership_MembershipPaymentConfigurationProperty ¶ added in v2.112.0
type CfnMembership_MembershipPaymentConfigurationProperty struct {
// The payment responsibilities accepted by the collaboration member for query compute costs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershippaymentconfiguration.html#cfn-cleanrooms-membership-membershippaymentconfiguration-querycompute
//
QueryCompute interface{} `field:"required" json:"queryCompute" yaml:"queryCompute"`
}
An object representing the payment responsibilities accepted by the collaboration 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"
membershipPaymentConfigurationProperty := &MembershipPaymentConfigurationProperty{
QueryCompute: &MembershipQueryComputePaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
},
}
type CfnMembership_MembershipProtectedQueryOutputConfigurationProperty ¶ added in v2.97.0
type CfnMembership_MembershipProtectedQueryOutputConfigurationProperty struct {
// Required configuration for a protected query with an `s3` output type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedqueryoutputconfiguration.html#cfn-cleanrooms-membership-membershipprotectedqueryoutputconfiguration-s3
//
S3 interface{} `field:"required" json:"s3" yaml:"s3"`
}
Contains configurations for protected query results.
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"
membershipProtectedQueryOutputConfigurationProperty := &MembershipProtectedQueryOutputConfigurationProperty{
S3: &ProtectedQueryS3OutputConfigurationProperty{
Bucket: jsii.String("bucket"),
ResultFormat: jsii.String("resultFormat"),
// the properties below are optional
KeyPrefix: jsii.String("keyPrefix"),
},
}
type CfnMembership_MembershipProtectedQueryResultConfigurationProperty ¶ added in v2.97.0
type CfnMembership_MembershipProtectedQueryResultConfigurationProperty struct {
// Configuration for protected query results.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedqueryresultconfiguration.html#cfn-cleanrooms-membership-membershipprotectedqueryresultconfiguration-outputconfiguration
//
OutputConfiguration interface{} `field:"required" json:"outputConfiguration" yaml:"outputConfiguration"`
// The unique ARN for an IAM role that is used by AWS Clean Rooms to write protected query results to the result location, given by the member who can receive results.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipprotectedqueryresultconfiguration.html#cfn-cleanrooms-membership-membershipprotectedqueryresultconfiguration-rolearn
//
RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"`
}
Contains configurations for protected query results.
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"
membershipProtectedQueryResultConfigurationProperty := &MembershipProtectedQueryResultConfigurationProperty{
OutputConfiguration: &MembershipProtectedQueryOutputConfigurationProperty{
S3: &ProtectedQueryS3OutputConfigurationProperty{
Bucket: jsii.String("bucket"),
ResultFormat: jsii.String("resultFormat"),
// the properties below are optional
KeyPrefix: jsii.String("keyPrefix"),
},
},
// the properties below are optional
RoleArn: jsii.String("roleArn"),
}
type CfnMembership_MembershipQueryComputePaymentConfigProperty ¶ added in v2.112.0
type CfnMembership_MembershipQueryComputePaymentConfigProperty struct {
// Indicates whether the collaboration member has accepted to pay for query compute costs ( `TRUE` ) or has not accepted to pay for query compute costs ( `FALSE` ).
//
// If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer.
//
// An error message is returned for the following reasons:
//
// - If you set the value to `FALSE` but you are responsible to pay for query compute costs.
// - If you set the value to `TRUE` but you are not responsible to pay for query compute costs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-membershipquerycomputepaymentconfig.html#cfn-cleanrooms-membership-membershipquerycomputepaymentconfig-isresponsible
//
IsResponsible interface{} `field:"required" json:"isResponsible" yaml:"isResponsible"`
}
An object representing the payment responsibilities accepted by the collaboration member for query compute costs.
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"
membershipQueryComputePaymentConfigProperty := &MembershipQueryComputePaymentConfigProperty{
IsResponsible: jsii.Boolean(false),
}
type CfnMembership_ProtectedQueryS3OutputConfigurationProperty ¶ added in v2.97.0
type CfnMembership_ProtectedQueryS3OutputConfigurationProperty struct {
// The S3 bucket to unload the protected query results.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedquerys3outputconfiguration.html#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-bucket
//
Bucket *string `field:"required" json:"bucket" yaml:"bucket"`
// Intended file format of the result.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedquerys3outputconfiguration.html#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-resultformat
//
ResultFormat *string `field:"required" json:"resultFormat" yaml:"resultFormat"`
// The S3 prefix to unload the protected query results.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-membership-protectedquerys3outputconfiguration.html#cfn-cleanrooms-membership-protectedquerys3outputconfiguration-keyprefix
//
KeyPrefix *string `field:"optional" json:"keyPrefix" yaml:"keyPrefix"`
}
Contains the configuration to write the query results to S3.
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"
protectedQueryS3OutputConfigurationProperty := &ProtectedQueryS3OutputConfigurationProperty{
Bucket: jsii.String("bucket"),
ResultFormat: jsii.String("resultFormat"),
// the properties below are optional
KeyPrefix: jsii.String("keyPrefix"),
}
type CfnPrivacyBudgetTemplate ¶ added in v2.138.0
type CfnPrivacyBudgetTemplate interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggableV2
// The ARN of the privacy budget template.
AttrArn() *string
// The ARN of the collaboration that contains this privacy budget template.
AttrCollaborationArn() *string
// The unique ID of the collaboration that contains this privacy budget template.
AttrCollaborationIdentifier() *string
// The Amazon Resource Name (ARN) of the member who created the privacy budget template.
AttrMembershipArn() *string
// A unique identifier for one of your memberships for a collaboration.
//
// The privacy budget template is created in the collaboration that this membership belongs to. Accepts a membership ID.
AttrPrivacyBudgetTemplateIdentifier() *string
// How often the privacy budget refreshes.
AutoRefresh() *string
SetAutoRefresh(val *string)
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// 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
// 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 identifier for a membership resource.
MembershipIdentifier() *string
SetMembershipIdentifier(val *string)
// The tree node.
Node() constructs.Node
// Specifies the epsilon and noise parameters for the privacy budget template.
Parameters() interface{}
SetParameters(val interface{})
// Specifies the type of the privacy budget template.
PrivacyBudgetType() *string
SetPrivacyBudgetType(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 arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.
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{})
}
An object that defines the privacy budget template.
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"
cfnPrivacyBudgetTemplate := awscdk.Aws_cleanrooms.NewCfnPrivacyBudgetTemplate(this, jsii.String("MyCfnPrivacyBudgetTemplate"), &CfnPrivacyBudgetTemplateProps{
AutoRefresh: jsii.String("autoRefresh"),
MembershipIdentifier: jsii.String("membershipIdentifier"),
Parameters: &ParametersProperty{
Epsilon: jsii.Number(123),
UsersNoisePerQuery: jsii.Number(123),
},
PrivacyBudgetType: jsii.String("privacyBudgetType"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnPrivacyBudgetTemplate ¶ added in v2.138.0
func NewCfnPrivacyBudgetTemplate(scope constructs.Construct, id *string, props *CfnPrivacyBudgetTemplateProps) CfnPrivacyBudgetTemplate
type CfnPrivacyBudgetTemplateProps ¶ added in v2.138.0
type CfnPrivacyBudgetTemplateProps struct {
// How often the privacy budget refreshes.
//
// > If you plan to regularly bring new data into the collaboration, use `CALENDAR_MONTH` to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#cfn-cleanrooms-privacybudgettemplate-autorefresh
//
AutoRefresh *string `field:"required" json:"autoRefresh" yaml:"autoRefresh"`
// The identifier for a membership resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#cfn-cleanrooms-privacybudgettemplate-membershipidentifier
//
MembershipIdentifier *string `field:"required" json:"membershipIdentifier" yaml:"membershipIdentifier"`
// Specifies the epsilon and noise parameters for the privacy budget template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#cfn-cleanrooms-privacybudgettemplate-parameters
//
Parameters interface{} `field:"required" json:"parameters" yaml:"parameters"`
// Specifies the type of the privacy budget template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#cfn-cleanrooms-privacybudgettemplate-privacybudgettype
//
PrivacyBudgetType *string `field:"required" json:"privacyBudgetType" yaml:"privacyBudgetType"`
// An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-privacybudgettemplate.html#cfn-cleanrooms-privacybudgettemplate-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnPrivacyBudgetTemplate`.
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"
cfnPrivacyBudgetTemplateProps := &CfnPrivacyBudgetTemplateProps{
AutoRefresh: jsii.String("autoRefresh"),
MembershipIdentifier: jsii.String("membershipIdentifier"),
Parameters: &ParametersProperty{
Epsilon: jsii.Number(123),
UsersNoisePerQuery: jsii.Number(123),
},
PrivacyBudgetType: jsii.String("privacyBudgetType"),
// the properties below are optional
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnPrivacyBudgetTemplate_ParametersProperty ¶ added in v2.138.0
type CfnPrivacyBudgetTemplate_ParametersProperty struct {
// The epsilon value that you want to use.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-privacybudgettemplate-parameters.html#cfn-cleanrooms-privacybudgettemplate-parameters-epsilon
//
Epsilon *float64 `field:"required" json:"epsilon" yaml:"epsilon"`
// Noise added per query is measured in terms of the number of users whose contributions you want to obscure.
//
// This value governs the rate at which the privacy budget is depleted.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-privacybudgettemplate-parameters.html#cfn-cleanrooms-privacybudgettemplate-parameters-usersnoiseperquery
//
UsersNoisePerQuery *float64 `field:"required" json:"usersNoisePerQuery" yaml:"usersNoisePerQuery"`
}
Specifies the epsilon and noise parameters for the privacy budget template.
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"
parametersProperty := &ParametersProperty{
Epsilon: jsii.Number(123),
UsersNoisePerQuery: jsii.Number(123),
}
Source Files
¶
- CfnAnalysisTemplate.go
- CfnAnalysisTemplateProps.go
- CfnAnalysisTemplate_AnalysisParameterProperty.go
- CfnAnalysisTemplate_AnalysisSchemaProperty.go
- CfnAnalysisTemplate_AnalysisSourceProperty.go
- CfnAnalysisTemplate__checks.go
- CfnCollaboration.go
- CfnCollaborationProps.go
- CfnCollaboration_DataEncryptionMetadataProperty.go
- CfnCollaboration_MemberSpecificationProperty.go
- CfnCollaboration_PaymentConfigurationProperty.go
- CfnCollaboration_QueryComputePaymentConfigProperty.go
- CfnCollaboration__checks.go
- CfnConfiguredTable.go
- CfnConfiguredTableAssociation.go
- CfnConfiguredTableAssociationProps.go
- CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRuleAggregationProperty.go
- CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRuleCustomProperty.go
- CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRuleListProperty.go
- CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRulePolicyProperty.go
- CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRulePolicyV1Property.go
- CfnConfiguredTableAssociation_ConfiguredTableAssociationAnalysisRuleProperty.go
- CfnConfiguredTableAssociation__checks.go
- CfnConfiguredTableProps.go
- CfnConfiguredTable_AggregateColumnProperty.go
- CfnConfiguredTable_AggregationConstraintProperty.go
- CfnConfiguredTable_AnalysisRuleAggregationProperty.go
- CfnConfiguredTable_AnalysisRuleCustomProperty.go
- CfnConfiguredTable_AnalysisRuleListProperty.go
- CfnConfiguredTable_AnalysisRuleProperty.go
- CfnConfiguredTable_ConfiguredTableAnalysisRulePolicyProperty.go
- CfnConfiguredTable_ConfiguredTableAnalysisRulePolicyV1Property.go
- CfnConfiguredTable_DifferentialPrivacyColumnProperty.go
- CfnConfiguredTable_DifferentialPrivacyProperty.go
- CfnConfiguredTable_GlueTableReferenceProperty.go
- CfnConfiguredTable_TableReferenceProperty.go
- CfnConfiguredTable__checks.go
- CfnIdMappingTable.go
- CfnIdMappingTableProps.go
- CfnIdMappingTable_IdMappingTableInputReferenceConfigProperty.go
- CfnIdMappingTable_IdMappingTableInputReferencePropertiesProperty.go
- CfnIdMappingTable_IdMappingTableInputSourceProperty.go
- CfnIdMappingTable__checks.go
- CfnIdNamespaceAssociation.go
- CfnIdNamespaceAssociationProps.go
- CfnIdNamespaceAssociation_IdMappingConfigProperty.go
- CfnIdNamespaceAssociation_IdNamespaceAssociationInputReferenceConfigProperty.go
- CfnIdNamespaceAssociation_IdNamespaceAssociationInputReferencePropertiesProperty.go
- CfnIdNamespaceAssociation__checks.go
- CfnMembership.go
- CfnMembershipProps.go
- CfnMembership_MembershipPaymentConfigurationProperty.go
- CfnMembership_MembershipProtectedQueryOutputConfigurationProperty.go
- CfnMembership_MembershipProtectedQueryResultConfigurationProperty.go
- CfnMembership_MembershipQueryComputePaymentConfigProperty.go
- CfnMembership_ProtectedQueryS3OutputConfigurationProperty.go
- CfnMembership__checks.go
- CfnPrivacyBudgetTemplate.go
- CfnPrivacyBudgetTemplateProps.go
- CfnPrivacyBudgetTemplate_ParametersProperty.go
- CfnPrivacyBudgetTemplate__checks.go
- main.go
Directories
Click to show internal directories.
Click to hide internal directories.