Documentation
¶
Index ¶
- func CfnNamespace_CFN_RESOURCE_TYPE_NAME() *string
- func CfnNamespace_IsCfnElement(x interface{}) *bool
- func CfnNamespace_IsCfnNamespace(x interface{}) *bool
- func CfnNamespace_IsCfnResource(x interface{}) *bool
- func CfnNamespace_IsConstruct(x interface{}) *bool
- func CfnTableBucketPolicy_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTableBucketPolicy_IsCfnElement(x interface{}) *bool
- func CfnTableBucketPolicy_IsCfnResource(x interface{}) *bool
- func CfnTableBucketPolicy_IsCfnTableBucketPolicy(x interface{}) *bool
- func CfnTableBucketPolicy_IsConstruct(x interface{}) *bool
- func CfnTableBucket_ArnForTableBucket(resource interfacesawss3tables.ITableBucketRef) *string
- func CfnTableBucket_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTableBucket_IsCfnElement(x interface{}) *bool
- func CfnTableBucket_IsCfnResource(x interface{}) *bool
- func CfnTableBucket_IsCfnTableBucket(x interface{}) *bool
- func CfnTableBucket_IsConstruct(x interface{}) *bool
- func CfnTablePolicy_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTablePolicy_IsCfnElement(x interface{}) *bool
- func CfnTablePolicy_IsCfnResource(x interface{}) *bool
- func CfnTablePolicy_IsCfnTablePolicy(x interface{}) *bool
- func CfnTablePolicy_IsConstruct(x interface{}) *bool
- func CfnTable_ArnForTable(resource interfacesawss3tables.ITableRef) *string
- func CfnTable_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTable_IsCfnElement(x interface{}) *bool
- func CfnTable_IsCfnResource(x interface{}) *bool
- func CfnTable_IsCfnTable(x interface{}) *bool
- func CfnTable_IsConstruct(x interface{}) *bool
- func NewCfnNamespace_Override(c CfnNamespace, scope constructs.Construct, id *string, ...)
- func NewCfnTableBucketPolicy_Override(c CfnTableBucketPolicy, scope constructs.Construct, id *string, ...)
- func NewCfnTableBucket_Override(c CfnTableBucket, scope constructs.Construct, id *string, ...)
- func NewCfnTablePolicy_Override(c CfnTablePolicy, scope constructs.Construct, id *string, ...)
- func NewCfnTable_Override(c CfnTable, scope constructs.Construct, id *string, props *CfnTableProps)
- type CfnNamespace
- type CfnNamespaceProps
- type CfnTable
- type CfnTableBucket
- type CfnTableBucketPolicy
- type CfnTableBucketPolicyProps
- type CfnTableBucketProps
- type CfnTableBucket_EncryptionConfigurationProperty
- type CfnTableBucket_MetricsConfigurationProperty
- type CfnTableBucket_UnreferencedFileRemovalProperty
- type CfnTablePolicy
- type CfnTablePolicyProps
- type CfnTableProps
- type CfnTable_CompactionProperty
- type CfnTable_IcebergMetadataProperty
- type CfnTable_IcebergSchemaProperty
- type CfnTable_SchemaFieldProperty
- type CfnTable_SnapshotManagementProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnNamespace_CFN_RESOURCE_TYPE_NAME ¶ added in v2.203.0
func CfnNamespace_CFN_RESOURCE_TYPE_NAME() *string
func CfnNamespace_IsCfnElement ¶ added in v2.203.0
func CfnNamespace_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnNamespace_IsCfnNamespace ¶ added in v2.231.0
func CfnNamespace_IsCfnNamespace(x interface{}) *bool
Checks whether the given object is a CfnNamespace.
func CfnNamespace_IsCfnResource ¶ added in v2.203.0
func CfnNamespace_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnNamespace_IsConstruct ¶ added in v2.203.0
func CfnNamespace_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnTableBucketPolicy_CFN_RESOURCE_TYPE_NAME ¶
func CfnTableBucketPolicy_CFN_RESOURCE_TYPE_NAME() *string
func CfnTableBucketPolicy_IsCfnElement ¶
func CfnTableBucketPolicy_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnTableBucketPolicy_IsCfnResource ¶
func CfnTableBucketPolicy_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTableBucketPolicy_IsCfnTableBucketPolicy ¶ added in v2.231.0
func CfnTableBucketPolicy_IsCfnTableBucketPolicy(x interface{}) *bool
Checks whether the given object is a CfnTableBucketPolicy.
func CfnTableBucketPolicy_IsConstruct ¶
func CfnTableBucketPolicy_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnTableBucket_ArnForTableBucket ¶ added in v2.231.0
func CfnTableBucket_ArnForTableBucket(resource interfacesawss3tables.ITableBucketRef) *string
func CfnTableBucket_CFN_RESOURCE_TYPE_NAME ¶
func CfnTableBucket_CFN_RESOURCE_TYPE_NAME() *string
func CfnTableBucket_IsCfnElement ¶
func CfnTableBucket_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnTableBucket_IsCfnResource ¶
func CfnTableBucket_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTableBucket_IsCfnTableBucket ¶ added in v2.231.0
func CfnTableBucket_IsCfnTableBucket(x interface{}) *bool
Checks whether the given object is a CfnTableBucket.
func CfnTableBucket_IsConstruct ¶
func CfnTableBucket_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnTablePolicy_CFN_RESOURCE_TYPE_NAME ¶ added in v2.208.0
func CfnTablePolicy_CFN_RESOURCE_TYPE_NAME() *string
func CfnTablePolicy_IsCfnElement ¶ added in v2.208.0
func CfnTablePolicy_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnTablePolicy_IsCfnResource ¶ added in v2.208.0
func CfnTablePolicy_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTablePolicy_IsCfnTablePolicy ¶ added in v2.231.0
func CfnTablePolicy_IsCfnTablePolicy(x interface{}) *bool
Checks whether the given object is a CfnTablePolicy.
func CfnTablePolicy_IsConstruct ¶ added in v2.208.0
func CfnTablePolicy_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnTable_ArnForTable ¶ added in v2.231.0
func CfnTable_ArnForTable(resource interfacesawss3tables.ITableRef) *string
func CfnTable_CFN_RESOURCE_TYPE_NAME ¶ added in v2.205.0
func CfnTable_CFN_RESOURCE_TYPE_NAME() *string
func CfnTable_IsCfnElement ¶ added in v2.205.0
func CfnTable_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnTable_IsCfnResource ¶ added in v2.205.0
func CfnTable_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTable_IsCfnTable ¶ added in v2.231.0
func CfnTable_IsCfnTable(x interface{}) *bool
Checks whether the given object is a CfnTable.
func CfnTable_IsConstruct ¶ added in v2.205.0
func CfnTable_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnNamespace_Override ¶ added in v2.203.0
func NewCfnNamespace_Override(c CfnNamespace, scope constructs.Construct, id *string, props *CfnNamespaceProps)
Create a new `AWS::S3Tables::Namespace`.
func NewCfnTableBucketPolicy_Override ¶
func NewCfnTableBucketPolicy_Override(c CfnTableBucketPolicy, scope constructs.Construct, id *string, props *CfnTableBucketPolicyProps)
Create a new `AWS::S3Tables::TableBucketPolicy`.
func NewCfnTableBucket_Override ¶
func NewCfnTableBucket_Override(c CfnTableBucket, scope constructs.Construct, id *string, props *CfnTableBucketProps)
Create a new `AWS::S3Tables::TableBucket`.
func NewCfnTablePolicy_Override ¶ added in v2.208.0
func NewCfnTablePolicy_Override(c CfnTablePolicy, scope constructs.Construct, id *string, props *CfnTablePolicyProps)
Create a new `AWS::S3Tables::TablePolicy`.
func NewCfnTable_Override ¶ added in v2.205.0
func NewCfnTable_Override(c CfnTable, scope constructs.Construct, id *string, props *CfnTableProps)
Create a new `AWS::S3Tables::Table`.
Types ¶
type CfnNamespace ¶ added in v2.203.0
type CfnNamespace interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawss3tables.INamespaceRef
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the namespace.
Namespace() *string
SetNamespace(val *string)
// A reference to a Namespace resource.
NamespaceRef() *interfacesawss3tables.NamespaceReference
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The Amazon Resource Name (ARN) of the table bucket to create the namespace in.
TableBucketArn() *string
SetTableBucketArn(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Creates a namespace.
A namespace is a logical grouping of tables within your table bucket, which you can use to organize tables. For more information, see [Create a namespace](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-namespace-create.html) in the *Amazon Simple Storage Service User Guide* .
- **Permissions** - You must have the `s3tables:CreateNamespace` permission to use this operation. - **Cloud Development Kit** - To use S3 Tables AWS CDK constructs, add the `@aws-cdk/aws-s3tables-alpha` dependency with one of the following options:
- NPM: `npm i.
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"
cfnNamespace := awscdk.Aws_s3tables.NewCfnNamespace(this, jsii.String("MyCfnNamespace"), &CfnNamespaceProps{
Namespace: jsii.String("namespace"),
TableBucketArn: jsii.String("tableBucketArn"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-namespace.html
func NewCfnNamespace ¶ added in v2.203.0
func NewCfnNamespace(scope constructs.Construct, id *string, props *CfnNamespaceProps) CfnNamespace
Create a new `AWS::S3Tables::Namespace`.
type CfnNamespaceProps ¶ added in v2.203.0
type CfnNamespaceProps struct {
// The name of the namespace.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-namespace.html#cfn-s3tables-namespace-namespace
//
Namespace *string `field:"required" json:"namespace" yaml:"namespace"`
// The Amazon Resource Name (ARN) of the table bucket to create the namespace in.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-namespace.html#cfn-s3tables-namespace-tablebucketarn
//
TableBucketArn *string `field:"required" json:"tableBucketArn" yaml:"tableBucketArn"`
}
Properties for defining a `CfnNamespace`.
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"
cfnNamespaceProps := &CfnNamespaceProps{
Namespace: jsii.String("namespace"),
TableBucketArn: jsii.String("tableBucketArn"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-namespace.html
type CfnTable ¶ added in v2.205.0
type CfnTable interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawss3tables.ITableRef
awscdk.ITaggableV2
// The Amazon Resource Name (ARN) of the table.
AttrTableArn() *string
// The version token of the table.
AttrVersionToken() *string
// The warehouse location of the table.
AttrWarehouseLocation() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Contains details about the compaction settings for an Iceberg table.
Compaction() interface{}
SetCompaction(val interface{})
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// Contains details about the metadata for an Iceberg table.
IcebergMetadata() interface{}
SetIcebergMetadata(val interface{})
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the namespace.
Namespace() *string
SetNamespace(val *string)
// The tree node.
Node() constructs.Node
// The format of the table.
OpenTableFormat() *string
SetOpenTableFormat(val *string)
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// Contains details about the Iceberg snapshot management settings for the table.
SnapshotManagement() interface{}
SetSnapshotManagement(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The Amazon Resource Name (ARN) of the table bucket to create the table in.
TableBucketArn() *string
SetTableBucketArn(val *string)
// The name for the table.
TableName() *string
SetTableName(val *string)
// A reference to a Table resource.
TableRef() *interfacesawss3tables.TableReference
// User tags (key-value pairs) to associate with the table.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Indicates that you don't want to specify a schema for the table.
WithoutMetadata() *string
SetWithoutMetadata(val *string)
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Creates a new table associated with the given namespace in a table bucket.
For more information, see [Creating an Amazon S3 table](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-create.html) in the *Amazon Simple Storage Service User Guide* .
- **Permissions** - - You must have the `s3tables:CreateTable` permission to use this operation. - If you use this operation with the optional `metadata` request parameter you must have the `s3tables:PutTableData` permission. - If you use this operation with the optional `encryptionConfiguration` request parameter you must have the `s3tables:PutTableEncryption` permission.
> Additionally, If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see [Permissions requirements for S3 Tables SSE-KMS encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-kms-permissions.html) . - **Cloud Development Kit** - To use S3 Tables AWS CDK constructs, add the `@aws-cdk/aws-s3tables-alpha` dependency with one of the following options:
- NPM: `npm i.
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"
cfnTable := awscdk.Aws_s3tables.NewCfnTable(this, jsii.String("MyCfnTable"), &CfnTableProps{
Namespace: jsii.String("namespace"),
OpenTableFormat: jsii.String("openTableFormat"),
TableBucketArn: jsii.String("tableBucketArn"),
TableName: jsii.String("tableName"),
// the properties below are optional
Compaction: &CompactionProperty{
Status: jsii.String("status"),
TargetFileSizeMb: jsii.Number(123),
},
IcebergMetadata: &IcebergMetadataProperty{
IcebergSchema: &IcebergSchemaProperty{
SchemaFieldList: []interface{}{
&SchemaFieldProperty{
Name: jsii.String("name"),
Type: jsii.String("type"),
// the properties below are optional
Required: jsii.Boolean(false),
},
},
},
},
SnapshotManagement: &SnapshotManagementProperty{
MaxSnapshotAgeHours: jsii.Number(123),
MinSnapshotsToKeep: jsii.Number(123),
Status: jsii.String("status"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
WithoutMetadata: jsii.String("withoutMetadata"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html
func NewCfnTable ¶ added in v2.205.0
func NewCfnTable(scope constructs.Construct, id *string, props *CfnTableProps) CfnTable
Create a new `AWS::S3Tables::Table`.
type CfnTableBucket ¶
type CfnTableBucket interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawss3tables.ITableBucketRef
awscdk.ITaggableV2
// The Amazon Resource Name (ARN) of the table bucket.
AttrTableBucketArn() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// Configuration specifying how data should be encrypted.
EncryptionConfiguration() interface{}
SetEncryptionConfiguration(val interface{})
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// Settings governing the Metric configuration for the table bucket.
MetricsConfiguration() interface{}
SetMetricsConfiguration(val interface{})
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The name for the table bucket.
TableBucketName() *string
SetTableBucketName(val *string)
// A reference to a TableBucket resource.
TableBucketRef() *interfacesawss3tables.TableBucketReference
// User tags (key-value pairs) to associate with the table bucket.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// The unreferenced file removal settings for your table bucket.
UnreferencedFileRemoval() interface{}
SetUnreferencedFileRemoval(val interface{})
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Creates a table bucket.
For more information, see [Creating a table bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-create.html) in the *Amazon Simple Storage Service User Guide* .
- **Permissions** - - You must have the `s3tables:CreateTableBucket` permission to use this operation. - If you use this operation with the optional `encryptionConfiguration` parameter you must have the `s3tables:PutTableBucketEncryption` permission. - **Cloud Development Kit** - To use S3 Tables AWS CDK constructs, add the `@aws-cdk/aws-s3tables-alpha` dependency with one of the following options:
- NPM: `npm i.
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"
cfnTableBucket := awscdk.Aws_s3tables.NewCfnTableBucket(this, jsii.String("MyCfnTableBucket"), &CfnTableBucketProps{
TableBucketName: jsii.String("tableBucketName"),
// the properties below are optional
EncryptionConfiguration: &EncryptionConfigurationProperty{
KmsKeyArn: jsii.String("kmsKeyArn"),
SseAlgorithm: jsii.String("sseAlgorithm"),
},
MetricsConfiguration: &MetricsConfigurationProperty{
Status: jsii.String("status"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
UnreferencedFileRemoval: &UnreferencedFileRemovalProperty{
NoncurrentDays: jsii.Number(123),
Status: jsii.String("status"),
UnreferencedDays: jsii.Number(123),
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html
func NewCfnTableBucket ¶
func NewCfnTableBucket(scope constructs.Construct, id *string, props *CfnTableBucketProps) CfnTableBucket
Create a new `AWS::S3Tables::TableBucket`.
type CfnTableBucketPolicy ¶
type CfnTableBucketPolicy interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawss3tables.ITableBucketPolicyRef
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The bucket policy JSON for the table bucket.
ResourcePolicy() interface{}
SetResourcePolicy(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The Amazon Resource Name (ARN) of the table bucket.
TableBucketArn() *string
SetTableBucketArn(val *string)
// A reference to a TableBucketPolicy resource.
TableBucketPolicyRef() *interfacesawss3tables.TableBucketPolicyReference
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Creates a new maintenance configuration or replaces an existing table bucket policy for a table bucket.
For more information, see [Adding a table bucket policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-bucket-policy.html#table-bucket-policy-add) in the *Amazon Simple Storage Service User Guide* .
- **Permissions** - You must have the `s3tables:PutTableBucketPolicy` permission to use this operation. - **Cloud Development Kit** - To use S3 Tables AWS CDK constructs, add the `@aws-cdk/aws-s3tables-alpha` dependency with one of the following options:
- NPM: `npm i.
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 resourcePolicy interface{}
cfnTableBucketPolicy := awscdk.Aws_s3tables.NewCfnTableBucketPolicy(this, jsii.String("MyCfnTableBucketPolicy"), &CfnTableBucketPolicyProps{
ResourcePolicy: resourcePolicy,
TableBucketArn: jsii.String("tableBucketArn"),
})
func NewCfnTableBucketPolicy ¶
func NewCfnTableBucketPolicy(scope constructs.Construct, id *string, props *CfnTableBucketPolicyProps) CfnTableBucketPolicy
Create a new `AWS::S3Tables::TableBucketPolicy`.
type CfnTableBucketPolicyProps ¶
type CfnTableBucketPolicyProps struct {
// The bucket policy JSON for the table bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucketpolicy.html#cfn-s3tables-tablebucketpolicy-resourcepolicy
//
ResourcePolicy interface{} `field:"required" json:"resourcePolicy" yaml:"resourcePolicy"`
// The Amazon Resource Name (ARN) of the table bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucketpolicy.html#cfn-s3tables-tablebucketpolicy-tablebucketarn
//
TableBucketArn *string `field:"required" json:"tableBucketArn" yaml:"tableBucketArn"`
}
Properties for defining a `CfnTableBucketPolicy`.
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 resourcePolicy interface{}
cfnTableBucketPolicyProps := &CfnTableBucketPolicyProps{
ResourcePolicy: resourcePolicy,
TableBucketArn: jsii.String("tableBucketArn"),
}
type CfnTableBucketProps ¶
type CfnTableBucketProps struct {
// The name for the table bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html#cfn-s3tables-tablebucket-tablebucketname
//
TableBucketName *string `field:"required" json:"tableBucketName" yaml:"tableBucketName"`
// Configuration specifying how data should be encrypted.
//
// This structure defines the encryption algorithm and optional KMS key to be used for server-side encryption.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html#cfn-s3tables-tablebucket-encryptionconfiguration
//
EncryptionConfiguration interface{} `field:"optional" json:"encryptionConfiguration" yaml:"encryptionConfiguration"`
// Settings governing the Metric configuration for the table bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html#cfn-s3tables-tablebucket-metricsconfiguration
//
MetricsConfiguration interface{} `field:"optional" json:"metricsConfiguration" yaml:"metricsConfiguration"`
// User tags (key-value pairs) to associate with the table bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html#cfn-s3tables-tablebucket-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The unreferenced file removal settings for your table bucket.
//
// Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. For more information, see the [*Amazon S3 User Guide*](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-table-buckets-maintenance.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html#cfn-s3tables-tablebucket-unreferencedfileremoval
//
UnreferencedFileRemoval interface{} `field:"optional" json:"unreferencedFileRemoval" yaml:"unreferencedFileRemoval"`
}
Properties for defining a `CfnTableBucket`.
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"
cfnTableBucketProps := &CfnTableBucketProps{
TableBucketName: jsii.String("tableBucketName"),
// the properties below are optional
EncryptionConfiguration: &EncryptionConfigurationProperty{
KmsKeyArn: jsii.String("kmsKeyArn"),
SseAlgorithm: jsii.String("sseAlgorithm"),
},
MetricsConfiguration: &MetricsConfigurationProperty{
Status: jsii.String("status"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
UnreferencedFileRemoval: &UnreferencedFileRemovalProperty{
NoncurrentDays: jsii.Number(123),
Status: jsii.String("status"),
UnreferencedDays: jsii.Number(123),
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html
type CfnTableBucket_EncryptionConfigurationProperty ¶ added in v2.191.0
type CfnTableBucket_EncryptionConfigurationProperty struct {
// The Amazon Resource Name (ARN) of the KMS key to use for encryption.
//
// This field is required only when `sseAlgorithm` is set to `aws:kms` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-encryptionconfiguration.html#cfn-s3tables-tablebucket-encryptionconfiguration-kmskeyarn
//
KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"`
// The server-side encryption algorithm to use.
//
// Valid values are `AES256` for S3-managed encryption keys, or `aws:kms` for AWS KMS-managed encryption keys. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see [Permissions requirements for S3 Tables SSE-KMS encryption](https://docs.aws.amazon.com//AmazonS3/latest/userguide/s3-tables-kms-permissions.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-encryptionconfiguration.html#cfn-s3tables-tablebucket-encryptionconfiguration-ssealgorithm
//
SseAlgorithm *string `field:"optional" json:"sseAlgorithm" yaml:"sseAlgorithm"`
}
Configuration specifying how data should be encrypted.
This structure defines the encryption algorithm and optional KMS key to be used for server-side encryption.
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"
encryptionConfigurationProperty := &EncryptionConfigurationProperty{
KmsKeyArn: jsii.String("kmsKeyArn"),
SseAlgorithm: jsii.String("sseAlgorithm"),
}
type CfnTableBucket_MetricsConfigurationProperty ¶ added in v2.225.0
type CfnTableBucket_MetricsConfigurationProperty struct {
// Indicates whether Metrics are enabled.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-metricsconfiguration.html#cfn-s3tables-tablebucket-metricsconfiguration-status
//
// Default: - "Disabled".
//
Status *string `field:"optional" json:"status" yaml:"status"`
}
Settings governing the Metric configuration for the table bucket.
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"
metricsConfigurationProperty := &MetricsConfigurationProperty{
Status: jsii.String("status"),
}
type CfnTableBucket_UnreferencedFileRemovalProperty ¶
type CfnTableBucket_UnreferencedFileRemovalProperty struct {
// The number of days an object can be noncurrent before Amazon S3 deletes it.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-unreferencedfileremoval.html#cfn-s3tables-tablebucket-unreferencedfileremoval-noncurrentdays
//
NoncurrentDays *float64 `field:"optional" json:"noncurrentDays" yaml:"noncurrentDays"`
// The status of the unreferenced file removal configuration for your table bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-unreferencedfileremoval.html#cfn-s3tables-tablebucket-unreferencedfileremoval-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
// The number of days an object must be unreferenced by your table before Amazon S3 marks the object as noncurrent.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-unreferencedfileremoval.html#cfn-s3tables-tablebucket-unreferencedfileremoval-unreferenceddays
//
UnreferencedDays *float64 `field:"optional" json:"unreferencedDays" yaml:"unreferencedDays"`
}
The unreferenced file removal settings for your table bucket.
Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. For more information, see the [*Amazon S3 User Guide*](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-table-buckets-maintenance.html) .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
unreferencedFileRemovalProperty := &UnreferencedFileRemovalProperty{
NoncurrentDays: jsii.Number(123),
Status: jsii.String("status"),
UnreferencedDays: jsii.Number(123),
}
type CfnTablePolicy ¶ added in v2.208.0
type CfnTablePolicy interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawss3tables.ITablePolicyRef
// The namespace to associated with the table.
AttrNamespace() *string
// The Amazon Resource Name (ARN) of the table bucket that contains the table.
AttrTableBucketArn() *string
// The name of the table.
AttrTableName() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The `JSON` that defines the policy.
ResourcePolicy() interface{}
SetResourcePolicy(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The Amazon Resource Name (ARN) of the table.
TableArn() *string
SetTableArn(val *string)
// A reference to a TablePolicy resource.
TablePolicyRef() *interfacesawss3tables.TablePolicyReference
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Creates a new maintenance configuration or replaces an existing table policy for a table.
For more information, see [Adding a table policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-table-policy.html#table-policy-add) in the *Amazon Simple Storage Service User Guide* .
- **Permissions** - You must have the `s3tables:PutTablePolicy` permission to use this operation. - **Cloud Development Kit** - To use S3 Tables AWS CDK constructs, add the `@aws-cdk/aws-s3tables-alpha` dependency with one of the following options:
- NPM: `npm i.
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 resourcePolicy interface{}
cfnTablePolicy := awscdk.Aws_s3tables.NewCfnTablePolicy(this, jsii.String("MyCfnTablePolicy"), &CfnTablePolicyProps{
ResourcePolicy: resourcePolicy,
TableArn: jsii.String("tableArn"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablepolicy.html
func NewCfnTablePolicy ¶ added in v2.208.0
func NewCfnTablePolicy(scope constructs.Construct, id *string, props *CfnTablePolicyProps) CfnTablePolicy
Create a new `AWS::S3Tables::TablePolicy`.
type CfnTablePolicyProps ¶ added in v2.208.0
type CfnTablePolicyProps struct {
// The `JSON` that defines the policy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablepolicy.html#cfn-s3tables-tablepolicy-resourcepolicy
//
ResourcePolicy interface{} `field:"required" json:"resourcePolicy" yaml:"resourcePolicy"`
// The Amazon Resource Name (ARN) of the table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablepolicy.html#cfn-s3tables-tablepolicy-tablearn
//
TableArn *string `field:"required" json:"tableArn" yaml:"tableArn"`
}
Properties for defining a `CfnTablePolicy`.
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 resourcePolicy interface{}
cfnTablePolicyProps := &CfnTablePolicyProps{
ResourcePolicy: resourcePolicy,
TableArn: jsii.String("tableArn"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablepolicy.html
type CfnTableProps ¶ added in v2.205.0
type CfnTableProps struct {
// The name of the namespace.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-namespace
//
Namespace *string `field:"required" json:"namespace" yaml:"namespace"`
// The format of the table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-opentableformat
//
OpenTableFormat *string `field:"required" json:"openTableFormat" yaml:"openTableFormat"`
// The Amazon Resource Name (ARN) of the table bucket to create the table in.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-tablebucketarn
//
TableBucketArn *string `field:"required" json:"tableBucketArn" yaml:"tableBucketArn"`
// The name for the table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-tablename
//
TableName *string `field:"required" json:"tableName" yaml:"tableName"`
// Contains details about the compaction settings for an Iceberg table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-compaction
//
Compaction interface{} `field:"optional" json:"compaction" yaml:"compaction"`
// Contains details about the metadata for an Iceberg table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-icebergmetadata
//
IcebergMetadata interface{} `field:"optional" json:"icebergMetadata" yaml:"icebergMetadata"`
// Contains details about the Iceberg snapshot management settings for the table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-snapshotmanagement
//
SnapshotManagement interface{} `field:"optional" json:"snapshotManagement" yaml:"snapshotManagement"`
// User tags (key-value pairs) to associate with the table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// Indicates that you don't want to specify a schema for the table.
//
// This property is mutually exclusive to `IcebergMetadata` , and its only possible value is `Yes` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-withoutmetadata
//
WithoutMetadata *string `field:"optional" json:"withoutMetadata" yaml:"withoutMetadata"`
}
Properties for defining a `CfnTable`.
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"
cfnTableProps := &CfnTableProps{
Namespace: jsii.String("namespace"),
OpenTableFormat: jsii.String("openTableFormat"),
TableBucketArn: jsii.String("tableBucketArn"),
TableName: jsii.String("tableName"),
// the properties below are optional
Compaction: &CompactionProperty{
Status: jsii.String("status"),
TargetFileSizeMb: jsii.Number(123),
},
IcebergMetadata: &IcebergMetadataProperty{
IcebergSchema: &IcebergSchemaProperty{
SchemaFieldList: []interface{}{
&SchemaFieldProperty{
Name: jsii.String("name"),
Type: jsii.String("type"),
// the properties below are optional
Required: jsii.Boolean(false),
},
},
},
},
SnapshotManagement: &SnapshotManagementProperty{
MaxSnapshotAgeHours: jsii.Number(123),
MinSnapshotsToKeep: jsii.Number(123),
Status: jsii.String("status"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
WithoutMetadata: jsii.String("withoutMetadata"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html
type CfnTable_CompactionProperty ¶ added in v2.205.0
type CfnTable_CompactionProperty struct {
// The status of the maintenance configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-compaction.html#cfn-s3tables-table-compaction-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
// The target file size for the table in MB.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-compaction.html#cfn-s3tables-table-compaction-targetfilesizemb
//
TargetFileSizeMb *float64 `field:"optional" json:"targetFileSizeMb" yaml:"targetFileSizeMb"`
}
Contains details about the compaction settings for an Iceberg table.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
compactionProperty := &CompactionProperty{
Status: jsii.String("status"),
TargetFileSizeMb: jsii.Number(123),
}
type CfnTable_IcebergMetadataProperty ¶ added in v2.205.0
type CfnTable_IcebergMetadataProperty struct {
// The schema for an Iceberg table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergmetadata.html#cfn-s3tables-table-icebergmetadata-icebergschema
//
IcebergSchema interface{} `field:"required" json:"icebergSchema" yaml:"icebergSchema"`
}
Contains details about the metadata for an Iceberg table.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
icebergMetadataProperty := &IcebergMetadataProperty{
IcebergSchema: &IcebergSchemaProperty{
SchemaFieldList: []interface{}{
&SchemaFieldProperty{
Name: jsii.String("name"),
Type: jsii.String("type"),
// the properties below are optional
Required: jsii.Boolean(false),
},
},
},
}
type CfnTable_IcebergSchemaProperty ¶ added in v2.205.0
type CfnTable_IcebergSchemaProperty struct {
// The schema fields for the table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergschema.html#cfn-s3tables-table-icebergschema-schemafieldlist
//
SchemaFieldList interface{} `field:"required" json:"schemaFieldList" yaml:"schemaFieldList"`
}
Contains details about the schema for an Iceberg table.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
icebergSchemaProperty := &IcebergSchemaProperty{
SchemaFieldList: []interface{}{
&SchemaFieldProperty{
Name: jsii.String("name"),
Type: jsii.String("type"),
// the properties below are optional
Required: jsii.Boolean(false),
},
},
}
type CfnTable_SchemaFieldProperty ¶ added in v2.205.0
type CfnTable_SchemaFieldProperty struct {
// The name of the field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-schemafield.html#cfn-s3tables-table-schemafield-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The field type.
//
// S3 Tables supports all Apache Iceberg primitive types. For more information, see the [Apache Iceberg documentation](https://docs.aws.amazon.com/https://iceberg.apache.org/spec/#primitive-types) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-schemafield.html#cfn-s3tables-table-schemafield-type
//
Type *string `field:"required" json:"type" yaml:"type"`
// A Boolean value that specifies whether values are required for each row in this field.
//
// By default, this is `false` and null values are allowed in the field. If this is `true` the field does not allow null values.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-schemafield.html#cfn-s3tables-table-schemafield-required
//
Required interface{} `field:"optional" json:"required" yaml:"required"`
}
Contains details about a schema field.
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"
schemaFieldProperty := &SchemaFieldProperty{
Name: jsii.String("name"),
Type: jsii.String("type"),
// the properties below are optional
Required: jsii.Boolean(false),
}
type CfnTable_SnapshotManagementProperty ¶ added in v2.205.0
type CfnTable_SnapshotManagementProperty struct {
// The maximum age of a snapshot before it can be expired.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-snapshotmanagement.html#cfn-s3tables-table-snapshotmanagement-maxsnapshotagehours
//
MaxSnapshotAgeHours *float64 `field:"optional" json:"maxSnapshotAgeHours" yaml:"maxSnapshotAgeHours"`
// The minimum number of snapshots to keep.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-snapshotmanagement.html#cfn-s3tables-table-snapshotmanagement-minsnapshotstokeep
//
MinSnapshotsToKeep *float64 `field:"optional" json:"minSnapshotsToKeep" yaml:"minSnapshotsToKeep"`
// The status of the maintenance configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-snapshotmanagement.html#cfn-s3tables-table-snapshotmanagement-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
}
Contains details about the snapshot management settings for an Iceberg table.
The oldest snapshot expires when its age exceeds the `maxSnapshotAgeHours` and the total number of snapshots exceeds the value for the minimum number of snapshots to keep `minSnapshotsToKeep` .
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"
snapshotManagementProperty := &SnapshotManagementProperty{
MaxSnapshotAgeHours: jsii.Number(123),
MinSnapshotsToKeep: jsii.Number(123),
Status: jsii.String("status"),
}
Source Files
¶
- CfnNamespace.go
- CfnNamespaceProps.go
- CfnNamespace__checks.go
- CfnTable.go
- CfnTableBucket.go
- CfnTableBucketPolicy.go
- CfnTableBucketPolicyProps.go
- CfnTableBucketPolicy__checks.go
- CfnTableBucketProps.go
- CfnTableBucket_EncryptionConfigurationProperty.go
- CfnTableBucket_MetricsConfigurationProperty.go
- CfnTableBucket_UnreferencedFileRemovalProperty.go
- CfnTableBucket__checks.go
- CfnTablePolicy.go
- CfnTablePolicyProps.go
- CfnTablePolicy__checks.go
- CfnTableProps.go
- CfnTable_CompactionProperty.go
- CfnTable_IcebergMetadataProperty.go
- CfnTable_IcebergSchemaProperty.go
- CfnTable_SchemaFieldProperty.go
- CfnTable_SnapshotManagementProperty.go
- CfnTable__checks.go
- main.go