Documentation ¶
Index ¶
- func CfnDataCellsFilter_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDataCellsFilter_IsCfnElement(x interface{}) *bool
- func CfnDataCellsFilter_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDataCellsFilter_IsConstruct(x interface{}) *bool
- func CfnDataLakeSettings_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDataLakeSettings_IsCfnElement(x interface{}) *bool
- func CfnDataLakeSettings_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDataLakeSettings_IsConstruct(x interface{}) *bool
- func CfnPermissions_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPermissions_IsCfnElement(x interface{}) *bool
- func CfnPermissions_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnPermissions_IsConstruct(x interface{}) *bool
- func CfnPrincipalPermissions_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPrincipalPermissions_IsCfnElement(x interface{}) *bool
- func CfnPrincipalPermissions_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnPrincipalPermissions_IsConstruct(x interface{}) *bool
- func CfnResource_CFN_RESOURCE_TYPE_NAME() *string
- func CfnResource_IsCfnElement(x interface{}) *bool
- func CfnResource_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnResource_IsConstruct(x interface{}) *bool
- func CfnTagAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTagAssociation_IsCfnElement(x interface{}) *bool
- func CfnTagAssociation_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnTagAssociation_IsConstruct(x interface{}) *bool
- func CfnTag_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTag_IsCfnElement(x interface{}) *bool
- func CfnTag_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnTag_IsConstruct(x interface{}) *bool
- func NewCfnDataCellsFilter_Override(c CfnDataCellsFilter, scope awscdk.Construct, id *string, ...)
- func NewCfnDataLakeSettings_Override(c CfnDataLakeSettings, scope awscdk.Construct, id *string, ...)
- func NewCfnPermissions_Override(c CfnPermissions, scope awscdk.Construct, id *string, ...)
- func NewCfnPrincipalPermissions_Override(c CfnPrincipalPermissions, scope awscdk.Construct, id *string, ...)
- func NewCfnResource_Override(c CfnResource, scope awscdk.Construct, id *string, props *CfnResourceProps)
- func NewCfnTagAssociation_Override(c CfnTagAssociation, scope awscdk.Construct, id *string, ...)
- func NewCfnTag_Override(c CfnTag, scope awscdk.Construct, id *string, props *CfnTagProps)
- type CfnDataCellsFilter
- type CfnDataCellsFilterProps
- type CfnDataCellsFilter_ColumnWildcardProperty
- type CfnDataCellsFilter_RowFilterProperty
- type CfnDataLakeSettings
- type CfnDataLakeSettingsProps
- type CfnDataLakeSettings_DataLakePrincipalProperty
- 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 ¶
func CfnDataCellsFilter_CFN_RESOURCE_TYPE_NAME() *string
func CfnDataCellsFilter_IsCfnElement ¶
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. Experimental.
func CfnDataCellsFilter_IsCfnResource ¶
func CfnDataCellsFilter_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDataCellsFilter_IsConstruct ¶
func CfnDataCellsFilter_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnDataLakeSettings_IsCfnResource ¶
func CfnDataLakeSettings_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDataLakeSettings_IsConstruct ¶
func CfnDataLakeSettings_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnPermissions_IsCfnResource ¶
func CfnPermissions_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnPermissions_IsConstruct ¶
func CfnPermissions_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnPrincipalPermissions_CFN_RESOURCE_TYPE_NAME ¶
func CfnPrincipalPermissions_CFN_RESOURCE_TYPE_NAME() *string
func CfnPrincipalPermissions_IsCfnElement ¶
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. Experimental.
func CfnPrincipalPermissions_IsCfnResource ¶
func CfnPrincipalPermissions_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnPrincipalPermissions_IsConstruct ¶
func CfnPrincipalPermissions_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnResource_IsCfnResource ¶
func CfnResource_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnResource_IsConstruct ¶
func CfnResource_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnTagAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnTagAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnTagAssociation_IsCfnElement ¶
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. Experimental.
func CfnTagAssociation_IsCfnResource ¶
func CfnTagAssociation_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnTagAssociation_IsConstruct ¶
func CfnTagAssociation_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnTag_CFN_RESOURCE_TYPE_NAME ¶
func CfnTag_CFN_RESOURCE_TYPE_NAME() *string
func CfnTag_IsCfnElement ¶
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. Experimental.
func CfnTag_IsCfnResource ¶
func CfnTag_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnTag_IsConstruct ¶
func CfnTag_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnDataCellsFilter_Override ¶
func NewCfnDataCellsFilter_Override(c CfnDataCellsFilter, scope awscdk.Construct, id *string, props *CfnDataCellsFilterProps)
Create a new `AWS::LakeFormation::DataCellsFilter`.
func NewCfnDataLakeSettings_Override ¶
func NewCfnDataLakeSettings_Override(c CfnDataLakeSettings, scope awscdk.Construct, id *string, props *CfnDataLakeSettingsProps)
Create a new `AWS::LakeFormation::DataLakeSettings`.
func NewCfnPermissions_Override ¶
func NewCfnPermissions_Override(c CfnPermissions, scope awscdk.Construct, id *string, props *CfnPermissionsProps)
Create a new `AWS::LakeFormation::Permissions`.
func NewCfnPrincipalPermissions_Override ¶
func NewCfnPrincipalPermissions_Override(c CfnPrincipalPermissions, scope awscdk.Construct, id *string, props *CfnPrincipalPermissionsProps)
Create a new `AWS::LakeFormation::PrincipalPermissions`.
func NewCfnResource_Override ¶
func NewCfnResource_Override(c CfnResource, scope awscdk.Construct, id *string, props *CfnResourceProps)
Create a new `AWS::LakeFormation::Resource`.
func NewCfnTagAssociation_Override ¶
func NewCfnTagAssociation_Override(c CfnTagAssociation, scope awscdk.Construct, id *string, props *CfnTagAssociationProps)
Create a new `AWS::LakeFormation::TagAssociation`.
func NewCfnTag_Override ¶
func NewCfnTag_Override(c CfnTag, scope awscdk.Construct, id *string, props *CfnTagProps)
Create a new `AWS::LakeFormation::Tag`.
Types ¶
type CfnDataCellsFilter ¶
type CfnDataCellsFilter interface { awscdk.CfnResource awscdk.IInspectable // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. CfnResourceType() *string // `AWS::LakeFormation::DataCellsFilter.ColumnNames`. ColumnNames() *[]*string SetColumnNames(val *[]*string) // `AWS::LakeFormation::DataCellsFilter.ColumnWildcard`. 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. // Experimental. CreationStack() *[]*string // `AWS::LakeFormation::DataCellsFilter.DatabaseName`. 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. // Experimental. LogicalId() *string // `AWS::LakeFormation::DataCellsFilter.Name`. Name() *string SetName(val *string) // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // `AWS::LakeFormation::DataCellsFilter.RowFilter`. RowFilter() interface{} SetRowFilter(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // `AWS::LakeFormation::DataCellsFilter.TableCatalogId`. TableCatalogId() *string SetTableCatalogId(val *string) // `AWS::LakeFormation::DataCellsFilter.TableName`. TableName() *string SetTableName(val *string) // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::LakeFormation::DataCellsFilter`.
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 ¶
func NewCfnDataCellsFilter(scope awscdk.Construct, id *string, props *CfnDataCellsFilterProps) CfnDataCellsFilter
Create a new `AWS::LakeFormation::DataCellsFilter`.
type CfnDataCellsFilterProps ¶
type CfnDataCellsFilterProps struct { // `AWS::LakeFormation::DataCellsFilter.DatabaseName`. DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // `AWS::LakeFormation::DataCellsFilter.Name`. Name *string `field:"required" json:"name" yaml:"name"` // `AWS::LakeFormation::DataCellsFilter.TableCatalogId`. TableCatalogId *string `field:"required" json:"tableCatalogId" yaml:"tableCatalogId"` // `AWS::LakeFormation::DataCellsFilter.TableName`. TableName *string `field:"required" json:"tableName" yaml:"tableName"` // `AWS::LakeFormation::DataCellsFilter.ColumnNames`. ColumnNames *[]*string `field:"optional" json:"columnNames" yaml:"columnNames"` // `AWS::LakeFormation::DataCellsFilter.ColumnWildcard`. ColumnWildcard interface{} `field:"optional" json:"columnWildcard" yaml:"columnWildcard"` // `AWS::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 ¶
type CfnDataCellsFilter_ColumnWildcardProperty struct { // `CfnDataCellsFilter.ColumnWildcardProperty.ExcludedColumnNames`. ExcludedColumnNames *[]*string `field:"optional" json:"excludedColumnNames" yaml:"excludedColumnNames"` }
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 ¶
type CfnDataCellsFilter_RowFilterProperty struct { // `CfnDataCellsFilter.RowFilterProperty.AllRowsWildcard`. AllRowsWildcard interface{} `field:"optional" json:"allRowsWildcard" yaml:"allRowsWildcard"` // `CfnDataCellsFilter.RowFilterProperty.FilterExpression`. FilterExpression *string `field:"optional" json:"filterExpression" yaml:"filterExpression"` }
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{}) // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. 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. // Experimental. LogicalId() *string // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // `AWS::LakeFormation::DataLakeSettings.TrustedResourceOwners`. TrustedResourceOwners() *[]*string SetTrustedResourceOwners(val *[]*string) // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::LakeFormation::DataLakeSettings`.
The `AWS::LakeFormation::DataLakeSettings` resource is an AWS Lake Formation resource type that manages the data lake settings for your account. Note that the CloudFormation template only supports updating the `Admins` list. It does not support updating the [CreateDatabaseDefaultPermissions](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-settings.html#aws-lake-formation-api-aws-lake-formation-api-settings-DataLakeSettings) or [CreateTableDefaultPermissions](https://docs.aws.amazon.com/lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-settings.html#aws-lake-formation-api-aws-lake-formation-api-settings-DataLakeSettings) . Those permissions can only be edited in the DataLakeSettings resource via the API.
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" cfnDataLakeSettings := awscdk.Aws_lakeformation.NewCfnDataLakeSettings(this, jsii.String("MyCfnDataLakeSettings"), &cfnDataLakeSettingsProps{ admins: []interface{}{ &dataLakePrincipalProperty{ dataLakePrincipalIdentifier: jsii.String("dataLakePrincipalIdentifier"), }, }, trustedResourceOwners: []*string{ jsii.String("trustedResourceOwners"), }, })
func NewCfnDataLakeSettings ¶
func NewCfnDataLakeSettings(scope awscdk.Construct, id *string, props *CfnDataLakeSettingsProps) CfnDataLakeSettings
Create a new `AWS::LakeFormation::DataLakeSettings`.
type CfnDataLakeSettingsProps ¶
type CfnDataLakeSettingsProps struct { // A list of AWS Lake Formation principals. Admins interface{} `field:"optional" json:"admins" yaml:"admins"` // `AWS::LakeFormation::DataLakeSettings.TrustedResourceOwners`. TrustedResourceOwners *[]*string `field:"optional" json:"trustedResourceOwners" yaml:"trustedResourceOwners"` }
Properties for defining a `CfnDataLakeSettings`.
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" cfnDataLakeSettingsProps := &cfnDataLakeSettingsProps{ admins: []interface{}{ &dataLakePrincipalProperty{ dataLakePrincipalIdentifier: jsii.String("dataLakePrincipalIdentifier"), }, }, trustedResourceOwners: []*string{ jsii.String("trustedResourceOwners"), }, }
type CfnDataLakeSettings_DataLakePrincipalProperty ¶
type CfnDataLakeSettings_DataLakePrincipalProperty struct { // An identifier for the Lake Formation principal. 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 ¶
type CfnPermissions interface { awscdk.CfnResource awscdk.IInspectable // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. 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. // Experimental. LogicalId() *string // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // The permissions granted or revoked. Permissions() *[]*string SetPermissions(val *[]*string) // Indicates whether to grant 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 })`. // Experimental. 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). // Experimental. Stack() awscdk.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::LakeFormation::Permissions`.
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.
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 awscdk.Construct, id *string, props *CfnPermissionsProps) CfnPermissions
Create a new `AWS::LakeFormation::Permissions`.
type CfnPermissionsProps ¶
type CfnPermissionsProps struct { // The AWS Lake Formation principal. DataLakePrincipal interface{} `field:"required" json:"dataLakePrincipal" yaml:"dataLakePrincipal"` // A structure for the resource. Resource interface{} `field:"required" json:"resource" yaml:"resource"` // The permissions granted or revoked. Permissions *[]*string `field:"optional" json:"permissions" yaml:"permissions"` // Indicates whether to grant the ability to grant permissions (as a subset of permissions granted). 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. 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. 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 { // `CfnPermissions.DataLocationResourceProperty.CatalogId`. CatalogId *string `field:"optional" json:"catalogId" yaml:"catalogId"` // Currently not supported by AWS CloudFormation . 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 { // `CfnPermissions.DatabaseResourceProperty.CatalogId`. CatalogId *string `field:"optional" json:"catalogId" yaml:"catalogId"` // The name of the database resource. // // Unique to the Data Catalog. 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. DatabaseResource interface{} `field:"optional" json:"databaseResource" yaml:"databaseResource"` // A structure for a data location object where permissions are granted or revoked. 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. TableResource interface{} `field:"optional" json:"tableResource" yaml:"tableResource"` // Currently not supported by AWS CloudFormation . 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 { // `CfnPermissions.TableResourceProperty.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. DatabaseName *string `field:"optional" json:"databaseName" yaml:"databaseName"` // The name of the table. 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. 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 { }
A wildcard object representing every table under a database.
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 { // `CfnPermissions.TableWithColumnsResourceProperty.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. ColumnNames *[]*string `field:"optional" json:"columnNames" yaml:"columnNames"` // A wildcard specified by a `ColumnWildcard` object. // // At least one of `ColumnNames` or `ColumnWildcard` is required. 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. 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. 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 ¶
type CfnPrincipalPermissions interface { awscdk.CfnResource awscdk.IInspectable AttrPrincipalIdentifier() *string AttrResourceIdentifier() *string // `AWS::LakeFormation::PrincipalPermissions.Catalog`. Catalog() *string SetCatalog(val *string) // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. 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. // Experimental. LogicalId() *string // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // `AWS::LakeFormation::PrincipalPermissions.Permissions`. Permissions() *[]*string SetPermissions(val *[]*string) // `AWS::LakeFormation::PrincipalPermissions.PermissionsWithGrantOption`. PermissionsWithGrantOption() *[]*string SetPermissionsWithGrantOption(val *[]*string) // `AWS::LakeFormation::PrincipalPermissions.Principal`. 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 })`. // Experimental. Ref() *string // `AWS::LakeFormation::PrincipalPermissions.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). // Experimental. Stack() awscdk.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::LakeFormation::PrincipalPermissions`.
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 ¶
func NewCfnPrincipalPermissions(scope awscdk.Construct, id *string, props *CfnPrincipalPermissionsProps) CfnPrincipalPermissions
Create a new `AWS::LakeFormation::PrincipalPermissions`.
type CfnPrincipalPermissionsProps ¶
type CfnPrincipalPermissionsProps struct { // `AWS::LakeFormation::PrincipalPermissions.Permissions`. Permissions *[]*string `field:"required" json:"permissions" yaml:"permissions"` // `AWS::LakeFormation::PrincipalPermissions.PermissionsWithGrantOption`. PermissionsWithGrantOption *[]*string `field:"required" json:"permissionsWithGrantOption" yaml:"permissionsWithGrantOption"` // `AWS::LakeFormation::PrincipalPermissions.Principal`. Principal interface{} `field:"required" json:"principal" yaml:"principal"` // `AWS::LakeFormation::PrincipalPermissions.Resource`. Resource interface{} `field:"required" json:"resource" yaml:"resource"` // `AWS::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 ¶
type CfnPrincipalPermissions_ColumnWildcardProperty struct { // `CfnPrincipalPermissions.ColumnWildcardProperty.ExcludedColumnNames`. ExcludedColumnNames *[]*string `field:"optional" json:"excludedColumnNames" yaml:"excludedColumnNames"` }
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 ¶
type CfnPrincipalPermissions_DataCellsFilterResourceProperty struct { // `CfnPrincipalPermissions.DataCellsFilterResourceProperty.DatabaseName`. DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // `CfnPrincipalPermissions.DataCellsFilterResourceProperty.Name`. Name *string `field:"required" json:"name" yaml:"name"` // `CfnPrincipalPermissions.DataCellsFilterResourceProperty.TableCatalogId`. TableCatalogId *string `field:"required" json:"tableCatalogId" yaml:"tableCatalogId"` // `CfnPrincipalPermissions.DataCellsFilterResourceProperty.TableName`. TableName *string `field:"required" json:"tableName" yaml:"tableName"` }
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 ¶
type CfnPrincipalPermissions_DataLakePrincipalProperty struct { // `CfnPrincipalPermissions.DataLakePrincipalProperty.DataLakePrincipalIdentifier`. DataLakePrincipalIdentifier *string `field:"optional" json:"dataLakePrincipalIdentifier" yaml:"dataLakePrincipalIdentifier"` }
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 ¶
type CfnPrincipalPermissions_DataLocationResourceProperty struct { // `CfnPrincipalPermissions.DataLocationResourceProperty.CatalogId`. CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // `CfnPrincipalPermissions.DataLocationResourceProperty.ResourceArn`. ResourceArn *string `field:"required" json:"resourceArn" yaml:"resourceArn"` }
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 ¶
type CfnPrincipalPermissions_DatabaseResourceProperty struct { // `CfnPrincipalPermissions.DatabaseResourceProperty.CatalogId`. CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // `CfnPrincipalPermissions.DatabaseResourceProperty.Name`. Name *string `field:"required" json:"name" yaml:"name"` }
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 ¶
type CfnPrincipalPermissions_LFTagKeyResourceProperty struct { // `CfnPrincipalPermissions.LFTagKeyResourceProperty.CatalogId`. CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // `CfnPrincipalPermissions.LFTagKeyResourceProperty.TagKey`. TagKey *string `field:"required" json:"tagKey" yaml:"tagKey"` // `CfnPrincipalPermissions.LFTagKeyResourceProperty.TagValues`. TagValues *[]*string `field:"required" json:"tagValues" yaml:"tagValues"` }
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 ¶
type CfnPrincipalPermissions_LFTagPolicyResourceProperty struct { // `CfnPrincipalPermissions.LFTagPolicyResourceProperty.CatalogId`. CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // `CfnPrincipalPermissions.LFTagPolicyResourceProperty.Expression`. Expression interface{} `field:"required" json:"expression" yaml:"expression"` // `CfnPrincipalPermissions.LFTagPolicyResourceProperty.ResourceType`. ResourceType *string `field:"required" json:"resourceType" yaml:"resourceType"` }
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 ¶
type CfnPrincipalPermissions_LFTagProperty struct { // `CfnPrincipalPermissions.LFTagProperty.TagKey`. TagKey *string `field:"optional" json:"tagKey" yaml:"tagKey"` // `CfnPrincipalPermissions.LFTagProperty.TagValues`. TagValues *[]*string `field:"optional" json:"tagValues" yaml:"tagValues"` }
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 ¶
type CfnPrincipalPermissions_ResourceProperty struct { // `CfnPrincipalPermissions.ResourceProperty.Catalog`. Catalog interface{} `field:"optional" json:"catalog" yaml:"catalog"` // `CfnPrincipalPermissions.ResourceProperty.Database`. Database interface{} `field:"optional" json:"database" yaml:"database"` // `CfnPrincipalPermissions.ResourceProperty.DataCellsFilter`. DataCellsFilter interface{} `field:"optional" json:"dataCellsFilter" yaml:"dataCellsFilter"` // `CfnPrincipalPermissions.ResourceProperty.DataLocation`. DataLocation interface{} `field:"optional" json:"dataLocation" yaml:"dataLocation"` // `CfnPrincipalPermissions.ResourceProperty.LFTag`. LfTag interface{} `field:"optional" json:"lfTag" yaml:"lfTag"` // `CfnPrincipalPermissions.ResourceProperty.LFTagPolicy`. LfTagPolicy interface{} `field:"optional" json:"lfTagPolicy" yaml:"lfTagPolicy"` // `CfnPrincipalPermissions.ResourceProperty.Table`. Table interface{} `field:"optional" json:"table" yaml:"table"` // `CfnPrincipalPermissions.ResourceProperty.TableWithColumns`. TableWithColumns interface{} `field:"optional" json:"tableWithColumns" yaml:"tableWithColumns"` }
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 ¶
type CfnPrincipalPermissions_TableResourceProperty struct { // `CfnPrincipalPermissions.TableResourceProperty.CatalogId`. CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // `CfnPrincipalPermissions.TableResourceProperty.DatabaseName`. DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // `CfnPrincipalPermissions.TableResourceProperty.Name`. Name *string `field:"optional" json:"name" yaml:"name"` // `CfnPrincipalPermissions.TableResourceProperty.TableWildcard`. TableWildcard interface{} `field:"optional" json:"tableWildcard" yaml:"tableWildcard"` }
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 ¶
type CfnPrincipalPermissions_TableWithColumnsResourceProperty struct { // `CfnPrincipalPermissions.TableWithColumnsResourceProperty.CatalogId`. CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // `CfnPrincipalPermissions.TableWithColumnsResourceProperty.DatabaseName`. DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // `CfnPrincipalPermissions.TableWithColumnsResourceProperty.Name`. Name *string `field:"required" json:"name" yaml:"name"` // `CfnPrincipalPermissions.TableWithColumnsResourceProperty.ColumnNames`. ColumnNames *[]*string `field:"optional" json:"columnNames" yaml:"columnNames"` // `CfnPrincipalPermissions.TableWithColumnsResourceProperty.ColumnWildcard`. ColumnWildcard interface{} `field:"optional" json:"columnWildcard" yaml:"columnWildcard"` }
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 // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. 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. // Experimental. LogicalId() *string // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. 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). // Experimental. Stack() awscdk.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog. UseServiceLinkedRole() interface{} SetUseServiceLinkedRole(val interface{}) // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::LakeFormation::Resource`.
The `AWS::LakeFormation::Resource` represents the data (Amazon S3 buckets and folders) that is being registered with AWS Lake Formation . When a `Resource` type CloudFormation template is uploaded, an 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 call is made to register the resource. When a `Resource` type CloudFormation template is removed, 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 is called.
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 roleArn: jsii.String("roleArn"), })
func NewCfnResource ¶
func NewCfnResource(scope awscdk.Construct, id *string, props *CfnResourceProps) CfnResource
Create a new `AWS::LakeFormation::Resource`.
type CfnResourceProps ¶
type CfnResourceProps struct { // The Amazon Resource Name (ARN) of the resource. ResourceArn *string `field:"required" json:"resourceArn" yaml:"resourceArn"` // Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog. UseServiceLinkedRole interface{} `field:"required" json:"useServiceLinkedRole" yaml:"useServiceLinkedRole"` // The IAM role that registered a resource. RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"` }
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 roleArn: jsii.String("roleArn"), }
type CfnTag ¶
type CfnTag interface { awscdk.CfnResource awscdk.IInspectable // `AWS::LakeFormation::Tag.CatalogId`. CatalogId() *string SetCatalogId(val *string) // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. 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. // Experimental. LogicalId() *string // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // `AWS::LakeFormation::Tag.TagKey`. TagKey() *string SetTagKey(val *string) // `AWS::LakeFormation::Tag.TagValues`. TagValues() *[]*string SetTagValues(val *[]*string) // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::LakeFormation::Tag`.
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" cfnTag := awscdk.Aws_lakeformation.NewCfnTag(this, jsii.String("MyCfnTag"), &cfnTagProps{ tagKey: jsii.String("tagKey"), tagValues: []*string{ jsii.String("tagValues"), }, // the properties below are optional catalogId: jsii.String("catalogId"), })
type CfnTagAssociation ¶
type CfnTagAssociation interface { awscdk.CfnResource awscdk.IInspectable AttrResourceIdentifier() *string AttrTagsIdentifier() *string // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. 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. // Experimental. CreationStack() *[]*string // `AWS::LakeFormation::TagAssociation.LFTags`. 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. // Experimental. LogicalId() *string // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // `AWS::LakeFormation::TagAssociation.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). // Experimental. Stack() awscdk.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::LakeFormation::TagAssociation`.
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{} cfnTagAssociation := awscdk.Aws_lakeformation.NewCfnTagAssociation(this, jsii.String("MyCfnTagAssociation"), &cfnTagAssociationProps{ lfTags: []interface{}{ &lFTagPairProperty{ catalogId: jsii.String("catalogId"), tagKey: jsii.String("tagKey"), tagValues: []*string{ jsii.String("tagValues"), }, }, }, resource: &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"), }, }, })
func NewCfnTagAssociation ¶
func NewCfnTagAssociation(scope awscdk.Construct, id *string, props *CfnTagAssociationProps) CfnTagAssociation
Create a new `AWS::LakeFormation::TagAssociation`.
type CfnTagAssociationProps ¶
type CfnTagAssociationProps struct { // `AWS::LakeFormation::TagAssociation.LFTags`. LfTags interface{} `field:"required" json:"lfTags" yaml:"lfTags"` // `AWS::LakeFormation::TagAssociation.Resource`. Resource interface{} `field:"required" json:"resource" yaml:"resource"` }
Properties for defining a `CfnTagAssociation`.
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{} cfnTagAssociationProps := &cfnTagAssociationProps{ lfTags: []interface{}{ &lFTagPairProperty{ catalogId: jsii.String("catalogId"), tagKey: jsii.String("tagKey"), tagValues: []*string{ jsii.String("tagValues"), }, }, }, resource: &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_DatabaseResourceProperty ¶
type CfnTagAssociation_DatabaseResourceProperty struct { // `CfnTagAssociation.DatabaseResourceProperty.CatalogId`. CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // `CfnTagAssociation.DatabaseResourceProperty.Name`. Name *string `field:"required" json:"name" yaml:"name"` }
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 ¶
type CfnTagAssociation_LFTagPairProperty struct { // `CfnTagAssociation.LFTagPairProperty.CatalogId`. CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // `CfnTagAssociation.LFTagPairProperty.TagKey`. TagKey *string `field:"required" json:"tagKey" yaml:"tagKey"` // `CfnTagAssociation.LFTagPairProperty.TagValues`. TagValues *[]*string `field:"required" json:"tagValues" yaml:"tagValues"` }
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" lFTagPairProperty := &lFTagPairProperty{ catalogId: jsii.String("catalogId"), tagKey: jsii.String("tagKey"), tagValues: []*string{ jsii.String("tagValues"), }, }
type CfnTagAssociation_ResourceProperty ¶
type CfnTagAssociation_ResourceProperty struct { // `CfnTagAssociation.ResourceProperty.Catalog`. Catalog interface{} `field:"optional" json:"catalog" yaml:"catalog"` // `CfnTagAssociation.ResourceProperty.Database`. Database interface{} `field:"optional" json:"database" yaml:"database"` // `CfnTagAssociation.ResourceProperty.Table`. Table interface{} `field:"optional" json:"table" yaml:"table"` // `CfnTagAssociation.ResourceProperty.TableWithColumns`. TableWithColumns interface{} `field:"optional" json:"tableWithColumns" yaml:"tableWithColumns"` }
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 ¶
type CfnTagAssociation_TableResourceProperty struct { // `CfnTagAssociation.TableResourceProperty.CatalogId`. CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // `CfnTagAssociation.TableResourceProperty.DatabaseName`. DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // `CfnTagAssociation.TableResourceProperty.Name`. Name *string `field:"optional" json:"name" yaml:"name"` // `CfnTagAssociation.TableResourceProperty.TableWildcard`. TableWildcard interface{} `field:"optional" json:"tableWildcard" yaml:"tableWildcard"` }
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 ¶
type CfnTagAssociation_TableWithColumnsResourceProperty struct { // `CfnTagAssociation.TableWithColumnsResourceProperty.CatalogId`. CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // `CfnTagAssociation.TableWithColumnsResourceProperty.ColumnNames`. ColumnNames *[]*string `field:"required" json:"columnNames" yaml:"columnNames"` // `CfnTagAssociation.TableWithColumnsResourceProperty.DatabaseName`. DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // `CfnTagAssociation.TableWithColumnsResourceProperty.Name`. Name *string `field:"required" json:"name" yaml:"name"` }
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 ¶
type CfnTagProps struct { // `AWS::LakeFormation::Tag.TagKey`. TagKey *string `field:"required" json:"tagKey" yaml:"tagKey"` // `AWS::LakeFormation::Tag.TagValues`. TagValues *[]*string `field:"required" json:"tagValues" yaml:"tagValues"` // `AWS::LakeFormation::Tag.CatalogId`. CatalogId *string `field:"optional" json:"catalogId" yaml:"catalogId"` }
Properties for defining a `CfnTag`.
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" cfnTagProps := &cfnTagProps{ tagKey: jsii.String("tagKey"), tagValues: []*string{ jsii.String("tagValues"), }, // the properties below are optional catalogId: jsii.String("catalogId"), }
Source Files ¶
- awslakeformation.go
- awslakeformation_CfnDataCellsFilter.go
- awslakeformation_CfnDataCellsFilterProps.go
- awslakeformation_CfnDataCellsFilter_ColumnWildcardProperty.go
- awslakeformation_CfnDataCellsFilter_RowFilterProperty.go
- awslakeformation_CfnDataCellsFilter__runtime_type_checks.go
- awslakeformation_CfnDataLakeSettings.go
- awslakeformation_CfnDataLakeSettingsProps.go
- awslakeformation_CfnDataLakeSettings_DataLakePrincipalProperty.go
- awslakeformation_CfnDataLakeSettings__runtime_type_checks.go
- awslakeformation_CfnPermissions.go
- awslakeformation_CfnPermissionsProps.go
- awslakeformation_CfnPermissions_ColumnWildcardProperty.go
- awslakeformation_CfnPermissions_DataLakePrincipalProperty.go
- awslakeformation_CfnPermissions_DataLocationResourceProperty.go
- awslakeformation_CfnPermissions_DatabaseResourceProperty.go
- awslakeformation_CfnPermissions_ResourceProperty.go
- awslakeformation_CfnPermissions_TableResourceProperty.go
- awslakeformation_CfnPermissions_TableWildcardProperty.go
- awslakeformation_CfnPermissions_TableWithColumnsResourceProperty.go
- awslakeformation_CfnPermissions__runtime_type_checks.go
- awslakeformation_CfnPrincipalPermissions.go
- awslakeformation_CfnPrincipalPermissionsProps.go
- awslakeformation_CfnPrincipalPermissions_ColumnWildcardProperty.go
- awslakeformation_CfnPrincipalPermissions_DataCellsFilterResourceProperty.go
- awslakeformation_CfnPrincipalPermissions_DataLakePrincipalProperty.go
- awslakeformation_CfnPrincipalPermissions_DataLocationResourceProperty.go
- awslakeformation_CfnPrincipalPermissions_DatabaseResourceProperty.go
- awslakeformation_CfnPrincipalPermissions_LFTagKeyResourceProperty.go
- awslakeformation_CfnPrincipalPermissions_LFTagPolicyResourceProperty.go
- awslakeformation_CfnPrincipalPermissions_LFTagProperty.go
- awslakeformation_CfnPrincipalPermissions_ResourceProperty.go
- awslakeformation_CfnPrincipalPermissions_TableResourceProperty.go
- awslakeformation_CfnPrincipalPermissions_TableWithColumnsResourceProperty.go
- awslakeformation_CfnPrincipalPermissions__runtime_type_checks.go
- awslakeformation_CfnResource.go
- awslakeformation_CfnResourceProps.go
- awslakeformation_CfnResource__runtime_type_checks.go
- awslakeformation_CfnTag.go
- awslakeformation_CfnTagAssociation.go
- awslakeformation_CfnTagAssociationProps.go
- awslakeformation_CfnTagAssociation_DatabaseResourceProperty.go
- awslakeformation_CfnTagAssociation_LFTagPairProperty.go
- awslakeformation_CfnTagAssociation_ResourceProperty.go
- awslakeformation_CfnTagAssociation_TableResourceProperty.go
- awslakeformation_CfnTagAssociation_TableWithColumnsResourceProperty.go
- awslakeformation_CfnTagAssociation__runtime_type_checks.go
- awslakeformation_CfnTagProps.go
- awslakeformation_CfnTag__runtime_type_checks.go