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_ReplicationConfigurationProperty
- type CfnTableBucket_ReplicationDestinationProperty
- type CfnTableBucket_ReplicationRuleProperty
- type CfnTableBucket_StorageClassConfigurationProperty
- type CfnTableBucket_UnreferencedFileRemovalProperty
- type CfnTablePolicy
- type CfnTablePolicyProps
- type CfnTableProps
- type CfnTable_CompactionProperty
- type CfnTable_IcebergMetadataProperty
- type CfnTable_IcebergPartitionFieldProperty
- type CfnTable_IcebergPartitionSpecProperty
- type CfnTable_IcebergSchemaProperty
- type CfnTable_IcebergSchemaV2Property
- type CfnTable_IcebergSortFieldProperty
- type CfnTable_IcebergSortOrderProperty
- type CfnTable_SchemaFieldProperty
- type CfnTable_SchemaV2FieldProperty
- type CfnTable_SnapshotManagementProperty
- type CfnTable_StorageClassConfigurationProperty
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{}
CfnPropertyNames() *map[string]*string
// 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 method has been renamed to `addResourceDependency` to more clearly
// set it apart from `construct.node.addDependency`. See the documentation
// of that function for more details.
// Deprecated: Use `addResourceDependency` instead.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This method has been renamed to `addResourceDependency`, which makes it
// more clear that this method operates at a different level from the
// construct-level `construct.node.addDependency()` mechanism.
// Deprecated: Use `addResourceDependency` instead.
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{})
// 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.
//
// This method only adds dependencies between L1 resources. If you are
// looking for a generic construct-to-construct dependency mechanism that works
// for all constructs including L2s, use `construct.node.addDependency` instead.
AddResourceDependency(target awscdk.CfnResource, reason *string)
// Sets the cross-stack reference strength for this resource.
//
// When set, any cross-stack reference to this resource will use the specified
// strength instead of the global default from the consuming stack's context.
ApplyCrossStackReferenceStrength(strength awscdk.ReferenceStrength)
// 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)
CfnPropertyName(cdkPropertyName *string) *string
// 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{}
// 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.
// Deprecated: Use `removeResourceDependency` instead.
RemoveDependency(target awscdk.CfnResource)
// 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.
RemoveResourceDependency(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{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
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{}
CfnPropertyNames() *map[string]*string
// 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 configuration details for the storage class of tables or table buckets.
StorageClassConfiguration() interface{}
SetStorageClassConfiguration(val interface{})
// 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 method has been renamed to `addResourceDependency` to more clearly
// set it apart from `construct.node.addDependency`. See the documentation
// of that function for more details.
// Deprecated: Use `addResourceDependency` instead.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This method has been renamed to `addResourceDependency`, which makes it
// more clear that this method operates at a different level from the
// construct-level `construct.node.addDependency()` mechanism.
// Deprecated: Use `addResourceDependency` instead.
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{})
// 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.
//
// This method only adds dependencies between L1 resources. If you are
// looking for a generic construct-to-construct dependency mechanism that works
// for all constructs including L2s, use `construct.node.addDependency` instead.
AddResourceDependency(target awscdk.CfnResource, reason *string)
// Sets the cross-stack reference strength for this resource.
//
// When set, any cross-stack reference to this resource will use the specified
// strength instead of the global default from the consuming stack's context.
ApplyCrossStackReferenceStrength(strength awscdk.ReferenceStrength)
// 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)
CfnPropertyName(cdkPropertyName *string) *string
// 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{}
// 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.
// Deprecated: Use `removeResourceDependency` instead.
RemoveDependency(target awscdk.CfnResource)
// 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.
RemoveResourceDependency(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{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
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"
var type interface{}
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{
IcebergPartitionSpec: &IcebergPartitionSpecProperty{
Fields: []interface{}{
&IcebergPartitionFieldProperty{
Name: jsii.String("name"),
SourceId: jsii.Number(123),
Transform: jsii.String("transform"),
// the properties below are optional
FieldId: jsii.Number(123),
},
},
// the properties below are optional
SpecId: jsii.Number(123),
},
IcebergSchema: &IcebergSchemaProperty{
SchemaFieldList: []interface{}{
&SchemaFieldProperty{
Name: jsii.String("name"),
Type: jsii.String("type"),
// the properties below are optional
Id: jsii.Number(123),
Required: jsii.Boolean(false),
},
},
},
IcebergSchemaV2: &IcebergSchemaV2Property{
SchemaV2FieldList: []interface{}{
&SchemaV2FieldProperty{
Id: jsii.Number(123),
Name: jsii.String("name"),
Required: jsii.Boolean(false),
Type: type,
// the properties below are optional
Doc: jsii.String("doc"),
},
},
SchemaV2FieldType: jsii.String("schemaV2FieldType"),
// the properties below are optional
IdentifierFieldIds: []interface{}{
jsii.Number(123),
},
SchemaId: jsii.Number(123),
},
IcebergSortOrder: &IcebergSortOrderProperty{
Fields: []interface{}{
&IcebergSortFieldProperty{
Direction: jsii.String("direction"),
NullOrder: jsii.String("nullOrder"),
SourceId: jsii.Number(123),
Transform: jsii.String("transform"),
},
},
// the properties below are optional
OrderId: jsii.Number(123),
},
TableProperties: map[string]*string{
"tablePropertiesKey": jsii.String("tableProperties"),
},
},
SnapshotManagement: &SnapshotManagementProperty{
MaxSnapshotAgeHours: jsii.Number(123),
MinSnapshotsToKeep: jsii.Number(123),
Status: jsii.String("status"),
},
StorageClassConfiguration: &StorageClassConfigurationProperty{
StorageClass: jsii.String("storageClass"),
},
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{}
CfnPropertyNames() *map[string]*string
// 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
// Specifies replication configuration for the table bucket.
ReplicationConfiguration() interface{}
SetReplicationConfiguration(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 configuration details for the storage class of tables or table buckets.
StorageClassConfiguration() interface{}
SetStorageClassConfiguration(val interface{})
// 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 method has been renamed to `addResourceDependency` to more clearly
// set it apart from `construct.node.addDependency`. See the documentation
// of that function for more details.
// Deprecated: Use `addResourceDependency` instead.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This method has been renamed to `addResourceDependency`, which makes it
// more clear that this method operates at a different level from the
// construct-level `construct.node.addDependency()` mechanism.
// Deprecated: Use `addResourceDependency` instead.
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{})
// 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.
//
// This method only adds dependencies between L1 resources. If you are
// looking for a generic construct-to-construct dependency mechanism that works
// for all constructs including L2s, use `construct.node.addDependency` instead.
AddResourceDependency(target awscdk.CfnResource, reason *string)
// Sets the cross-stack reference strength for this resource.
//
// When set, any cross-stack reference to this resource will use the specified
// strength instead of the global default from the consuming stack's context.
ApplyCrossStackReferenceStrength(strength awscdk.ReferenceStrength)
// 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)
CfnPropertyName(cdkPropertyName *string) *string
// 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{}
// 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.
// Deprecated: Use `removeResourceDependency` instead.
RemoveDependency(target awscdk.CfnResource)
// 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.
RemoveResourceDependency(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{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
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"),
},
ReplicationConfiguration: &ReplicationConfigurationProperty{
Role: jsii.String("role"),
Rules: []interface{}{
&ReplicationRuleProperty{
Destinations: []interface{}{
&ReplicationDestinationProperty{
DestinationTableBucketArn: jsii.String("destinationTableBucketArn"),
},
},
},
},
},
StorageClassConfiguration: &StorageClassConfigurationProperty{
StorageClass: jsii.String("storageClass"),
},
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{}
CfnPropertyNames() *map[string]*string
// 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 method has been renamed to `addResourceDependency` to more clearly
// set it apart from `construct.node.addDependency`. See the documentation
// of that function for more details.
// Deprecated: Use `addResourceDependency` instead.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This method has been renamed to `addResourceDependency`, which makes it
// more clear that this method operates at a different level from the
// construct-level `construct.node.addDependency()` mechanism.
// Deprecated: Use `addResourceDependency` instead.
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{})
// 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.
//
// This method only adds dependencies between L1 resources. If you are
// looking for a generic construct-to-construct dependency mechanism that works
// for all constructs including L2s, use `construct.node.addDependency` instead.
AddResourceDependency(target awscdk.CfnResource, reason *string)
// Sets the cross-stack reference strength for this resource.
//
// When set, any cross-stack reference to this resource will use the specified
// strength instead of the global default from the consuming stack's context.
ApplyCrossStackReferenceStrength(strength awscdk.ReferenceStrength)
// 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)
CfnPropertyName(cdkPropertyName *string) *string
// 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{}
// 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.
// Deprecated: Use `removeResourceDependency` instead.
RemoveDependency(target awscdk.CfnResource)
// 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.
RemoveResourceDependency(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{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
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"`
// Specifies replication configuration for the table bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html#cfn-s3tables-tablebucket-replicationconfiguration
//
ReplicationConfiguration interface{} `field:"optional" json:"replicationConfiguration" yaml:"replicationConfiguration"`
// The configuration details for the storage class of tables or table buckets.
//
// This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablebucket.html#cfn-s3tables-tablebucket-storageclassconfiguration
//
StorageClassConfiguration interface{} `field:"optional" json:"storageClassConfiguration" yaml:"storageClassConfiguration"`
// 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"),
},
ReplicationConfiguration: &ReplicationConfigurationProperty{
Role: jsii.String("role"),
Rules: []interface{}{
&ReplicationRuleProperty{
Destinations: []interface{}{
&ReplicationDestinationProperty{
DestinationTableBucketArn: jsii.String("destinationTableBucketArn"),
},
},
},
},
},
StorageClassConfiguration: &StorageClassConfigurationProperty{
StorageClass: jsii.String("storageClass"),
},
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_ReplicationConfigurationProperty ¶ added in v2.250.0
type CfnTableBucket_ReplicationConfigurationProperty struct {
// The ARN of the IAM role to use for replication.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-replicationconfiguration.html#cfn-s3tables-tablebucket-replicationconfiguration-role
//
Role *string `field:"required" json:"role" yaml:"role"`
// List of replication rules.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-replicationconfiguration.html#cfn-s3tables-tablebucket-replicationconfiguration-rules
//
Rules interface{} `field:"required" json:"rules" yaml:"rules"`
}
Specifies replication 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"
replicationConfigurationProperty := &ReplicationConfigurationProperty{
Role: jsii.String("role"),
Rules: []interface{}{
&ReplicationRuleProperty{
Destinations: []interface{}{
&ReplicationDestinationProperty{
DestinationTableBucketArn: jsii.String("destinationTableBucketArn"),
},
},
},
},
}
type CfnTableBucket_ReplicationDestinationProperty ¶ added in v2.250.0
type CfnTableBucket_ReplicationDestinationProperty struct {
// The ARN of the destination table bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-replicationdestination.html#cfn-s3tables-tablebucket-replicationdestination-destinationtablebucketarn
//
DestinationTableBucketArn *string `field:"required" json:"destinationTableBucketArn" yaml:"destinationTableBucketArn"`
}
A replication destination.
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"
replicationDestinationProperty := &ReplicationDestinationProperty{
DestinationTableBucketArn: jsii.String("destinationTableBucketArn"),
}
type CfnTableBucket_ReplicationRuleProperty ¶ added in v2.250.0
type CfnTableBucket_ReplicationRuleProperty struct {
// List of replication destinations.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-replicationrule.html#cfn-s3tables-tablebucket-replicationrule-destinations
//
Destinations interface{} `field:"required" json:"destinations" yaml:"destinations"`
}
A replication rule 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"
replicationRuleProperty := &ReplicationRuleProperty{
Destinations: []interface{}{
&ReplicationDestinationProperty{
DestinationTableBucketArn: jsii.String("destinationTableBucketArn"),
},
},
}
type CfnTableBucket_StorageClassConfigurationProperty ¶ added in v2.232.0
type CfnTableBucket_StorageClassConfigurationProperty struct {
// The storage class for the table or table bucket.
//
// Valid values include storage classes optimized for different access patterns and cost profiles.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-storageclassconfiguration.html#cfn-s3tables-tablebucket-storageclassconfiguration-storageclass
//
StorageClass *string `field:"optional" json:"storageClass" yaml:"storageClass"`
}
The configuration details for the storage class of tables or table buckets.
This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.
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"
storageClassConfigurationProperty := &StorageClassConfigurationProperty{
StorageClass: jsii.String("storageClass"),
}
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{}
CfnPropertyNames() *map[string]*string
// 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 method has been renamed to `addResourceDependency` to more clearly
// set it apart from `construct.node.addDependency`. See the documentation
// of that function for more details.
// Deprecated: Use `addResourceDependency` instead.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This method has been renamed to `addResourceDependency`, which makes it
// more clear that this method operates at a different level from the
// construct-level `construct.node.addDependency()` mechanism.
// Deprecated: Use `addResourceDependency` instead.
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{})
// 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.
//
// This method only adds dependencies between L1 resources. If you are
// looking for a generic construct-to-construct dependency mechanism that works
// for all constructs including L2s, use `construct.node.addDependency` instead.
AddResourceDependency(target awscdk.CfnResource, reason *string)
// Sets the cross-stack reference strength for this resource.
//
// When set, any cross-stack reference to this resource will use the specified
// strength instead of the global default from the consuming stack's context.
ApplyCrossStackReferenceStrength(strength awscdk.ReferenceStrength)
// 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)
CfnPropertyName(cdkPropertyName *string) *string
// 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{}
// 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.
// Deprecated: Use `removeResourceDependency` instead.
RemoveDependency(target awscdk.CfnResource)
// 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.
RemoveResourceDependency(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{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
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"`
// The configuration details for the storage class of tables or table buckets.
//
// This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-storageclassconfiguration
//
StorageClassConfiguration interface{} `field:"optional" json:"storageClassConfiguration" yaml:"storageClassConfiguration"`
// 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"
var type interface{}
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{
IcebergPartitionSpec: &IcebergPartitionSpecProperty{
Fields: []interface{}{
&IcebergPartitionFieldProperty{
Name: jsii.String("name"),
SourceId: jsii.Number(123),
Transform: jsii.String("transform"),
// the properties below are optional
FieldId: jsii.Number(123),
},
},
// the properties below are optional
SpecId: jsii.Number(123),
},
IcebergSchema: &IcebergSchemaProperty{
SchemaFieldList: []interface{}{
&SchemaFieldProperty{
Name: jsii.String("name"),
Type: jsii.String("type"),
// the properties below are optional
Id: jsii.Number(123),
Required: jsii.Boolean(false),
},
},
},
IcebergSchemaV2: &IcebergSchemaV2Property{
SchemaV2FieldList: []interface{}{
&SchemaV2FieldProperty{
Id: jsii.Number(123),
Name: jsii.String("name"),
Required: jsii.Boolean(false),
Type: type,
// the properties below are optional
Doc: jsii.String("doc"),
},
},
SchemaV2FieldType: jsii.String("schemaV2FieldType"),
// the properties below are optional
IdentifierFieldIds: []interface{}{
jsii.Number(123),
},
SchemaId: jsii.Number(123),
},
IcebergSortOrder: &IcebergSortOrderProperty{
Fields: []interface{}{
&IcebergSortFieldProperty{
Direction: jsii.String("direction"),
NullOrder: jsii.String("nullOrder"),
SourceId: jsii.Number(123),
Transform: jsii.String("transform"),
},
},
// the properties below are optional
OrderId: jsii.Number(123),
},
TableProperties: map[string]*string{
"tablePropertiesKey": jsii.String("tableProperties"),
},
},
SnapshotManagement: &SnapshotManagementProperty{
MaxSnapshotAgeHours: jsii.Number(123),
MinSnapshotsToKeep: jsii.Number(123),
Status: jsii.String("status"),
},
StorageClassConfiguration: &StorageClassConfigurationProperty{
StorageClass: jsii.String("storageClass"),
},
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 {
// Partition specification for an Iceberg table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergmetadata.html#cfn-s3tables-table-icebergmetadata-icebergpartitionspec
//
IcebergPartitionSpec interface{} `field:"optional" json:"icebergPartitionSpec" yaml:"icebergPartitionSpec"`
// 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:"optional" json:"icebergSchema" yaml:"icebergSchema"`
// Contains details about the schema version 2 (V2) for an Iceberg table that supports Apache Iceberg Nested Types (struct, list, map).
//
// Primitive types are also supported.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergmetadata.html#cfn-s3tables-table-icebergmetadata-icebergschemav2
//
IcebergSchemaV2 interface{} `field:"optional" json:"icebergSchemaV2" yaml:"icebergSchemaV2"`
// Sort order specification for an Iceberg table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergmetadata.html#cfn-s3tables-table-icebergmetadata-icebergsortorder
//
IcebergSortOrder interface{} `field:"optional" json:"icebergSortOrder" yaml:"icebergSortOrder"`
// Iceberg table properties (e.g., format-version, write.parquet.compression-codec).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergmetadata.html#cfn-s3tables-table-icebergmetadata-tableproperties
//
TableProperties interface{} `field:"optional" json:"tableProperties" yaml:"tableProperties"`
}
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"
var type interface{}
icebergMetadataProperty := &IcebergMetadataProperty{
IcebergPartitionSpec: &IcebergPartitionSpecProperty{
Fields: []interface{}{
&IcebergPartitionFieldProperty{
Name: jsii.String("name"),
SourceId: jsii.Number(123),
Transform: jsii.String("transform"),
// the properties below are optional
FieldId: jsii.Number(123),
},
},
// the properties below are optional
SpecId: jsii.Number(123),
},
IcebergSchema: &IcebergSchemaProperty{
SchemaFieldList: []interface{}{
&SchemaFieldProperty{
Name: jsii.String("name"),
Type: jsii.String("type"),
// the properties below are optional
Id: jsii.Number(123),
Required: jsii.Boolean(false),
},
},
},
IcebergSchemaV2: &IcebergSchemaV2Property{
SchemaV2FieldList: []interface{}{
&SchemaV2FieldProperty{
Id: jsii.Number(123),
Name: jsii.String("name"),
Required: jsii.Boolean(false),
Type: type,
// the properties below are optional
Doc: jsii.String("doc"),
},
},
SchemaV2FieldType: jsii.String("schemaV2FieldType"),
// the properties below are optional
IdentifierFieldIds: []interface{}{
jsii.Number(123),
},
SchemaId: jsii.Number(123),
},
IcebergSortOrder: &IcebergSortOrderProperty{
Fields: []interface{}{
&IcebergSortFieldProperty{
Direction: jsii.String("direction"),
NullOrder: jsii.String("nullOrder"),
SourceId: jsii.Number(123),
Transform: jsii.String("transform"),
},
},
// the properties below are optional
OrderId: jsii.Number(123),
},
TableProperties: map[string]*string{
"tablePropertiesKey": jsii.String("tableProperties"),
},
}
type CfnTable_IcebergPartitionFieldProperty ¶ added in v2.241.0
type CfnTable_IcebergPartitionFieldProperty struct {
// The name of the partition field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergpartitionfield.html#cfn-s3tables-table-icebergpartitionfield-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The source column ID to partition on.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergpartitionfield.html#cfn-s3tables-table-icebergpartitionfield-sourceid
//
SourceId *float64 `field:"required" json:"sourceId" yaml:"sourceId"`
// The partition transform function (identity, bucket[N], truncate[N], year, month, day, hour).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergpartitionfield.html#cfn-s3tables-table-icebergpartitionfield-transform
//
Transform *string `field:"required" json:"transform" yaml:"transform"`
// The partition field ID (auto-assigned starting from 1000 if not specified).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergpartitionfield.html#cfn-s3tables-table-icebergpartitionfield-fieldid
//
FieldId *float64 `field:"optional" json:"fieldId" yaml:"fieldId"`
}
A partition field specification 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"
icebergPartitionFieldProperty := &IcebergPartitionFieldProperty{
Name: jsii.String("name"),
SourceId: jsii.Number(123),
Transform: jsii.String("transform"),
// the properties below are optional
FieldId: jsii.Number(123),
}
type CfnTable_IcebergPartitionSpecProperty ¶ added in v2.241.0
type CfnTable_IcebergPartitionSpecProperty struct {
// List of partition fields for an Iceberg table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergpartitionspec.html#cfn-s3tables-table-icebergpartitionspec-fields
//
Fields interface{} `field:"required" json:"fields" yaml:"fields"`
// The partition spec ID (defaults to 0 if not specified).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergpartitionspec.html#cfn-s3tables-table-icebergpartitionspec-specid
//
SpecId *float64 `field:"optional" json:"specId" yaml:"specId"`
}
Partition specification 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"
icebergPartitionSpecProperty := &IcebergPartitionSpecProperty{
Fields: []interface{}{
&IcebergPartitionFieldProperty{
Name: jsii.String("name"),
SourceId: jsii.Number(123),
Transform: jsii.String("transform"),
// the properties below are optional
FieldId: jsii.Number(123),
},
},
// the properties below are optional
SpecId: jsii.Number(123),
}
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
Id: jsii.Number(123),
Required: jsii.Boolean(false),
},
},
}
type CfnTable_IcebergSchemaV2Property ¶ added in v2.250.0
type CfnTable_IcebergSchemaV2Property struct {
// List of schema fields that support nested types.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergschemav2.html#cfn-s3tables-table-icebergschemav2-schemav2fieldlist
//
SchemaV2FieldList interface{} `field:"required" json:"schemaV2FieldList" yaml:"schemaV2FieldList"`
// The type of the top-level schema, which is always 'struct'.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergschemav2.html#cfn-s3tables-table-icebergschemav2-schemav2fieldtype
//
SchemaV2FieldType *string `field:"required" json:"schemaV2FieldType" yaml:"schemaV2FieldType"`
// A list of field IDs that are used as the identifier fields for the table.
//
// Identifier fields uniquely identify a row in the table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergschemav2.html#cfn-s3tables-table-icebergschemav2-identifierfieldids
//
IdentifierFieldIds interface{} `field:"optional" json:"identifierFieldIds" yaml:"identifierFieldIds"`
// An optional unique identifier for the schema.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergschemav2.html#cfn-s3tables-table-icebergschemav2-schemaid
//
SchemaId *float64 `field:"optional" json:"schemaId" yaml:"schemaId"`
}
Contains details about the schema version 2 (V2) for an Iceberg table that supports Apache Iceberg Nested Types (struct, list, map).
Primitive types are also supported.
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 type interface{}
icebergSchemaV2Property := &IcebergSchemaV2Property{
SchemaV2FieldList: []interface{}{
&SchemaV2FieldProperty{
Id: jsii.Number(123),
Name: jsii.String("name"),
Required: jsii.Boolean(false),
Type: type,
// the properties below are optional
Doc: jsii.String("doc"),
},
},
SchemaV2FieldType: jsii.String("schemaV2FieldType"),
// the properties below are optional
IdentifierFieldIds: []interface{}{
jsii.Number(123),
},
SchemaId: jsii.Number(123),
}
type CfnTable_IcebergSortFieldProperty ¶ added in v2.241.0
type CfnTable_IcebergSortFieldProperty struct {
// Sort direction (asc or desc).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergsortfield.html#cfn-s3tables-table-icebergsortfield-direction
//
Direction *string `field:"required" json:"direction" yaml:"direction"`
// Null value ordering (nulls-first or nulls-last).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergsortfield.html#cfn-s3tables-table-icebergsortfield-nullorder
//
NullOrder *string `field:"required" json:"nullOrder" yaml:"nullOrder"`
// The source column ID to sort on.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergsortfield.html#cfn-s3tables-table-icebergsortfield-sourceid
//
SourceId *float64 `field:"required" json:"sourceId" yaml:"sourceId"`
// The sort transform function.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergsortfield.html#cfn-s3tables-table-icebergsortfield-transform
//
Transform *string `field:"required" json:"transform" yaml:"transform"`
}
A sort field specification 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"
icebergSortFieldProperty := &IcebergSortFieldProperty{
Direction: jsii.String("direction"),
NullOrder: jsii.String("nullOrder"),
SourceId: jsii.Number(123),
Transform: jsii.String("transform"),
}
type CfnTable_IcebergSortOrderProperty ¶ added in v2.241.0
type CfnTable_IcebergSortOrderProperty struct {
// List of sort fields for an Iceberg table.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergsortorder.html#cfn-s3tables-table-icebergsortorder-fields
//
Fields interface{} `field:"required" json:"fields" yaml:"fields"`
// The sort order ID (defaults to 1 if not specified, 0 is reserved for unsorted).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergsortorder.html#cfn-s3tables-table-icebergsortorder-orderid
//
OrderId *float64 `field:"optional" json:"orderId" yaml:"orderId"`
}
Sort order specification 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"
icebergSortOrderProperty := &IcebergSortOrderProperty{
Fields: []interface{}{
&IcebergSortFieldProperty{
Direction: jsii.String("direction"),
NullOrder: jsii.String("nullOrder"),
SourceId: jsii.Number(123),
Transform: jsii.String("transform"),
},
},
// the properties below are optional
OrderId: jsii.Number(123),
}
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"`
// The unique identifier for the field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-schemafield.html#cfn-s3tables-table-schemafield-id
//
Id *float64 `field:"optional" json:"id" yaml:"id"`
// 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
Id: jsii.Number(123),
Required: jsii.Boolean(false),
}
type CfnTable_SchemaV2FieldProperty ¶ added in v2.250.0
type CfnTable_SchemaV2FieldProperty struct {
// The unique identifier for the field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-schemav2field.html#cfn-s3tables-table-schemav2field-id
//
Id *float64 `field:"required" json:"id" yaml:"id"`
// The name of the field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-schemav2field.html#cfn-s3tables-table-schemav2field-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// A Boolean value that specifies whether values are required for each row in this field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-schemav2field.html#cfn-s3tables-table-schemav2field-required
//
Required interface{} `field:"required" json:"required" yaml:"required"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-schemav2field.html#cfn-s3tables-table-schemav2field-type
//
Type interface{} `field:"required" json:"type" yaml:"type"`
// Optional documentation for the field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-schemav2field.html#cfn-s3tables-table-schemav2field-doc
//
Doc *string `field:"optional" json:"doc" yaml:"doc"`
}
Contains details about a schema field for an Iceberg table that supports nested types (struct, list, map).
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 type interface{}
schemaV2FieldProperty := &SchemaV2FieldProperty{
Id: jsii.Number(123),
Name: jsii.String("name"),
Required: jsii.Boolean(false),
Type: type,
// the properties below are optional
Doc: jsii.String("doc"),
}
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"),
}
type CfnTable_StorageClassConfigurationProperty ¶ added in v2.232.0
type CfnTable_StorageClassConfigurationProperty struct {
// The storage class for the table or table bucket.
//
// Valid values include storage classes optimized for different access patterns and cost profiles.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-storageclassconfiguration.html#cfn-s3tables-table-storageclassconfiguration-storageclass
//
StorageClass *string `field:"optional" json:"storageClass" yaml:"storageClass"`
}
The configuration details for the storage class of tables or table buckets.
This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.
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"
storageClassConfigurationProperty := &StorageClassConfigurationProperty{
StorageClass: jsii.String("storageClass"),
}
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_ReplicationConfigurationProperty.go
- CfnTableBucket_ReplicationDestinationProperty.go
- CfnTableBucket_ReplicationRuleProperty.go
- CfnTableBucket_StorageClassConfigurationProperty.go
- CfnTableBucket_UnreferencedFileRemovalProperty.go
- CfnTableBucket__checks.go
- CfnTablePolicy.go
- CfnTablePolicyProps.go
- CfnTablePolicy__checks.go
- CfnTableProps.go
- CfnTable_CompactionProperty.go
- CfnTable_IcebergMetadataProperty.go
- CfnTable_IcebergPartitionFieldProperty.go
- CfnTable_IcebergPartitionSpecProperty.go
- CfnTable_IcebergSchemaProperty.go
- CfnTable_IcebergSchemaV2Property.go
- CfnTable_IcebergSortFieldProperty.go
- CfnTable_IcebergSortOrderProperty.go
- CfnTable_SchemaFieldProperty.go
- CfnTable_SchemaV2FieldProperty.go
- CfnTable_SnapshotManagementProperty.go
- CfnTable_StorageClassConfigurationProperty.go
- CfnTable__checks.go
- main.go