Cluster class
Resource for managing an Amazon Aurora DSQL Cluster.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.dsql.Cluster("example", {
deletionProtectionEnabled: true,
tags: {
Name: "TestCluster",
},
});
import pulumi
import pulumi_aws as aws
example = aws.dsql.Cluster("example",
deletion_protection_enabled=True,
tags={
"Name": "TestCluster",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Dsql.Cluster("example", new()
{
DeletionProtectionEnabled = true,
Tags =
{
{ "Name", "TestCluster" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/dsql"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := dsql.NewCluster(ctx, "example", &dsql.ClusterArgs{
DeletionProtectionEnabled: pulumi.Bool(true),
Tags: pulumi.StringMap{
"Name": pulumi.String("TestCluster"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_dsql_cluster" "example" {
deletion_protection_enabled = true
tags = {
"Name" = "TestCluster"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dsql.Cluster;
import com.pulumi.aws.dsql.ClusterArgs;
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 Cluster("example", ClusterArgs.builder()
.deletionProtectionEnabled(true)
.tags(Map.of("Name", "TestCluster"))
.build());
}
}
resources:
example:
type: aws:dsql:Cluster
properties:
deletionProtectionEnabled: true
tags:
Name: TestCluster
Import
Identity Schema
Required
identifier(String) Cluster Identifier.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import DSQL Cluster using the identifier. For example:
$ pulumi import aws:dsql/cluster:Cluster example abcde1f234ghijklmnop5qr6st
Constructors
- Cluster(String name, {ClusterArgs? args, CustomResourceOptions? options})
-
Creates a new Cluster.
nameThe Pulumi resource name.argsArguments used to configure this Cluster. The set of arguments for Cluster.optionsResource options controlling this resource's behavior. - Cluster.reference(String urn)
- Creates a typed reference to an existing Cluster resource.
Properties
-
arn
↔ Output<
String> -
ARN of the Cluster.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
deletionProtectionEnabled
↔ Output<
bool> -
Whether deletion protection is enabled in this cluster.
Default value is
false.latefinal -
encryptionDetails
↔ Output<
List< ClusterEncryptionDetail> > -
Encryption configuration details for the DSQL Cluster.
latefinal
-
forceDestroy
↔ Output<
bool> -
Destroys cluster even if
deletionProtectionEnabledis set totrue. Default value isfalse.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
identifier
↔ Output<
String> -
Cluster Identifier.
latefinal
- 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
-
kmsEncryptionKey
↔ Output<
String> -
The ARN of the AWS KMS key that encrypts data in the DSQL Cluster, or
"AWS_OWNED_KMS_KEY".latefinal -
multiRegionProperties
↔ Output<
ClusterMultiRegionProperties?> -
Multi-region properties of the DSQL Cluster.
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
-
Set of tags to be associated with the AWS DSQL Cluster resource.
latefinal
-
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
timeouts
↔ Output<
ClusterTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vpcEndpointServiceName
↔ Output<
String> -
The DSQL Cluster's VPC endpoint service name.
latefinal
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