Documentation ¶
Index ¶
- func CfnDataCellsFilter_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDataCellsFilter_IsCfnElement(x interface{}) *bool
- func CfnDataCellsFilter_IsCfnResource(x interface{}) *bool
- func CfnDataCellsFilter_IsConstruct(x interface{}) *bool
- func CfnDataLakeSettings_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDataLakeSettings_IsCfnElement(x interface{}) *bool
- func CfnDataLakeSettings_IsCfnResource(x interface{}) *bool
- func CfnDataLakeSettings_IsConstruct(x interface{}) *bool
- func CfnPermissions_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPermissions_IsCfnElement(x interface{}) *bool
- func CfnPermissions_IsCfnResource(x interface{}) *bool
- func CfnPermissions_IsConstruct(x interface{}) *bool
- func CfnPrincipalPermissions_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPrincipalPermissions_IsCfnElement(x interface{}) *bool
- func CfnPrincipalPermissions_IsCfnResource(x interface{}) *bool
- func CfnPrincipalPermissions_IsConstruct(x interface{}) *bool
- func CfnResource_CFN_RESOURCE_TYPE_NAME() *string
- func CfnResource_IsCfnElement(x interface{}) *bool
- func CfnResource_IsCfnResource(x interface{}) *bool
- func CfnResource_IsConstruct(x interface{}) *bool
- func CfnTagAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTagAssociation_IsCfnElement(x interface{}) *bool
- func CfnTagAssociation_IsCfnResource(x interface{}) *bool
- func CfnTagAssociation_IsConstruct(x interface{}) *bool
- func CfnTag_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTag_IsCfnElement(x interface{}) *bool
- func CfnTag_IsCfnResource(x interface{}) *bool
- func CfnTag_IsConstruct(x interface{}) *bool
- func NewCfnDataCellsFilter_Override(c CfnDataCellsFilter, scope constructs.Construct, id *string, ...)
- func NewCfnDataLakeSettings_Override(c CfnDataLakeSettings, scope constructs.Construct, id *string, ...)
- func NewCfnPermissions_Override(c CfnPermissions, scope constructs.Construct, id *string, ...)
- func NewCfnPrincipalPermissions_Override(c CfnPrincipalPermissions, scope constructs.Construct, id *string, ...)
- func NewCfnResource_Override(c CfnResource, scope constructs.Construct, id *string, props *CfnResourceProps)
- func NewCfnTagAssociation_Override(c CfnTagAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnTag_Override(c CfnTag, scope constructs.Construct, id *string, props *CfnTagProps)
- type CfnDataCellsFilter
- type CfnDataCellsFilterProps
- type CfnDataCellsFilter_ColumnWildcardProperty
- type CfnDataCellsFilter_RowFilterProperty
- type CfnDataLakeSettings
- type CfnDataLakeSettingsProps
- type CfnDataLakeSettings_DataLakePrincipalProperty
- type CfnDataLakeSettings_PrincipalPermissionsProperty
- type CfnPermissions
- type CfnPermissionsProps
- type CfnPermissions_ColumnWildcardProperty
- type CfnPermissions_DataLakePrincipalProperty
- type CfnPermissions_DataLocationResourceProperty
- type CfnPermissions_DatabaseResourceProperty
- type CfnPermissions_ResourceProperty
- type CfnPermissions_TableResourceProperty
- type CfnPermissions_TableWildcardProperty
- type CfnPermissions_TableWithColumnsResourceProperty
- type CfnPrincipalPermissions
- type CfnPrincipalPermissionsProps
- type CfnPrincipalPermissions_ColumnWildcardProperty
- type CfnPrincipalPermissions_DataCellsFilterResourceProperty
- type CfnPrincipalPermissions_DataLakePrincipalProperty
- type CfnPrincipalPermissions_DataLocationResourceProperty
- type CfnPrincipalPermissions_DatabaseResourceProperty
- type CfnPrincipalPermissions_LFTagKeyResourceProperty
- type CfnPrincipalPermissions_LFTagPolicyResourceProperty
- type CfnPrincipalPermissions_LFTagProperty
- type CfnPrincipalPermissions_ResourceProperty
- type CfnPrincipalPermissions_TableResourceProperty
- type CfnPrincipalPermissions_TableWithColumnsResourceProperty
- type CfnResource
- type CfnResourceProps
- type CfnTag
- type CfnTagAssociation
- type CfnTagAssociationProps
- type CfnTagAssociation_DatabaseResourceProperty
- type CfnTagAssociation_LFTagPairProperty
- type CfnTagAssociation_ResourceProperty
- type CfnTagAssociation_TableResourceProperty
- type CfnTagAssociation_TableWithColumnsResourceProperty
- type CfnTagProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnDataCellsFilter_CFN_RESOURCE_TYPE_NAME ¶ added in v2.31.0
func CfnDataCellsFilter_CFN_RESOURCE_TYPE_NAME() *string
func CfnDataCellsFilter_IsCfnElement ¶ added in v2.31.0
func CfnDataCellsFilter_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 CfnDataCellsFilter_IsCfnResource ¶ added in v2.31.0
func CfnDataCellsFilter_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDataCellsFilter_IsConstruct ¶ added in v2.31.0
func CfnDataCellsFilter_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 CfnDataLakeSettings_CFN_RESOURCE_TYPE_NAME ¶
func CfnDataLakeSettings_CFN_RESOURCE_TYPE_NAME() *string
func CfnDataLakeSettings_IsCfnElement ¶
func CfnDataLakeSettings_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 CfnDataLakeSettings_IsCfnResource ¶
func CfnDataLakeSettings_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDataLakeSettings_IsConstruct ¶
func CfnDataLakeSettings_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 CfnPermissions_CFN_RESOURCE_TYPE_NAME ¶
func CfnPermissions_CFN_RESOURCE_TYPE_NAME() *string
func CfnPermissions_IsCfnElement ¶
func CfnPermissions_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 CfnPermissions_IsCfnResource ¶
func CfnPermissions_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPermissions_IsConstruct ¶
func CfnPermissions_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 CfnPrincipalPermissions_CFN_RESOURCE_TYPE_NAME ¶ added in v2.31.0
func CfnPrincipalPermissions_CFN_RESOURCE_TYPE_NAME() *string
func CfnPrincipalPermissions_IsCfnElement ¶ added in v2.31.0
func CfnPrincipalPermissions_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 CfnPrincipalPermissions_IsCfnResource ¶ added in v2.31.0
func CfnPrincipalPermissions_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPrincipalPermissions_IsConstruct ¶ added in v2.31.0
func CfnPrincipalPermissions_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 CfnResource_CFN_RESOURCE_TYPE_NAME ¶
func CfnResource_CFN_RESOURCE_TYPE_NAME() *string
func CfnResource_IsCfnElement ¶
func CfnResource_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 CfnResource_IsCfnResource ¶
func CfnResource_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnResource_IsConstruct ¶
func CfnResource_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 CfnTagAssociation_CFN_RESOURCE_TYPE_NAME ¶ added in v2.31.0
func CfnTagAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnTagAssociation_IsCfnElement ¶ added in v2.31.0
func CfnTagAssociation_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 CfnTagAssociation_IsCfnResource ¶ added in v2.31.0
func CfnTagAssociation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTagAssociation_IsConstruct ¶ added in v2.31.0
func CfnTagAssociation_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 CfnTag_CFN_RESOURCE_TYPE_NAME ¶ added in v2.31.0
func CfnTag_CFN_RESOURCE_TYPE_NAME() *string
func CfnTag_IsCfnElement ¶ added in v2.31.0
func CfnTag_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 CfnTag_IsCfnResource ¶ added in v2.31.0
func CfnTag_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTag_IsConstruct ¶ added in v2.31.0
func CfnTag_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 NewCfnDataCellsFilter_Override ¶ added in v2.31.0
func NewCfnDataCellsFilter_Override(c CfnDataCellsFilter, scope constructs.Construct, id *string, props *CfnDataCellsFilterProps)
func NewCfnDataLakeSettings_Override ¶
func NewCfnDataLakeSettings_Override(c CfnDataLakeSettings, scope constructs.Construct, id *string, props *CfnDataLakeSettingsProps)
func NewCfnPermissions_Override ¶
func NewCfnPermissions_Override(c CfnPermissions, scope constructs.Construct, id *string, props *CfnPermissionsProps)
func NewCfnPrincipalPermissions_Override ¶ added in v2.31.0
func NewCfnPrincipalPermissions_Override(c CfnPrincipalPermissions, scope constructs.Construct, id *string, props *CfnPrincipalPermissionsProps)
func NewCfnResource_Override ¶
func NewCfnResource_Override(c CfnResource, scope constructs.Construct, id *string, props *CfnResourceProps)
func NewCfnTagAssociation_Override ¶ added in v2.31.0
func NewCfnTagAssociation_Override(c CfnTagAssociation, scope constructs.Construct, id *string, props *CfnTagAssociationProps)
func NewCfnTag_Override ¶ added in v2.31.0
func NewCfnTag_Override(c CfnTag, scope constructs.Construct, id *string, props *CfnTagProps)
Types ¶
type CfnDataCellsFilter ¶ added in v2.31.0
type CfnDataCellsFilter interface { awscdk.CfnResource awscdk.IInspectable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // An array of UTF-8 strings. ColumnNames() *[]*string SetColumnNames(val *[]*string) // A wildcard with exclusions. ColumnWildcard() interface{} SetColumnWildcard(val interface{}) // 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 // UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html) . DatabaseName() *string SetDatabaseName(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 // UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html) . 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 // A PartiQL predicate. RowFilter() interface{} SetRowFilter(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Catalog id string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html) . TableCatalogId() *string SetTableCatalogId(val *string) // UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html) . TableName() *string SetTableName(val *string) // 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{}) }
A structure that represents a data cell filter with column-level, row-level, and/or cell-level security.
Data cell filters belong to a specific table in a Data Catalog . During a stack operation, AWS CloudFormation calls the AWS Lake Formation `CreateDataCellsFilter` API operation to create a `DataCellsFilter` resource, and calls the `DeleteDataCellsFilter` API operation to delete it.
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 allRowsWildcard interface{} cfnDataCellsFilter := awscdk.Aws_lakeformation.NewCfnDataCellsFilter(this, jsii.String("MyCfnDataCellsFilter"), &CfnDataCellsFilterProps{ DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), TableCatalogId: jsii.String("tableCatalogId"), TableName: jsii.String("tableName"), // the properties below are optional ColumnNames: []*string{ jsii.String("columnNames"), }, ColumnWildcard: &ColumnWildcardProperty{ ExcludedColumnNames: []*string{ jsii.String("excludedColumnNames"), }, }, RowFilter: &RowFilterProperty{ AllRowsWildcard: allRowsWildcard, FilterExpression: jsii.String("filterExpression"), }, })
func NewCfnDataCellsFilter ¶ added in v2.31.0
func NewCfnDataCellsFilter(scope constructs.Construct, id *string, props *CfnDataCellsFilterProps) CfnDataCellsFilter
type CfnDataCellsFilterProps ¶ added in v2.31.0
type CfnDataCellsFilterProps struct { // UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html) . // // A database in the Data Catalog . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-databasename // DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html) . // // The name given by the user to the data filter cell. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-name // Name *string `field:"required" json:"name" yaml:"name"` // Catalog id string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html) . // // The ID of the catalog to which the table belongs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-tablecatalogid // TableCatalogId *string `field:"required" json:"tableCatalogId" yaml:"tableCatalogId"` // UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html) . // // A table in the database. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-tablename // TableName *string `field:"required" json:"tableName" yaml:"tableName"` // An array of UTF-8 strings. // // A list of column names. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-columnnames // ColumnNames *[]*string `field:"optional" json:"columnNames" yaml:"columnNames"` // A wildcard with exclusions. // // You must specify either a `ColumnNames` list or the `ColumnWildCard` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-columnwildcard // ColumnWildcard interface{} `field:"optional" json:"columnWildcard" yaml:"columnWildcard"` // A PartiQL predicate. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datacellsfilter.html#cfn-lakeformation-datacellsfilter-rowfilter // RowFilter interface{} `field:"optional" json:"rowFilter" yaml:"rowFilter"` }
Properties for defining a `CfnDataCellsFilter`.
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 allRowsWildcard interface{} cfnDataCellsFilterProps := &CfnDataCellsFilterProps{ DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), TableCatalogId: jsii.String("tableCatalogId"), TableName: jsii.String("tableName"), // the properties below are optional ColumnNames: []*string{ jsii.String("columnNames"), }, ColumnWildcard: &ColumnWildcardProperty{ ExcludedColumnNames: []*string{ jsii.String("excludedColumnNames"), }, }, RowFilter: &RowFilterProperty{ AllRowsWildcard: allRowsWildcard, FilterExpression: jsii.String("filterExpression"), }, }
type CfnDataCellsFilter_ColumnWildcardProperty ¶ added in v2.31.0
type CfnDataCellsFilter_ColumnWildcardProperty struct { // Excludes column names. // // Any column with this name will be excluded. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datacellsfilter-columnwildcard.html#cfn-lakeformation-datacellsfilter-columnwildcard-excludedcolumnnames // ExcludedColumnNames *[]*string `field:"optional" json:"excludedColumnNames" yaml:"excludedColumnNames"` }
A wildcard object, consisting of an optional list of excluded column names or indexes.
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" columnWildcardProperty := &ColumnWildcardProperty{ ExcludedColumnNames: []*string{ jsii.String("excludedColumnNames"), }, }
type CfnDataCellsFilter_RowFilterProperty ¶ added in v2.31.0
type CfnDataCellsFilter_RowFilterProperty struct { // A wildcard for all rows. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datacellsfilter-rowfilter.html#cfn-lakeformation-datacellsfilter-rowfilter-allrowswildcard // AllRowsWildcard interface{} `field:"optional" json:"allRowsWildcard" yaml:"allRowsWildcard"` // A filter expression. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datacellsfilter-rowfilter.html#cfn-lakeformation-datacellsfilter-rowfilter-filterexpression // FilterExpression *string `field:"optional" json:"filterExpression" yaml:"filterExpression"` }
A PartiQL predicate.
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 allRowsWildcard interface{} rowFilterProperty := &RowFilterProperty{ AllRowsWildcard: allRowsWildcard, FilterExpression: jsii.String("filterExpression"), }
type CfnDataLakeSettings ¶
type CfnDataLakeSettings interface { awscdk.CfnResource awscdk.IInspectable // A list of AWS Lake Formation principals. Admins() interface{} SetAdmins(val interface{}) // Whether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation . AllowExternalDataFiltering() interface{} SetAllowExternalDataFiltering(val interface{}) // Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access. AllowFullTableExternalDataAccess() interface{} SetAllowFullTableExternalDataAccess(val interface{}) AttrId() *string // Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it. AuthorizedSessionTagValueList() *[]*string SetAuthorizedSessionTagValueList(val *[]*string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions. CreateDatabaseDefaultPermissions() interface{} SetCreateDatabaseDefaultPermissions(val interface{}) // Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions. CreateTableDefaultPermissions() interface{} SetCreateTableDefaultPermissions(val interface{}) // 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 list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering. ExternalDataFilteringAllowList() interface{} SetExternalDataFilteringAllowList(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 // Specifies whether the data lake settings are updated by adding new values to the current settings ( `APPEND` ) or by replacing the current settings with new settings ( `REPLACE` ). MutationType() *string SetMutationType(val *string) // The tree node. Node() constructs.Node // A key-value map that provides an additional configuration on your data lake. Parameters() interface{} SetParameters(val interface{}) // 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 array of UTF-8 strings. TrustedResourceOwners() *[]*string SetTrustedResourceOwners(val *[]*string) // 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{}) }
The `AWS::LakeFormation::DataLakeSettings` resource is an AWS Lake Formation resource type that manages the data lake settings for your account.
Example:
import cdk "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdkgluealpha" import "github.com/aws/aws-cdk-go/awscdk" var stack stack var accountId string tagKey := "aws" tagValues := []*string{ "dev", } database := awscdkgluealpha.NewDatabase(this, jsii.String("Database")) table := awscdkgluealpha.NewS3Table(this, jsii.String("Table"), &S3TableProps{ Database: Database, Columns: []column{ &column{ Name: jsii.String("col1"), Type: awscdkgluealpha.Schema_STRING(), }, &column{ Name: jsii.String("col2"), Type: awscdkgluealpha.Schema_STRING(), }, }, DataFormat: awscdkgluealpha.DataFormat_CSV(), }) synthesizer := stack.Synthesizer.(defaultStackSynthesizer) awscdk.NewCfnDataLakeSettings(this, jsii.String("DataLakeSettings"), &CfnDataLakeSettingsProps{ Admins: []interface{}{ &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: stack.FormatArn(&ArnComponents{ Service: jsii.String("iam"), Resource: jsii.String("role"), Region: jsii.String(""), Account: accountId, ResourceName: jsii.String("Admin"), }), }, &DataLakePrincipalProperty{ // The CDK cloudformation execution role. DataLakePrincipalIdentifier: synthesizer.cloudFormationExecutionRoleArn.replace(jsii.String("${AWS::Partition}"), jsii.String("aws")), }, }, }) tag := awscdk.NewCfnTag(this, jsii.String("Tag"), &CfnTagProps{ CatalogId: accountId, TagKey: jsii.String(TagKey), TagValues: TagValues, }) lfTagPairProperty := &LFTagPairProperty{ CatalogId: accountId, TagKey: jsii.String(TagKey), TagValues: TagValues, } tagAssociation := awscdk.NewCfnTagAssociation(this, jsii.String("TagAssociation"), &CfnTagAssociationProps{ LfTags: []interface{}{ lfTagPairProperty, }, Resource: &ResourceProperty{ TableWithColumns: &TableWithColumnsResourceProperty{ DatabaseName: database.DatabaseName, ColumnNames: []*string{ jsii.String("col1"), jsii.String("col2"), }, CatalogId: accountId, Name: table.TableName, }, }, }) tagAssociation.Node.AddDependency(tag) tagAssociation.Node.AddDependency(table)
func NewCfnDataLakeSettings ¶
func NewCfnDataLakeSettings(scope constructs.Construct, id *string, props *CfnDataLakeSettingsProps) CfnDataLakeSettings
type CfnDataLakeSettingsProps ¶
type CfnDataLakeSettingsProps struct { // A list of AWS Lake Formation principals. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-admins // Admins interface{} `field:"optional" json:"admins" yaml:"admins"` // Whether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation . // // If set to true, you allow Amazon EMR clusters or other third-party engines to access data in Amazon S3 locations that are registered with Lake Formation . // // If false or null, no third-party query engines will be able to access data in Amazon S3 locations that are registered with Lake Formation. // // For more information, see [External data filtering setting](https://docs.aws.amazon.com/lake-formation/latest/dg/initial-LF-setup.html#external-data-filter) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-allowexternaldatafiltering // AllowExternalDataFiltering interface{} `field:"optional" json:"allowExternalDataFiltering" yaml:"allowExternalDataFiltering"` // Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access. // // It provides query engines and applications performance benefits as well as simplifies data access. Amazon EMR on Amazon EC2 is able to leverage this setting. // // For more information, see [](https://docs.aws.amazon.com/lake-formation/latest/dg/using-cred-vending.html) // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-allowfulltableexternaldataaccess // AllowFullTableExternalDataAccess interface{} `field:"optional" json:"allowFullTableExternalDataAccess" yaml:"allowFullTableExternalDataAccess"` // Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it. // // Lake Formation will publish the acceptable key-value pair, for example key = "LakeFormationTrustedCaller" and value = "TRUE" and the third party integrator must properly tag the temporary security credentials that will be used to call Lake Formation 's administrative API operations. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-authorizedsessiontagvaluelist // AuthorizedSessionTagValueList *[]*string `field:"optional" json:"authorizedSessionTagValueList" yaml:"authorizedSessionTagValueList"` // Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions. // // A null value indicates that the access is controlled by Lake Formation permissions. `ALL` permissions assigned to `IAM_ALLOWED_PRINCIPALS` group indicates that the user's IAM permissions determine the access to the database. This is referred to as the setting "Use only IAM access control," and is to support backward compatibility with the AWS Glue permission model implemented by IAM permissions. // // The only permitted values are an empty array or an array that contains a single JSON object that grants `ALL` to `IAM_ALLOWED_PRINCIPALS` . // // For more information, see [Changing the default security settings for your data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-createdatabasedefaultpermissions // CreateDatabaseDefaultPermissions interface{} `field:"optional" json:"createDatabaseDefaultPermissions" yaml:"createDatabaseDefaultPermissions"` // Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions. // // A null value indicates that the access is controlled by Lake Formation permissions. `ALL` permissions assigned to `IAM_ALLOWED_PRINCIPALS` group indicate that the user's IAM permissions determine the access to the table. This is referred to as the setting "Use only IAM access control," and is to support the backward compatibility with the AWS Glue permission model implemented by IAM permissions. // // The only permitted values are an empty array or an array that contains a single JSON object that grants `ALL` permissions to `IAM_ALLOWED_PRINCIPALS` . // // For more information, see [Changing the default security settings for your data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-createtabledefaultpermissions // CreateTableDefaultPermissions interface{} `field:"optional" json:"createTableDefaultPermissions" yaml:"createTableDefaultPermissions"` // A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-externaldatafilteringallowlist // ExternalDataFilteringAllowList interface{} `field:"optional" json:"externalDataFilteringAllowList" yaml:"externalDataFilteringAllowList"` // Specifies whether the data lake settings are updated by adding new values to the current settings ( `APPEND` ) or by replacing the current settings with new settings ( `REPLACE` ). // // > If you choose `REPLACE` , your current data lake settings will be replaced with the new values in your template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-mutationtype // MutationType *string `field:"optional" json:"mutationType" yaml:"mutationType"` // A key-value map that provides an additional configuration on your data lake. // // `CrossAccountVersion` is the key you can configure in the `Parameters` field. Accepted values for the `CrossAccountVersion` key are 1, 2, and 3. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-parameters // Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"` // An array of UTF-8 strings. // // A list of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). The user ARNs can be logged in the resource owner's CloudTrail log. You may want to specify this property when you are in a high-trust boundary, such as the same team or company. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-trustedresourceowners // TrustedResourceOwners *[]*string `field:"optional" json:"trustedResourceOwners" yaml:"trustedResourceOwners"` }
Properties for defining a `CfnDataLakeSettings`.
Example:
import cdk "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdkgluealpha" import "github.com/aws/aws-cdk-go/awscdk" var stack stack var accountId string tagKey := "aws" tagValues := []*string{ "dev", } database := awscdkgluealpha.NewDatabase(this, jsii.String("Database")) table := awscdkgluealpha.NewS3Table(this, jsii.String("Table"), &S3TableProps{ Database: Database, Columns: []column{ &column{ Name: jsii.String("col1"), Type: awscdkgluealpha.Schema_STRING(), }, &column{ Name: jsii.String("col2"), Type: awscdkgluealpha.Schema_STRING(), }, }, DataFormat: awscdkgluealpha.DataFormat_CSV(), }) synthesizer := stack.Synthesizer.(defaultStackSynthesizer) awscdk.NewCfnDataLakeSettings(this, jsii.String("DataLakeSettings"), &CfnDataLakeSettingsProps{ Admins: []interface{}{ &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: stack.FormatArn(&ArnComponents{ Service: jsii.String("iam"), Resource: jsii.String("role"), Region: jsii.String(""), Account: accountId, ResourceName: jsii.String("Admin"), }), }, &DataLakePrincipalProperty{ // The CDK cloudformation execution role. DataLakePrincipalIdentifier: synthesizer.cloudFormationExecutionRoleArn.replace(jsii.String("${AWS::Partition}"), jsii.String("aws")), }, }, }) tag := awscdk.NewCfnTag(this, jsii.String("Tag"), &CfnTagProps{ CatalogId: accountId, TagKey: jsii.String(TagKey), TagValues: TagValues, }) lfTagPairProperty := &LFTagPairProperty{ CatalogId: accountId, TagKey: jsii.String(TagKey), TagValues: TagValues, } tagAssociation := awscdk.NewCfnTagAssociation(this, jsii.String("TagAssociation"), &CfnTagAssociationProps{ LfTags: []interface{}{ lfTagPairProperty, }, Resource: &ResourceProperty{ TableWithColumns: &TableWithColumnsResourceProperty{ DatabaseName: database.DatabaseName, ColumnNames: []*string{ jsii.String("col1"), jsii.String("col2"), }, CatalogId: accountId, Name: table.TableName, }, }, }) tagAssociation.Node.AddDependency(tag) tagAssociation.Node.AddDependency(table)
type CfnDataLakeSettings_DataLakePrincipalProperty ¶
type CfnDataLakeSettings_DataLakePrincipalProperty struct { // An identifier for the Lake Formation principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datalakesettings-datalakeprincipal.html#cfn-lakeformation-datalakesettings-datalakeprincipal-datalakeprincipalidentifier // DataLakePrincipalIdentifier *string `field:"required" json:"dataLakePrincipalIdentifier" yaml:"dataLakePrincipalIdentifier"` }
The Lake Formation principal.
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" dataLakePrincipalProperty := &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: jsii.String("dataLakePrincipalIdentifier"), }
type CfnDataLakeSettings_PrincipalPermissionsProperty ¶ added in v2.78.0
type CfnDataLakeSettings_PrincipalPermissionsProperty struct { // The permissions that are granted to the principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datalakesettings-principalpermissions.html#cfn-lakeformation-datalakesettings-principalpermissions-permissions // Permissions *[]*string `field:"required" json:"permissions" yaml:"permissions"` // The principal who is granted permissions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datalakesettings-principalpermissions.html#cfn-lakeformation-datalakesettings-principalpermissions-principal // Principal interface{} `field:"required" json:"principal" yaml:"principal"` }
Permissions granted to a principal.
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" principalPermissionsProperty := &PrincipalPermissionsProperty{ Permissions: []*string{ jsii.String("permissions"), }, Principal: &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: jsii.String("dataLakePrincipalIdentifier"), }, }
type CfnPermissions ¶
type CfnPermissions interface { awscdk.CfnResource awscdk.IInspectable // A unique identifier for the batch permissions request entry. AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The AWS Lake Formation principal. DataLakePrincipal() interface{} SetDataLakePrincipal(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 permissions granted or revoked. Permissions() *[]*string SetPermissions(val *[]*string) // Indicates the ability to grant permissions (as a subset of permissions granted). PermissionsWithGrantOption() *[]*string SetPermissionsWithGrantOption(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 // A structure for the resource. Resource() interface{} SetResource(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // 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{}) }
The `AWS::LakeFormation::Permissions` resource represents the permissions that a principal has on an AWS Glue Data Catalog resource (such as AWS Glue database or AWS Glue tables).
When you upload a permissions stack, the permissions are granted to the principal and when you remove the stack, the permissions are revoked from the principal. If you remove a stack, and the principal does not have the permissions referenced in the stack then AWS Lake Formation will throw an error because you can’t call revoke on non-existing permissions. To successfully remove the stack, you’ll need to regrant those permissions and then remove the stack.
> New versions of AWS Lake Formation permission resources are now available. For more information, see: [AWS:LakeFormation::PrincipalPermissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-principalpermissions.html)
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" cfnPermissions := awscdk.Aws_lakeformation.NewCfnPermissions(this, jsii.String("MyCfnPermissions"), &CfnPermissionsProps{ DataLakePrincipal: &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: jsii.String("dataLakePrincipalIdentifier"), }, Resource: &ResourceProperty{ DatabaseResource: &DatabaseResourceProperty{ CatalogId: jsii.String("catalogId"), Name: jsii.String("name"), }, DataLocationResource: &DataLocationResourceProperty{ CatalogId: jsii.String("catalogId"), S3Resource: jsii.String("s3Resource"), }, TableResource: &TableResourceProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), TableWildcard: &TableWildcardProperty{ }, }, TableWithColumnsResource: &TableWithColumnsResourceProperty{ CatalogId: jsii.String("catalogId"), ColumnNames: []*string{ jsii.String("columnNames"), }, ColumnWildcard: &ColumnWildcardProperty{ ExcludedColumnNames: []*string{ jsii.String("excludedColumnNames"), }, }, DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), }, }, // the properties below are optional Permissions: []*string{ jsii.String("permissions"), }, PermissionsWithGrantOption: []*string{ jsii.String("permissionsWithGrantOption"), }, })
func NewCfnPermissions ¶
func NewCfnPermissions(scope constructs.Construct, id *string, props *CfnPermissionsProps) CfnPermissions
type CfnPermissionsProps ¶
type CfnPermissionsProps struct { // The AWS Lake Formation principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-permissions.html#cfn-lakeformation-permissions-datalakeprincipal // DataLakePrincipal interface{} `field:"required" json:"dataLakePrincipal" yaml:"dataLakePrincipal"` // A structure for the resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-permissions.html#cfn-lakeformation-permissions-resource // Resource interface{} `field:"required" json:"resource" yaml:"resource"` // The permissions granted or revoked. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-permissions.html#cfn-lakeformation-permissions-permissions // Permissions *[]*string `field:"optional" json:"permissions" yaml:"permissions"` // Indicates the ability to grant permissions (as a subset of permissions granted). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-permissions.html#cfn-lakeformation-permissions-permissionswithgrantoption // PermissionsWithGrantOption *[]*string `field:"optional" json:"permissionsWithGrantOption" yaml:"permissionsWithGrantOption"` }
Properties for defining a `CfnPermissions`.
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" cfnPermissionsProps := &CfnPermissionsProps{ DataLakePrincipal: &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: jsii.String("dataLakePrincipalIdentifier"), }, Resource: &ResourceProperty{ DatabaseResource: &DatabaseResourceProperty{ CatalogId: jsii.String("catalogId"), Name: jsii.String("name"), }, DataLocationResource: &DataLocationResourceProperty{ CatalogId: jsii.String("catalogId"), S3Resource: jsii.String("s3Resource"), }, TableResource: &TableResourceProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), TableWildcard: &TableWildcardProperty{ }, }, TableWithColumnsResource: &TableWithColumnsResourceProperty{ CatalogId: jsii.String("catalogId"), ColumnNames: []*string{ jsii.String("columnNames"), }, ColumnWildcard: &ColumnWildcardProperty{ ExcludedColumnNames: []*string{ jsii.String("excludedColumnNames"), }, }, DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), }, }, // the properties below are optional Permissions: []*string{ jsii.String("permissions"), }, PermissionsWithGrantOption: []*string{ jsii.String("permissionsWithGrantOption"), }, }
type CfnPermissions_ColumnWildcardProperty ¶
type CfnPermissions_ColumnWildcardProperty struct { // Excludes column names. // // Any column with this name will be excluded. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-columnwildcard.html#cfn-lakeformation-permissions-columnwildcard-excludedcolumnnames // ExcludedColumnNames *[]*string `field:"optional" json:"excludedColumnNames" yaml:"excludedColumnNames"` }
A wildcard object, consisting of an optional list of excluded column names or indexes.
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" columnWildcardProperty := &ColumnWildcardProperty{ ExcludedColumnNames: []*string{ jsii.String("excludedColumnNames"), }, }
type CfnPermissions_DataLakePrincipalProperty ¶
type CfnPermissions_DataLakePrincipalProperty struct { // An identifier for the Lake Formation principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-datalakeprincipal.html#cfn-lakeformation-permissions-datalakeprincipal-datalakeprincipalidentifier // DataLakePrincipalIdentifier *string `field:"optional" json:"dataLakePrincipalIdentifier" yaml:"dataLakePrincipalIdentifier"` }
The Lake Formation principal.
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" dataLakePrincipalProperty := &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: jsii.String("dataLakePrincipalIdentifier"), }
type CfnPermissions_DataLocationResourceProperty ¶
type CfnPermissions_DataLocationResourceProperty struct { // The identifier for the Data Catalog . // // By default, it is the account ID of the caller. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-datalocationresource.html#cfn-lakeformation-permissions-datalocationresource-catalogid // CatalogId *string `field:"optional" json:"catalogId" yaml:"catalogId"` // The Amazon Resource Name (ARN) that uniquely identifies the data location resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-datalocationresource.html#cfn-lakeformation-permissions-datalocationresource-s3resource // S3Resource *string `field:"optional" json:"s3Resource" yaml:"s3Resource"` }
A structure for a data location object where permissions are granted or revoked.
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" dataLocationResourceProperty := &DataLocationResourceProperty{ CatalogId: jsii.String("catalogId"), S3Resource: jsii.String("s3Resource"), }
type CfnPermissions_DatabaseResourceProperty ¶
type CfnPermissions_DatabaseResourceProperty struct { // The identifier for the Data Catalog . // // By default, it is the account ID of the caller. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-databaseresource.html#cfn-lakeformation-permissions-databaseresource-catalogid // CatalogId *string `field:"optional" json:"catalogId" yaml:"catalogId"` // The name of the database resource. // // Unique to the Data Catalog. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-databaseresource.html#cfn-lakeformation-permissions-databaseresource-name // Name *string `field:"optional" json:"name" yaml:"name"` }
A structure for the database object.
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" databaseResourceProperty := &DatabaseResourceProperty{ CatalogId: jsii.String("catalogId"), Name: jsii.String("name"), }
type CfnPermissions_ResourceProperty ¶
type CfnPermissions_ResourceProperty struct { // A structure for the database object. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-resource.html#cfn-lakeformation-permissions-resource-databaseresource // DatabaseResource interface{} `field:"optional" json:"databaseResource" yaml:"databaseResource"` // A structure for a data location object where permissions are granted or revoked. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-resource.html#cfn-lakeformation-permissions-resource-datalocationresource // DataLocationResource interface{} `field:"optional" json:"dataLocationResource" yaml:"dataLocationResource"` // A structure for the table object. // // A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-resource.html#cfn-lakeformation-permissions-resource-tableresource // TableResource interface{} `field:"optional" json:"tableResource" yaml:"tableResource"` // A structure for a table with columns object. // // This object is only used when granting a SELECT permission. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-resource.html#cfn-lakeformation-permissions-resource-tablewithcolumnsresource // TableWithColumnsResource interface{} `field:"optional" json:"tableWithColumnsResource" yaml:"tableWithColumnsResource"` }
A structure for the 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" resourceProperty := &ResourceProperty{ DatabaseResource: &DatabaseResourceProperty{ CatalogId: jsii.String("catalogId"), Name: jsii.String("name"), }, DataLocationResource: &DataLocationResourceProperty{ CatalogId: jsii.String("catalogId"), S3Resource: jsii.String("s3Resource"), }, TableResource: &TableResourceProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), TableWildcard: &TableWildcardProperty{ }, }, TableWithColumnsResource: &TableWithColumnsResourceProperty{ CatalogId: jsii.String("catalogId"), ColumnNames: []*string{ jsii.String("columnNames"), }, ColumnWildcard: &ColumnWildcardProperty{ ExcludedColumnNames: []*string{ jsii.String("excludedColumnNames"), }, }, DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), }, }
type CfnPermissions_TableResourceProperty ¶
type CfnPermissions_TableResourceProperty struct { // The identifier for the Data Catalog . // // By default, it is the account ID of the caller. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tableresource.html#cfn-lakeformation-permissions-tableresource-catalogid // CatalogId *string `field:"optional" json:"catalogId" yaml:"catalogId"` // The name of the database for the table. // // Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tableresource.html#cfn-lakeformation-permissions-tableresource-databasename // DatabaseName *string `field:"optional" json:"databaseName" yaml:"databaseName"` // The name of the table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tableresource.html#cfn-lakeformation-permissions-tableresource-name // Name *string `field:"optional" json:"name" yaml:"name"` // An empty object representing all tables under a database. // // If this field is specified instead of the `Name` field, all tables under `DatabaseName` will have permission changes applied. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tableresource.html#cfn-lakeformation-permissions-tableresource-tablewildcard // TableWildcard interface{} `field:"optional" json:"tableWildcard" yaml:"tableWildcard"` }
A structure for the table object.
A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.
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" tableResourceProperty := &TableResourceProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), TableWildcard: &TableWildcardProperty{ }, }
type CfnPermissions_TableWildcardProperty ¶
type CfnPermissions_TableWildcardProperty struct { }
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" tableWildcardProperty := &TableWildcardProperty{ }
type CfnPermissions_TableWithColumnsResourceProperty ¶
type CfnPermissions_TableWithColumnsResourceProperty struct { // The identifier for the Data Catalog . // // By default, it is the account ID of the caller. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html#cfn-lakeformation-permissions-tablewithcolumnsresource-catalogid // CatalogId *string `field:"optional" json:"catalogId" yaml:"catalogId"` // The list of column names for the table. // // At least one of `ColumnNames` or `ColumnWildcard` is required. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html#cfn-lakeformation-permissions-tablewithcolumnsresource-columnnames // ColumnNames *[]*string `field:"optional" json:"columnNames" yaml:"columnNames"` // A wildcard specified by a `ColumnWildcard` object. // // At least one of `ColumnNames` or `ColumnWildcard` is required. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html#cfn-lakeformation-permissions-tablewithcolumnsresource-columnwildcard // ColumnWildcard interface{} `field:"optional" json:"columnWildcard" yaml:"columnWildcard"` // The name of the database for the table with columns resource. // // Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html#cfn-lakeformation-permissions-tablewithcolumnsresource-databasename // DatabaseName *string `field:"optional" json:"databaseName" yaml:"databaseName"` // The name of the table resource. // // A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html#cfn-lakeformation-permissions-tablewithcolumnsresource-name // Name *string `field:"optional" json:"name" yaml:"name"` }
A structure for a table with columns object. This object is only used when granting a SELECT permission.
This object must take a value for at least one of `ColumnsNames` , `ColumnsIndexes` , or `ColumnsWildcard` .
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" tableWithColumnsResourceProperty := &TableWithColumnsResourceProperty{ CatalogId: jsii.String("catalogId"), ColumnNames: []*string{ jsii.String("columnNames"), }, ColumnWildcard: &ColumnWildcardProperty{ ExcludedColumnNames: []*string{ jsii.String("excludedColumnNames"), }, }, DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), }
type CfnPrincipalPermissions ¶ added in v2.31.0
type CfnPrincipalPermissions interface { awscdk.CfnResource awscdk.IInspectable // Json encoding of the input principal. // // For example: `{"DataLakePrincipalIdentifier":"arn:aws:iam::123456789012:role/ExampleRole"}`. AttrPrincipalIdentifier() *string // Json encoding of the input resource. // // For example: `{"Catalog":null,"Database":null,"Table":null,"TableWithColumns":null,"DataLocation":null,"DataCellsFilter":{"TableCatalogId":"123456789012","DatabaseName":"ExampleDatabase","TableName":"ExampleTable","Name":"ExampleFilter"},"LFTag":null,"LFTagPolicy":null}`. AttrResourceIdentifier() *string // The identifier for the Data Catalog . Catalog() *string SetCatalog(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // 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 permissions granted or revoked. Permissions() *[]*string SetPermissions(val *[]*string) // Indicates the ability to grant permissions (as a subset of permissions granted). PermissionsWithGrantOption() *[]*string SetPermissionsWithGrantOption(val *[]*string) // The principal to be granted a permission. Principal() interface{} SetPrincipal(val interface{}) // 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 resource to be granted or revoked permissions. Resource() interface{} SetResource(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // 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{}) }
The `AWS::LakeFormation::PrincipalPermissions` resource represents the permissions that a principal has on a Data Catalog resource (such as AWS Glue databases or AWS Glue tables).
When you create a `PrincipalPermissions` resource, the permissions are granted via the AWS Lake Formation `GrantPermissions` API operation. When you delete a `PrincipalPermissions` resource, the permissions on principal-resource pair are revoked via the AWS Lake Formation `RevokePermissions` API operation.
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 catalog interface{} var tableWildcard interface{} cfnPrincipalPermissions := awscdk.Aws_lakeformation.NewCfnPrincipalPermissions(this, jsii.String("MyCfnPrincipalPermissions"), &CfnPrincipalPermissionsProps{ Permissions: []*string{ jsii.String("permissions"), }, PermissionsWithGrantOption: []*string{ jsii.String("permissionsWithGrantOption"), }, Principal: &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: jsii.String("dataLakePrincipalIdentifier"), }, Resource: &ResourceProperty{ Catalog: catalog, Database: &DatabaseResourceProperty{ CatalogId: jsii.String("catalogId"), Name: jsii.String("name"), }, DataCellsFilter: &DataCellsFilterResourceProperty{ DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), TableCatalogId: jsii.String("tableCatalogId"), TableName: jsii.String("tableName"), }, DataLocation: &DataLocationResourceProperty{ CatalogId: jsii.String("catalogId"), ResourceArn: jsii.String("resourceArn"), }, LfTag: &LFTagKeyResourceProperty{ CatalogId: jsii.String("catalogId"), TagKey: jsii.String("tagKey"), TagValues: []*string{ jsii.String("tagValues"), }, }, LfTagPolicy: &LFTagPolicyResourceProperty{ CatalogId: jsii.String("catalogId"), Expression: []interface{}{ &LFTagProperty{ TagKey: jsii.String("tagKey"), TagValues: []*string{ jsii.String("tagValues"), }, }, }, ResourceType: jsii.String("resourceType"), }, Table: &TableResourceProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), // the properties below are optional Name: jsii.String("name"), TableWildcard: tableWildcard, }, TableWithColumns: &TableWithColumnsResourceProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), // the properties below are optional ColumnNames: []*string{ jsii.String("columnNames"), }, ColumnWildcard: &ColumnWildcardProperty{ ExcludedColumnNames: []*string{ jsii.String("excludedColumnNames"), }, }, }, }, // the properties below are optional Catalog: jsii.String("catalog"), })
func NewCfnPrincipalPermissions ¶ added in v2.31.0
func NewCfnPrincipalPermissions(scope constructs.Construct, id *string, props *CfnPrincipalPermissionsProps) CfnPrincipalPermissions
type CfnPrincipalPermissionsProps ¶ added in v2.31.0
type CfnPrincipalPermissionsProps struct { // The permissions granted or revoked. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-principalpermissions.html#cfn-lakeformation-principalpermissions-permissions // Permissions *[]*string `field:"required" json:"permissions" yaml:"permissions"` // Indicates the ability to grant permissions (as a subset of permissions granted). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-principalpermissions.html#cfn-lakeformation-principalpermissions-permissionswithgrantoption // PermissionsWithGrantOption *[]*string `field:"required" json:"permissionsWithGrantOption" yaml:"permissionsWithGrantOption"` // The principal to be granted a permission. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-principalpermissions.html#cfn-lakeformation-principalpermissions-principal // Principal interface{} `field:"required" json:"principal" yaml:"principal"` // The resource to be granted or revoked permissions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-principalpermissions.html#cfn-lakeformation-principalpermissions-resource // Resource interface{} `field:"required" json:"resource" yaml:"resource"` // The identifier for the Data Catalog . // // By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-principalpermissions.html#cfn-lakeformation-principalpermissions-catalog // Catalog *string `field:"optional" json:"catalog" yaml:"catalog"` }
Properties for defining a `CfnPrincipalPermissions`.
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 catalog interface{} var tableWildcard interface{} cfnPrincipalPermissionsProps := &CfnPrincipalPermissionsProps{ Permissions: []*string{ jsii.String("permissions"), }, PermissionsWithGrantOption: []*string{ jsii.String("permissionsWithGrantOption"), }, Principal: &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: jsii.String("dataLakePrincipalIdentifier"), }, Resource: &ResourceProperty{ Catalog: catalog, Database: &DatabaseResourceProperty{ CatalogId: jsii.String("catalogId"), Name: jsii.String("name"), }, DataCellsFilter: &DataCellsFilterResourceProperty{ DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), TableCatalogId: jsii.String("tableCatalogId"), TableName: jsii.String("tableName"), }, DataLocation: &DataLocationResourceProperty{ CatalogId: jsii.String("catalogId"), ResourceArn: jsii.String("resourceArn"), }, LfTag: &LFTagKeyResourceProperty{ CatalogId: jsii.String("catalogId"), TagKey: jsii.String("tagKey"), TagValues: []*string{ jsii.String("tagValues"), }, }, LfTagPolicy: &LFTagPolicyResourceProperty{ CatalogId: jsii.String("catalogId"), Expression: []interface{}{ &LFTagProperty{ TagKey: jsii.String("tagKey"), TagValues: []*string{ jsii.String("tagValues"), }, }, }, ResourceType: jsii.String("resourceType"), }, Table: &TableResourceProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), // the properties below are optional Name: jsii.String("name"), TableWildcard: tableWildcard, }, TableWithColumns: &TableWithColumnsResourceProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), // the properties below are optional ColumnNames: []*string{ jsii.String("columnNames"), }, ColumnWildcard: &ColumnWildcardProperty{ ExcludedColumnNames: []*string{ jsii.String("excludedColumnNames"), }, }, }, }, // the properties below are optional Catalog: jsii.String("catalog"), }
type CfnPrincipalPermissions_ColumnWildcardProperty ¶ added in v2.31.0
type CfnPrincipalPermissions_ColumnWildcardProperty struct { // Excludes column names. // // Any column with this name will be excluded. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-columnwildcard.html#cfn-lakeformation-principalpermissions-columnwildcard-excludedcolumnnames // ExcludedColumnNames *[]*string `field:"optional" json:"excludedColumnNames" yaml:"excludedColumnNames"` }
A wildcard object, consisting of an optional list of excluded column names or indexes.
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" columnWildcardProperty := &ColumnWildcardProperty{ ExcludedColumnNames: []*string{ jsii.String("excludedColumnNames"), }, }
type CfnPrincipalPermissions_DataCellsFilterResourceProperty ¶ added in v2.31.0
type CfnPrincipalPermissions_DataCellsFilterResourceProperty struct { // A database in the Data Catalog . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datacellsfilterresource.html#cfn-lakeformation-principalpermissions-datacellsfilterresource-databasename // DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // The name given by the user to the data filter cell. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datacellsfilterresource.html#cfn-lakeformation-principalpermissions-datacellsfilterresource-name // Name *string `field:"required" json:"name" yaml:"name"` // The ID of the catalog to which the table belongs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datacellsfilterresource.html#cfn-lakeformation-principalpermissions-datacellsfilterresource-tablecatalogid // TableCatalogId *string `field:"required" json:"tableCatalogId" yaml:"tableCatalogId"` // The name of the table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datacellsfilterresource.html#cfn-lakeformation-principalpermissions-datacellsfilterresource-tablename // TableName *string `field:"required" json:"tableName" yaml:"tableName"` }
A structure that describes certain columns on certain rows.
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" dataCellsFilterResourceProperty := &DataCellsFilterResourceProperty{ DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), TableCatalogId: jsii.String("tableCatalogId"), TableName: jsii.String("tableName"), }
type CfnPrincipalPermissions_DataLakePrincipalProperty ¶ added in v2.31.0
type CfnPrincipalPermissions_DataLakePrincipalProperty struct { // An identifier for the AWS Lake Formation principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalakeprincipal.html#cfn-lakeformation-principalpermissions-datalakeprincipal-datalakeprincipalidentifier // DataLakePrincipalIdentifier *string `field:"optional" json:"dataLakePrincipalIdentifier" yaml:"dataLakePrincipalIdentifier"` }
The AWS Lake Formation principal.
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" dataLakePrincipalProperty := &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: jsii.String("dataLakePrincipalIdentifier"), }
type CfnPrincipalPermissions_DataLocationResourceProperty ¶ added in v2.31.0
type CfnPrincipalPermissions_DataLocationResourceProperty struct { // The identifier for the Data Catalog where the location is registered with AWS Lake Formation . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalocationresource.html#cfn-lakeformation-principalpermissions-datalocationresource-catalogid // CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // The Amazon Resource Name (ARN) that uniquely identifies the data location resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalocationresource.html#cfn-lakeformation-principalpermissions-datalocationresource-resourcearn // ResourceArn *string `field:"required" json:"resourceArn" yaml:"resourceArn"` }
A structure for a data location object where permissions are granted or revoked.
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" dataLocationResourceProperty := &DataLocationResourceProperty{ CatalogId: jsii.String("catalogId"), ResourceArn: jsii.String("resourceArn"), }
type CfnPrincipalPermissions_DatabaseResourceProperty ¶ added in v2.31.0
type CfnPrincipalPermissions_DatabaseResourceProperty struct { // The identifier for the Data Catalog. // // By default, it is the account ID of the caller. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-databaseresource.html#cfn-lakeformation-principalpermissions-databaseresource-catalogid // CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // The name of the database resource. // // Unique to the Data Catalog. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-databaseresource.html#cfn-lakeformation-principalpermissions-databaseresource-name // Name *string `field:"required" json:"name" yaml:"name"` }
A structure for the database object.
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" databaseResourceProperty := &DatabaseResourceProperty{ CatalogId: jsii.String("catalogId"), Name: jsii.String("name"), }
type CfnPrincipalPermissions_LFTagKeyResourceProperty ¶ added in v2.31.0
type CfnPrincipalPermissions_LFTagKeyResourceProperty struct { // The identifier for the Data Catalog where the location is registered with Data Catalog . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagkeyresource.html#cfn-lakeformation-principalpermissions-lftagkeyresource-catalogid // CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // The key-name for the LF-tag. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagkeyresource.html#cfn-lakeformation-principalpermissions-lftagkeyresource-tagkey // TagKey *string `field:"required" json:"tagKey" yaml:"tagKey"` // A list of possible values for the corresponding `TagKey` of an LF-tag key-value pair. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagkeyresource.html#cfn-lakeformation-principalpermissions-lftagkeyresource-tagvalues // TagValues *[]*string `field:"required" json:"tagValues" yaml:"tagValues"` }
A structure containing an LF-tag key and values for a 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" lFTagKeyResourceProperty := &LFTagKeyResourceProperty{ CatalogId: jsii.String("catalogId"), TagKey: jsii.String("tagKey"), TagValues: []*string{ jsii.String("tagValues"), }, }
type CfnPrincipalPermissions_LFTagPolicyResourceProperty ¶ added in v2.31.0
type CfnPrincipalPermissions_LFTagPolicyResourceProperty struct { // The identifier for the Data Catalog . // // The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagpolicyresource.html#cfn-lakeformation-principalpermissions-lftagpolicyresource-catalogid // CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // A list of LF-tag conditions that apply to the resource's LF-tag policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagpolicyresource.html#cfn-lakeformation-principalpermissions-lftagpolicyresource-expression // Expression interface{} `field:"required" json:"expression" yaml:"expression"` // The resource type for which the LF-tag policy applies. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagpolicyresource.html#cfn-lakeformation-principalpermissions-lftagpolicyresource-resourcetype // ResourceType *string `field:"required" json:"resourceType" yaml:"resourceType"` }
A list of LF-tag conditions that define a resource's LF-tag policy.
A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.
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" lFTagPolicyResourceProperty := &LFTagPolicyResourceProperty{ CatalogId: jsii.String("catalogId"), Expression: []interface{}{ &LFTagProperty{ TagKey: jsii.String("tagKey"), TagValues: []*string{ jsii.String("tagValues"), }, }, }, ResourceType: jsii.String("resourceType"), }
type CfnPrincipalPermissions_LFTagProperty ¶ added in v2.31.0
type CfnPrincipalPermissions_LFTagProperty struct { // The key-name for the LF-tag. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftag.html#cfn-lakeformation-principalpermissions-lftag-tagkey // TagKey *string `field:"optional" json:"tagKey" yaml:"tagKey"` // A list of possible values of the corresponding `TagKey` of an LF-tag key-value pair. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftag.html#cfn-lakeformation-principalpermissions-lftag-tagvalues // TagValues *[]*string `field:"optional" json:"tagValues" yaml:"tagValues"` }
The LF-tag key and values attached to a 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" lFTagProperty := &LFTagProperty{ TagKey: jsii.String("tagKey"), TagValues: []*string{ jsii.String("tagValues"), }, }
type CfnPrincipalPermissions_ResourceProperty ¶ added in v2.31.0
type CfnPrincipalPermissions_ResourceProperty struct { // The identifier for the Data Catalog. // // By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-catalog // Catalog interface{} `field:"optional" json:"catalog" yaml:"catalog"` // The database for the resource. // // Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-database // Database interface{} `field:"optional" json:"database" yaml:"database"` // A data cell filter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-datacellsfilter // DataCellsFilter interface{} `field:"optional" json:"dataCellsFilter" yaml:"dataCellsFilter"` // The location of an Amazon S3 path where permissions are granted or revoked. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-datalocation // DataLocation interface{} `field:"optional" json:"dataLocation" yaml:"dataLocation"` // The LF-tag key and values attached to a resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-lftag // LfTag interface{} `field:"optional" json:"lfTag" yaml:"lfTag"` // A list of LF-tag conditions that define a resource's LF-tag policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-lftagpolicy // LfTagPolicy interface{} `field:"optional" json:"lfTagPolicy" yaml:"lfTagPolicy"` // The table for the resource. // // A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-table // Table interface{} `field:"optional" json:"table" yaml:"table"` // The table with columns for the resource. // // A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-tablewithcolumns // TableWithColumns interface{} `field:"optional" json:"tableWithColumns" yaml:"tableWithColumns"` }
A structure for the 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" var catalog interface{} var tableWildcard interface{} resourceProperty := &ResourceProperty{ Catalog: catalog, Database: &DatabaseResourceProperty{ CatalogId: jsii.String("catalogId"), Name: jsii.String("name"), }, DataCellsFilter: &DataCellsFilterResourceProperty{ DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), TableCatalogId: jsii.String("tableCatalogId"), TableName: jsii.String("tableName"), }, DataLocation: &DataLocationResourceProperty{ CatalogId: jsii.String("catalogId"), ResourceArn: jsii.String("resourceArn"), }, LfTag: &LFTagKeyResourceProperty{ CatalogId: jsii.String("catalogId"), TagKey: jsii.String("tagKey"), TagValues: []*string{ jsii.String("tagValues"), }, }, LfTagPolicy: &LFTagPolicyResourceProperty{ CatalogId: jsii.String("catalogId"), Expression: []interface{}{ &LFTagProperty{ TagKey: jsii.String("tagKey"), TagValues: []*string{ jsii.String("tagValues"), }, }, }, ResourceType: jsii.String("resourceType"), }, Table: &TableResourceProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), // the properties below are optional Name: jsii.String("name"), TableWildcard: tableWildcard, }, TableWithColumns: &TableWithColumnsResourceProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), // the properties below are optional ColumnNames: []*string{ jsii.String("columnNames"), }, ColumnWildcard: &ColumnWildcardProperty{ ExcludedColumnNames: []*string{ jsii.String("excludedColumnNames"), }, }, }, }
type CfnPrincipalPermissions_TableResourceProperty ¶ added in v2.31.0
type CfnPrincipalPermissions_TableResourceProperty struct { // The identifier for the Data Catalog. // // By default, it is the account ID of the caller. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tableresource.html#cfn-lakeformation-principalpermissions-tableresource-catalogid // CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // The name of the database for the table. // // Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tableresource.html#cfn-lakeformation-principalpermissions-tableresource-databasename // DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // The name of the table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tableresource.html#cfn-lakeformation-principalpermissions-tableresource-name // Name *string `field:"optional" json:"name" yaml:"name"` // A wildcard object representing every table under a database. // // At least one of `TableResource$Name` or `TableResource$TableWildcard` is required. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tableresource.html#cfn-lakeformation-principalpermissions-tableresource-tablewildcard // TableWildcard interface{} `field:"optional" json:"tableWildcard" yaml:"tableWildcard"` }
A structure for the table object.
A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.
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 tableWildcard interface{} tableResourceProperty := &TableResourceProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), // the properties below are optional Name: jsii.String("name"), TableWildcard: tableWildcard, }
type CfnPrincipalPermissions_TableWithColumnsResourceProperty ¶ added in v2.31.0
type CfnPrincipalPermissions_TableWithColumnsResourceProperty struct { // The identifier for the Data Catalog where the location is registered with AWS Lake Formation . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html#cfn-lakeformation-principalpermissions-tablewithcolumnsresource-catalogid // CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // The name of the database for the table with columns resource. // // Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html#cfn-lakeformation-principalpermissions-tablewithcolumnsresource-databasename // DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // The name of the table resource. // // A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html#cfn-lakeformation-principalpermissions-tablewithcolumnsresource-name // Name *string `field:"required" json:"name" yaml:"name"` // The list of column names for the table. // // At least one of `ColumnNames` or `ColumnWildcard` is required. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html#cfn-lakeformation-principalpermissions-tablewithcolumnsresource-columnnames // ColumnNames *[]*string `field:"optional" json:"columnNames" yaml:"columnNames"` // A wildcard specified by a `ColumnWildcard` object. // // At least one of `ColumnNames` or `ColumnWildcard` is required. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html#cfn-lakeformation-principalpermissions-tablewithcolumnsresource-columnwildcard // ColumnWildcard interface{} `field:"optional" json:"columnWildcard" yaml:"columnWildcard"` }
A structure for a table with columns object. This object is only used when granting a SELECT permission.
This object must take a value for at least one of `ColumnsNames` , `ColumnsIndexes` , or `ColumnsWildcard` .
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" tableWithColumnsResourceProperty := &TableWithColumnsResourceProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), // the properties below are optional ColumnNames: []*string{ jsii.String("columnNames"), }, ColumnWildcard: &ColumnWildcardProperty{ ExcludedColumnNames: []*string{ jsii.String("excludedColumnNames"), }, }, }
type CfnResource ¶
type CfnResource interface { awscdk.CfnResource awscdk.IInspectable AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Indicates whether the data access of tables pointing to the location can be managed by both Lake Formation permissions as well as Amazon S3 bucket policies. HybridAccessEnabled() interface{} SetHybridAccessEnabled(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 // 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 Amazon Resource Name (ARN) of the resource. ResourceArn() *string SetResourceArn(val *string) // The IAM role that registered a resource. 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 // 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{} // Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog . UseServiceLinkedRole() interface{} SetUseServiceLinkedRole(val interface{}) // Allows Lake Formation to assume a role to access tables in a federated database. WithFederation() interface{} SetWithFederation(val 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{}) }
The `AWS::LakeFormation::Resource` represents the data ( buckets and folders) that is being registered with AWS Lake Formation .
During a stack operation, AWS CloudFormation calls the AWS Lake Formation [`RegisterResource`](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-credential-vending.html#aws-lake-formation-api-credential-vending-RegisterResource) API operation to register the resource. To remove a `Resource` type, AWS CloudFormation calls the AWS Lake Formation [`DeregisterResource`](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-credential-vending.html#aws-lake-formation-api-credential-vending-DeregisterResource) API operation.
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" cfnResource := awscdk.Aws_lakeformation.NewCfnResource(this, jsii.String("MyCfnResource"), &CfnResourceProps{ ResourceArn: jsii.String("resourceArn"), UseServiceLinkedRole: jsii.Boolean(false), // the properties below are optional HybridAccessEnabled: jsii.Boolean(false), RoleArn: jsii.String("roleArn"), WithFederation: jsii.Boolean(false), })
func NewCfnResource ¶
func NewCfnResource(scope constructs.Construct, id *string, props *CfnResourceProps) CfnResource
type CfnResourceProps ¶
type CfnResourceProps struct { // The Amazon Resource Name (ARN) of the resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-resource.html#cfn-lakeformation-resource-resourcearn // ResourceArn *string `field:"required" json:"resourceArn" yaml:"resourceArn"` // Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-resource.html#cfn-lakeformation-resource-useservicelinkedrole // UseServiceLinkedRole interface{} `field:"required" json:"useServiceLinkedRole" yaml:"useServiceLinkedRole"` // Indicates whether the data access of tables pointing to the location can be managed by both Lake Formation permissions as well as Amazon S3 bucket policies. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-resource.html#cfn-lakeformation-resource-hybridaccessenabled // HybridAccessEnabled interface{} `field:"optional" json:"hybridAccessEnabled" yaml:"hybridAccessEnabled"` // The IAM role that registered a resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-resource.html#cfn-lakeformation-resource-rolearn // RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"` // Allows Lake Formation to assume a role to access tables in a federated database. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-resource.html#cfn-lakeformation-resource-withfederation // WithFederation interface{} `field:"optional" json:"withFederation" yaml:"withFederation"` }
Properties for defining a `CfnResource`.
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" cfnResourceProps := &CfnResourceProps{ ResourceArn: jsii.String("resourceArn"), UseServiceLinkedRole: jsii.Boolean(false), // the properties below are optional HybridAccessEnabled: jsii.Boolean(false), RoleArn: jsii.String("roleArn"), WithFederation: jsii.Boolean(false), }
type CfnTag ¶ added in v2.31.0
type CfnTag interface { awscdk.CfnResource awscdk.IInspectable // Catalog id string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html) . CatalogId() *string SetCatalogId(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // 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 // 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 // UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html) . TagKey() *string SetTagKey(val *string) // An array of UTF-8 strings, not less than 1 or more than 50 strings. TagValues() *[]*string SetTagValues(val *[]*string) // 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{}) }
The `AWS::LakeFormation::Tag` resource represents an LF-tag, which consists of a key and one or more possible values for the key.
During a stack operation, AWS CloudFormation calls the AWS Lake Formation `CreateLFTag` API to create a tag, and `UpdateLFTag` API to update a tag resource, and a `DeleteLFTag` to delete it.
Example:
import cdk "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdkgluealpha" import "github.com/aws/aws-cdk-go/awscdk" var stack stack var accountId string tagKey := "aws" tagValues := []*string{ "dev", } database := awscdkgluealpha.NewDatabase(this, jsii.String("Database")) table := awscdkgluealpha.NewS3Table(this, jsii.String("Table"), &S3TableProps{ Database: Database, Columns: []column{ &column{ Name: jsii.String("col1"), Type: awscdkgluealpha.Schema_STRING(), }, &column{ Name: jsii.String("col2"), Type: awscdkgluealpha.Schema_STRING(), }, }, DataFormat: awscdkgluealpha.DataFormat_CSV(), }) synthesizer := stack.Synthesizer.(defaultStackSynthesizer) awscdk.NewCfnDataLakeSettings(this, jsii.String("DataLakeSettings"), &CfnDataLakeSettingsProps{ Admins: []interface{}{ &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: stack.FormatArn(&ArnComponents{ Service: jsii.String("iam"), Resource: jsii.String("role"), Region: jsii.String(""), Account: accountId, ResourceName: jsii.String("Admin"), }), }, &DataLakePrincipalProperty{ // The CDK cloudformation execution role. DataLakePrincipalIdentifier: synthesizer.cloudFormationExecutionRoleArn.replace(jsii.String("${AWS::Partition}"), jsii.String("aws")), }, }, }) tag := awscdk.NewCfnTag(this, jsii.String("Tag"), &CfnTagProps{ CatalogId: accountId, TagKey: jsii.String(TagKey), TagValues: TagValues, }) lfTagPairProperty := &LFTagPairProperty{ CatalogId: accountId, TagKey: jsii.String(TagKey), TagValues: TagValues, } tagAssociation := awscdk.NewCfnTagAssociation(this, jsii.String("TagAssociation"), &CfnTagAssociationProps{ LfTags: []interface{}{ lfTagPairProperty, }, Resource: &ResourceProperty{ TableWithColumns: &TableWithColumnsResourceProperty{ DatabaseName: database.DatabaseName, ColumnNames: []*string{ jsii.String("col1"), jsii.String("col2"), }, CatalogId: accountId, Name: table.TableName, }, }, }) tagAssociation.Node.AddDependency(tag) tagAssociation.Node.AddDependency(table)
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-tag.html
func NewCfnTag ¶ added in v2.31.0
func NewCfnTag(scope constructs.Construct, id *string, props *CfnTagProps) CfnTag
type CfnTagAssociation ¶ added in v2.31.0
type CfnTagAssociation interface { awscdk.CfnResource awscdk.IInspectable // Json encoding of the input resource. // // **Examples** - Database: `{"Catalog":null,"Database":{"CatalogId":"123456789012","Name":"ExampleDbName"},"Table":null,"TableWithColumns":null}` // - Table: `{"Catalog":null,"Database":null,"Table":{"CatalogId":"123456789012","DatabaseName":"ExampleDbName","Name":"ExampleTableName","TableWildcard":null},"TableWithColumns":null}` // - Columns: `{"Catalog":null,"Database":null,"Table":null,"TableWithColumns":{"CatalogId":"123456789012","DatabaseName":"ExampleDbName","Name":"ExampleTableName","ColumnNames":["ExampleColName1","ExampleColName2"]}}`. AttrResourceIdentifier() *string // Json encoding of the input LFTags list. // // For example: `[{"CatalogId":null,"TagKey":"tagKey1","TagValues":null},{"CatalogId":null,"TagKey":"tagKey2","TagValues":null}]`. AttrTagsIdentifier() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A structure containing an LF-tag key-value pair. LfTags() interface{} SetLfTags(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 // 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 // UTF-8 string (valid values: `DATABASE | TABLE` ). Resource() interface{} SetResource(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // 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{}) }
The `AWS::LakeFormation::TagAssociation` resource represents an assignment of an LF-tag to a Data Catalog resource (database, table, or column).
During a stack operation, CloudFormation calls AWS Lake Formation `AddLFTagsToResource` API to create a `TagAssociation` resource and calls the `RemoveLFTagsToResource` API to delete it.
Example:
import cdk "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdkgluealpha" import "github.com/aws/aws-cdk-go/awscdk" var stack stack var accountId string tagKey := "aws" tagValues := []*string{ "dev", } database := awscdkgluealpha.NewDatabase(this, jsii.String("Database")) table := awscdkgluealpha.NewS3Table(this, jsii.String("Table"), &S3TableProps{ Database: Database, Columns: []column{ &column{ Name: jsii.String("col1"), Type: awscdkgluealpha.Schema_STRING(), }, &column{ Name: jsii.String("col2"), Type: awscdkgluealpha.Schema_STRING(), }, }, DataFormat: awscdkgluealpha.DataFormat_CSV(), }) synthesizer := stack.Synthesizer.(defaultStackSynthesizer) awscdk.NewCfnDataLakeSettings(this, jsii.String("DataLakeSettings"), &CfnDataLakeSettingsProps{ Admins: []interface{}{ &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: stack.FormatArn(&ArnComponents{ Service: jsii.String("iam"), Resource: jsii.String("role"), Region: jsii.String(""), Account: accountId, ResourceName: jsii.String("Admin"), }), }, &DataLakePrincipalProperty{ // The CDK cloudformation execution role. DataLakePrincipalIdentifier: synthesizer.cloudFormationExecutionRoleArn.replace(jsii.String("${AWS::Partition}"), jsii.String("aws")), }, }, }) tag := awscdk.NewCfnTag(this, jsii.String("Tag"), &CfnTagProps{ CatalogId: accountId, TagKey: jsii.String(TagKey), TagValues: TagValues, }) lfTagPairProperty := &LFTagPairProperty{ CatalogId: accountId, TagKey: jsii.String(TagKey), TagValues: TagValues, } tagAssociation := awscdk.NewCfnTagAssociation(this, jsii.String("TagAssociation"), &CfnTagAssociationProps{ LfTags: []interface{}{ lfTagPairProperty, }, Resource: &ResourceProperty{ TableWithColumns: &TableWithColumnsResourceProperty{ DatabaseName: database.DatabaseName, ColumnNames: []*string{ jsii.String("col1"), jsii.String("col2"), }, CatalogId: accountId, Name: table.TableName, }, }, }) tagAssociation.Node.AddDependency(tag) tagAssociation.Node.AddDependency(table)
func NewCfnTagAssociation ¶ added in v2.31.0
func NewCfnTagAssociation(scope constructs.Construct, id *string, props *CfnTagAssociationProps) CfnTagAssociation
type CfnTagAssociationProps ¶ added in v2.31.0
type CfnTagAssociationProps struct { // A structure containing an LF-tag key-value pair. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-tagassociation.html#cfn-lakeformation-tagassociation-lftags // LfTags interface{} `field:"required" json:"lfTags" yaml:"lfTags"` // UTF-8 string (valid values: `DATABASE | TABLE` ). // // The resource for which the LF-tag policy applies. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-tagassociation.html#cfn-lakeformation-tagassociation-resource // Resource interface{} `field:"required" json:"resource" yaml:"resource"` }
Properties for defining a `CfnTagAssociation`.
Example:
import cdk "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdkgluealpha" import "github.com/aws/aws-cdk-go/awscdk" var stack stack var accountId string tagKey := "aws" tagValues := []*string{ "dev", } database := awscdkgluealpha.NewDatabase(this, jsii.String("Database")) table := awscdkgluealpha.NewS3Table(this, jsii.String("Table"), &S3TableProps{ Database: Database, Columns: []column{ &column{ Name: jsii.String("col1"), Type: awscdkgluealpha.Schema_STRING(), }, &column{ Name: jsii.String("col2"), Type: awscdkgluealpha.Schema_STRING(), }, }, DataFormat: awscdkgluealpha.DataFormat_CSV(), }) synthesizer := stack.Synthesizer.(defaultStackSynthesizer) awscdk.NewCfnDataLakeSettings(this, jsii.String("DataLakeSettings"), &CfnDataLakeSettingsProps{ Admins: []interface{}{ &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: stack.FormatArn(&ArnComponents{ Service: jsii.String("iam"), Resource: jsii.String("role"), Region: jsii.String(""), Account: accountId, ResourceName: jsii.String("Admin"), }), }, &DataLakePrincipalProperty{ // The CDK cloudformation execution role. DataLakePrincipalIdentifier: synthesizer.cloudFormationExecutionRoleArn.replace(jsii.String("${AWS::Partition}"), jsii.String("aws")), }, }, }) tag := awscdk.NewCfnTag(this, jsii.String("Tag"), &CfnTagProps{ CatalogId: accountId, TagKey: jsii.String(TagKey), TagValues: TagValues, }) lfTagPairProperty := &LFTagPairProperty{ CatalogId: accountId, TagKey: jsii.String(TagKey), TagValues: TagValues, } tagAssociation := awscdk.NewCfnTagAssociation(this, jsii.String("TagAssociation"), &CfnTagAssociationProps{ LfTags: []interface{}{ lfTagPairProperty, }, Resource: &ResourceProperty{ TableWithColumns: &TableWithColumnsResourceProperty{ DatabaseName: database.DatabaseName, ColumnNames: []*string{ jsii.String("col1"), jsii.String("col2"), }, CatalogId: accountId, Name: table.TableName, }, }, }) tagAssociation.Node.AddDependency(tag) tagAssociation.Node.AddDependency(table)
type CfnTagAssociation_DatabaseResourceProperty ¶ added in v2.31.0
type CfnTagAssociation_DatabaseResourceProperty struct { // The identifier for the Data Catalog . // // By default, it should be the account ID of the caller. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-databaseresource.html#cfn-lakeformation-tagassociation-databaseresource-catalogid // CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // The name of the database resource. // // Unique to the Data Catalog. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-databaseresource.html#cfn-lakeformation-tagassociation-databaseresource-name // Name *string `field:"required" json:"name" yaml:"name"` }
A structure for the database object.
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" databaseResourceProperty := &DatabaseResourceProperty{ CatalogId: jsii.String("catalogId"), Name: jsii.String("name"), }
type CfnTagAssociation_LFTagPairProperty ¶ added in v2.31.0
type CfnTagAssociation_LFTagPairProperty struct { // The identifier for the Data Catalog . // // By default, it is the account ID of the caller. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-lftagpair.html#cfn-lakeformation-tagassociation-lftagpair-catalogid // CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // The key-name for the LF-tag. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-lftagpair.html#cfn-lakeformation-tagassociation-lftagpair-tagkey // TagKey *string `field:"required" json:"tagKey" yaml:"tagKey"` // A list of possible values of the corresponding `TagKey` of an LF-tag key-value pair. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-lftagpair.html#cfn-lakeformation-tagassociation-lftagpair-tagvalues // TagValues *[]*string `field:"required" json:"tagValues" yaml:"tagValues"` }
A structure containing the catalog ID, tag key, and tag values of an LF-tag key-value pair.
Example:
import cdk "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdkgluealpha" import "github.com/aws/aws-cdk-go/awscdk" var stack stack var accountId string tagKey := "aws" tagValues := []*string{ "dev", } database := awscdkgluealpha.NewDatabase(this, jsii.String("Database")) table := awscdkgluealpha.NewS3Table(this, jsii.String("Table"), &S3TableProps{ Database: Database, Columns: []column{ &column{ Name: jsii.String("col1"), Type: awscdkgluealpha.Schema_STRING(), }, &column{ Name: jsii.String("col2"), Type: awscdkgluealpha.Schema_STRING(), }, }, DataFormat: awscdkgluealpha.DataFormat_CSV(), }) synthesizer := stack.Synthesizer.(defaultStackSynthesizer) awscdk.NewCfnDataLakeSettings(this, jsii.String("DataLakeSettings"), &CfnDataLakeSettingsProps{ Admins: []interface{}{ &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: stack.FormatArn(&ArnComponents{ Service: jsii.String("iam"), Resource: jsii.String("role"), Region: jsii.String(""), Account: accountId, ResourceName: jsii.String("Admin"), }), }, &DataLakePrincipalProperty{ // The CDK cloudformation execution role. DataLakePrincipalIdentifier: synthesizer.cloudFormationExecutionRoleArn.replace(jsii.String("${AWS::Partition}"), jsii.String("aws")), }, }, }) tag := awscdk.NewCfnTag(this, jsii.String("Tag"), &CfnTagProps{ CatalogId: accountId, TagKey: jsii.String(TagKey), TagValues: TagValues, }) lfTagPairProperty := &LFTagPairProperty{ CatalogId: accountId, TagKey: jsii.String(TagKey), TagValues: TagValues, } tagAssociation := awscdk.NewCfnTagAssociation(this, jsii.String("TagAssociation"), &CfnTagAssociationProps{ LfTags: []interface{}{ lfTagPairProperty, }, Resource: &ResourceProperty{ TableWithColumns: &TableWithColumnsResourceProperty{ DatabaseName: database.DatabaseName, ColumnNames: []*string{ jsii.String("col1"), jsii.String("col2"), }, CatalogId: accountId, Name: table.TableName, }, }, }) tagAssociation.Node.AddDependency(tag) tagAssociation.Node.AddDependency(table)
type CfnTagAssociation_ResourceProperty ¶ added in v2.31.0
type CfnTagAssociation_ResourceProperty struct { // The identifier for the Data Catalog. // // By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-resource.html#cfn-lakeformation-tagassociation-resource-catalog // Catalog interface{} `field:"optional" json:"catalog" yaml:"catalog"` // The database for the resource. // // Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-resource.html#cfn-lakeformation-tagassociation-resource-database // Database interface{} `field:"optional" json:"database" yaml:"database"` // The table for the resource. // // A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-resource.html#cfn-lakeformation-tagassociation-resource-table // Table interface{} `field:"optional" json:"table" yaml:"table"` // The table with columns for the resource. // // A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-resource.html#cfn-lakeformation-tagassociation-resource-tablewithcolumns // TableWithColumns interface{} `field:"optional" json:"tableWithColumns" yaml:"tableWithColumns"` }
A structure for the 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" var catalog interface{} var tableWildcard interface{} resourceProperty := &ResourceProperty{ Catalog: catalog, Database: &DatabaseResourceProperty{ CatalogId: jsii.String("catalogId"), Name: jsii.String("name"), }, Table: &TableResourceProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), // the properties below are optional Name: jsii.String("name"), TableWildcard: tableWildcard, }, TableWithColumns: &TableWithColumnsResourceProperty{ CatalogId: jsii.String("catalogId"), ColumnNames: []*string{ jsii.String("columnNames"), }, DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), }, }
type CfnTagAssociation_TableResourceProperty ¶ added in v2.31.0
type CfnTagAssociation_TableResourceProperty struct { // The identifier for the Data Catalog . // // By default, it is the account ID of the caller. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tableresource.html#cfn-lakeformation-tagassociation-tableresource-catalogid // CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // The name of the database for the table. // // Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tableresource.html#cfn-lakeformation-tagassociation-tableresource-databasename // DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // The name of the table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tableresource.html#cfn-lakeformation-tagassociation-tableresource-name // Name *string `field:"optional" json:"name" yaml:"name"` // A wildcard object representing every table under a database.This is an object with no properties that effectively behaves as a true or false depending on whether not it is passed as a parameter. The valid inputs for a property with this type in either yaml or json is null or {}. // // At least one of `TableResource$Name` or `TableResource$TableWildcard` is required. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tableresource.html#cfn-lakeformation-tagassociation-tableresource-tablewildcard // TableWildcard interface{} `field:"optional" json:"tableWildcard" yaml:"tableWildcard"` }
A structure for the table object.
A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.
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 tableWildcard interface{} tableResourceProperty := &TableResourceProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), // the properties below are optional Name: jsii.String("name"), TableWildcard: tableWildcard, }
type CfnTagAssociation_TableWithColumnsResourceProperty ¶ added in v2.31.0
type CfnTagAssociation_TableWithColumnsResourceProperty struct { // A wildcard object representing every table under a database. // // At least one of TableResource$Name or TableResource$TableWildcard is required. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tablewithcolumnsresource.html#cfn-lakeformation-tagassociation-tablewithcolumnsresource-catalogid // CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // The list of column names for the table. // // At least one of `ColumnNames` or `ColumnWildcard` is required. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tablewithcolumnsresource.html#cfn-lakeformation-tagassociation-tablewithcolumnsresource-columnnames // ColumnNames *[]*string `field:"required" json:"columnNames" yaml:"columnNames"` // The name of the database for the table with columns resource. // // Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tablewithcolumnsresource.html#cfn-lakeformation-tagassociation-tablewithcolumnsresource-databasename // DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // The name of the table resource. // // A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tablewithcolumnsresource.html#cfn-lakeformation-tagassociation-tablewithcolumnsresource-name // Name *string `field:"required" json:"name" yaml:"name"` }
A structure for a table with columns object. This object is only used when granting a SELECT permission.
This object must take a value for at least one of `ColumnsNames` , `ColumnsIndexes` , or `ColumnsWildcard` .
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" tableWithColumnsResourceProperty := &TableWithColumnsResourceProperty{ CatalogId: jsii.String("catalogId"), ColumnNames: []*string{ jsii.String("columnNames"), }, DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), }
type CfnTagProps ¶ added in v2.31.0
type CfnTagProps struct { // UTF-8 string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html) . // // The key-name for the LF-tag. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-tag.html#cfn-lakeformation-tag-tagkey // TagKey *string `field:"required" json:"tagKey" yaml:"tagKey"` // An array of UTF-8 strings, not less than 1 or more than 50 strings. // // A list of possible values of the corresponding `TagKey` of an LF-tag key-value pair. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-tag.html#cfn-lakeformation-tag-tagvalues // TagValues *[]*string `field:"required" json:"tagValues" yaml:"tagValues"` // Catalog id string, not less than 1 or more than 255 bytes long, matching the [single-line string pattern](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html) . // // The identifier for the Data Catalog . By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-tag.html#cfn-lakeformation-tag-catalogid // CatalogId *string `field:"optional" json:"catalogId" yaml:"catalogId"` }
Properties for defining a `CfnTag`.
Example:
import cdk "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdkgluealpha" import "github.com/aws/aws-cdk-go/awscdk" var stack stack var accountId string tagKey := "aws" tagValues := []*string{ "dev", } database := awscdkgluealpha.NewDatabase(this, jsii.String("Database")) table := awscdkgluealpha.NewS3Table(this, jsii.String("Table"), &S3TableProps{ Database: Database, Columns: []column{ &column{ Name: jsii.String("col1"), Type: awscdkgluealpha.Schema_STRING(), }, &column{ Name: jsii.String("col2"), Type: awscdkgluealpha.Schema_STRING(), }, }, DataFormat: awscdkgluealpha.DataFormat_CSV(), }) synthesizer := stack.Synthesizer.(defaultStackSynthesizer) awscdk.NewCfnDataLakeSettings(this, jsii.String("DataLakeSettings"), &CfnDataLakeSettingsProps{ Admins: []interface{}{ &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: stack.FormatArn(&ArnComponents{ Service: jsii.String("iam"), Resource: jsii.String("role"), Region: jsii.String(""), Account: accountId, ResourceName: jsii.String("Admin"), }), }, &DataLakePrincipalProperty{ // The CDK cloudformation execution role. DataLakePrincipalIdentifier: synthesizer.cloudFormationExecutionRoleArn.replace(jsii.String("${AWS::Partition}"), jsii.String("aws")), }, }, }) tag := awscdk.NewCfnTag(this, jsii.String("Tag"), &CfnTagProps{ CatalogId: accountId, TagKey: jsii.String(TagKey), TagValues: TagValues, }) lfTagPairProperty := &LFTagPairProperty{ CatalogId: accountId, TagKey: jsii.String(TagKey), TagValues: TagValues, } tagAssociation := awscdk.NewCfnTagAssociation(this, jsii.String("TagAssociation"), &CfnTagAssociationProps{ LfTags: []interface{}{ lfTagPairProperty, }, Resource: &ResourceProperty{ TableWithColumns: &TableWithColumnsResourceProperty{ DatabaseName: database.DatabaseName, ColumnNames: []*string{ jsii.String("col1"), jsii.String("col2"), }, CatalogId: accountId, Name: table.TableName, }, }, }) tagAssociation.Node.AddDependency(tag) tagAssociation.Node.AddDependency(table)
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-tag.html
Source Files ¶
- CfnDataCellsFilter.go
- CfnDataCellsFilterProps.go
- CfnDataCellsFilter_ColumnWildcardProperty.go
- CfnDataCellsFilter_RowFilterProperty.go
- CfnDataCellsFilter__checks.go
- CfnDataLakeSettings.go
- CfnDataLakeSettingsProps.go
- CfnDataLakeSettings_DataLakePrincipalProperty.go
- CfnDataLakeSettings_PrincipalPermissionsProperty.go
- CfnDataLakeSettings__checks.go
- CfnPermissions.go
- CfnPermissionsProps.go
- CfnPermissions_ColumnWildcardProperty.go
- CfnPermissions_DataLakePrincipalProperty.go
- CfnPermissions_DataLocationResourceProperty.go
- CfnPermissions_DatabaseResourceProperty.go
- CfnPermissions_ResourceProperty.go
- CfnPermissions_TableResourceProperty.go
- CfnPermissions_TableWildcardProperty.go
- CfnPermissions_TableWithColumnsResourceProperty.go
- CfnPermissions__checks.go
- CfnPrincipalPermissions.go
- CfnPrincipalPermissionsProps.go
- CfnPrincipalPermissions_ColumnWildcardProperty.go
- CfnPrincipalPermissions_DataCellsFilterResourceProperty.go
- CfnPrincipalPermissions_DataLakePrincipalProperty.go
- CfnPrincipalPermissions_DataLocationResourceProperty.go
- CfnPrincipalPermissions_DatabaseResourceProperty.go
- CfnPrincipalPermissions_LFTagKeyResourceProperty.go
- CfnPrincipalPermissions_LFTagPolicyResourceProperty.go
- CfnPrincipalPermissions_LFTagProperty.go
- CfnPrincipalPermissions_ResourceProperty.go
- CfnPrincipalPermissions_TableResourceProperty.go
- CfnPrincipalPermissions_TableWithColumnsResourceProperty.go
- CfnPrincipalPermissions__checks.go
- CfnResource.go
- CfnResourceProps.go
- CfnResource__checks.go
- CfnTag.go
- CfnTagAssociation.go
- CfnTagAssociationProps.go
- CfnTagAssociation_DatabaseResourceProperty.go
- CfnTagAssociation_LFTagPairProperty.go
- CfnTagAssociation_ResourceProperty.go
- CfnTagAssociation_TableResourceProperty.go
- CfnTagAssociation_TableWithColumnsResourceProperty.go
- CfnTagAssociation__checks.go
- CfnTagProps.go
- CfnTag__checks.go
- main.go