TableBucket class
Resource for managing an Amazon S3 Tables Table Bucket.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.s3tables.TableBucket("example", {name: "example-bucket"});
import pulumi
import pulumi_aws as aws
example = aws.s3tables.TableBucket("example", name="example-bucket")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.S3Tables.TableBucket("example", new()
{
Name = "example-bucket",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3tables"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := s3tables.NewTableBucket(ctx, "example", &s3tables.TableBucketArgs{
Name: pulumi.String("example-bucket"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_s3tables_tablebucket" "example" {
name = "example-bucket"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3tables.TableBucket;
import com.pulumi.aws.s3tables.TableBucketArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new TableBucket("example", TableBucketArgs.builder()
.name("example-bucket")
.build());
}
}
resources:
example:
type: aws:s3tables:TableBucket
properties:
name: example-bucket
Import
Identity Schema
Required
arn(String) ARN of the S3 Tables Table Bucket.
Using pulumi import, import S3 Tables Table Bucket using the arn. For example:
$ pulumi import aws:s3tables/tableBucket:TableBucket example arn:aws:s3tables:us-west-2:123456789012:bucket/example-bucket
Constructors
- TableBucket(String name, {TableBucketArgs? args, CustomResourceOptions? options})
-
Creates a new TableBucket.
nameThe Pulumi resource name.argsArguments used to configure this TableBucket. The set of arguments for TableBucket.optionsResource options controlling this resource's behavior. - TableBucket.reference(String urn)
- Creates a typed reference to an existing TableBucket resource.
Properties
-
arn
↔ Output<
String> -
ARN of the table bucket.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
createdAt
↔ Output<
String> -
Date and time when the bucket was created.
latefinal
-
encryptionConfiguration
↔ Output<
TableBucketEncryptionConfiguration> -
Encryption configuration for the table bucket. See
encryptionConfigurationbelow.latefinal -
forceDestroy
↔ Output<
bool> -
Whether all tables and namespaces within the table bucket should be deleted when the table bucket is destroyed so that the table bucket can be destroyed without error. These tables and namespaces are not recoverable. This only deletes tables and namespaces when the table bucket is destroyed, not when setting this parameter to
true. Once this parameter is set totrue, there must be a successfulpulumi uprun before a destroy is required to update this value in the resource state. Without a successfulpulumi upafter this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the table bucket or destroying the table bucket, this flag will not work. Additionally when importing a table bucket, a successfulpulumi upis required to set this value in state before it will take effect on a destroy operation.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
maintenanceConfiguration
↔ Output<
TableBucketMaintenanceConfiguration> -
Maintenance configuration for the table bucket. See
maintenanceConfigurationbelow.latefinal -
name
↔ Output<
String> -
Name of the table bucket. Must be between 3 and 63 characters in length. Can consist of lowercase letters, numbers, and hyphens, and must begin and end with a lowercase letter or number. A full list of bucket naming rules can be found in the S3 Tables documentation.
latefinal
-
ownerAccountId
↔ Output<
String> -
Account ID of the account that owns the table bucket.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {TableBucketState? state, CustomResourceOptions? options}) → TableBucket -
Gets an existing TableBucket resource's state with the given
nameandid.