AWS Classic v5.41.0, May 15 23
AWS Classic v5.41.0, May 15 23
aws.neptune.GlobalCluster
Explore with Pulumi AI
Manages a Neptune Global Cluster. A global cluster consists of one primary region and up to five read-only secondary regions. You issue write operations directly to the primary cluster in the primary region and Amazon Neptune automatically replicates the data to the secondary regions using dedicated infrastructure.
More information about Neptune Global Clusters can be found in the Neptune User Guide.
Example Usage
New Neptune Global Cluster
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var primary = new Aws.Provider("primary", new()
{
Region = "us-east-2",
});
var secondary = new Aws.Provider("secondary", new()
{
Region = "us-east-1",
});
var example = new Aws.Neptune.GlobalCluster("example", new()
{
GlobalClusterIdentifier = "global-test",
Engine = "neptune",
EngineVersion = "1.2.0.0",
});
var primaryCluster = new Aws.Neptune.Cluster("primaryCluster", new()
{
Engine = example.Engine,
EngineVersion = example.EngineVersion,
ClusterIdentifier = "test-primary-cluster",
GlobalClusterIdentifier = example.Id,
NeptuneSubnetGroupName = "default",
}, new CustomResourceOptions
{
Provider = aws.Primary,
});
var primaryClusterInstance = new Aws.Neptune.ClusterInstance("primaryClusterInstance", new()
{
Engine = example.Engine,
EngineVersion = example.EngineVersion,
Identifier = "test-primary-cluster-instance",
ClusterIdentifier = primaryCluster.Id,
InstanceClass = "db.r5.large",
NeptuneSubnetGroupName = "default",
}, new CustomResourceOptions
{
Provider = aws.Primary,
});
var secondaryCluster = new Aws.Neptune.Cluster("secondaryCluster", new()
{
Engine = example.Engine,
EngineVersion = example.EngineVersion,
ClusterIdentifier = "test-secondary-cluster",
GlobalClusterIdentifier = example.Id,
NeptuneSubnetGroupName = "default",
}, new CustomResourceOptions
{
Provider = aws.Secondary,
});
var secondaryClusterInstance = new Aws.Neptune.ClusterInstance("secondaryClusterInstance", new()
{
Engine = example.Engine,
EngineVersion = example.EngineVersion,
Identifier = "test-secondary-cluster-instance",
ClusterIdentifier = secondaryCluster.Id,
InstanceClass = "db.r5.large",
NeptuneSubnetGroupName = "default",
}, new CustomResourceOptions
{
Provider = aws.Secondary,
DependsOn = new[]
{
primaryClusterInstance,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/neptune"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := aws.NewProvider(ctx, "primary", &aws.ProviderArgs{
Region: pulumi.String("us-east-2"),
})
if err != nil {
return err
}
_, err = aws.NewProvider(ctx, "secondary", &aws.ProviderArgs{
Region: pulumi.String("us-east-1"),
})
if err != nil {
return err
}
example, err := neptune.NewGlobalCluster(ctx, "example", &neptune.GlobalClusterArgs{
GlobalClusterIdentifier: pulumi.String("global-test"),
Engine: pulumi.String("neptune"),
EngineVersion: pulumi.String("1.2.0.0"),
})
if err != nil {
return err
}
primaryCluster, err := neptune.NewCluster(ctx, "primaryCluster", &neptune.ClusterArgs{
Engine: example.Engine,
EngineVersion: example.EngineVersion,
ClusterIdentifier: pulumi.String("test-primary-cluster"),
GlobalClusterIdentifier: example.ID(),
NeptuneSubnetGroupName: pulumi.String("default"),
}, pulumi.Provider(aws.Primary))
if err != nil {
return err
}
primaryClusterInstance, err := neptune.NewClusterInstance(ctx, "primaryClusterInstance", &neptune.ClusterInstanceArgs{
Engine: example.Engine,
EngineVersion: example.EngineVersion,
Identifier: pulumi.String("test-primary-cluster-instance"),
ClusterIdentifier: primaryCluster.ID(),
InstanceClass: pulumi.String("db.r5.large"),
NeptuneSubnetGroupName: pulumi.String("default"),
}, pulumi.Provider(aws.Primary))
if err != nil {
return err
}
secondaryCluster, err := neptune.NewCluster(ctx, "secondaryCluster", &neptune.ClusterArgs{
Engine: example.Engine,
EngineVersion: example.EngineVersion,
ClusterIdentifier: pulumi.String("test-secondary-cluster"),
GlobalClusterIdentifier: example.ID(),
NeptuneSubnetGroupName: pulumi.String("default"),
}, pulumi.Provider(aws.Secondary))
if err != nil {
return err
}
_, err = neptune.NewClusterInstance(ctx, "secondaryClusterInstance", &neptune.ClusterInstanceArgs{
Engine: example.Engine,
EngineVersion: example.EngineVersion,
Identifier: pulumi.String("test-secondary-cluster-instance"),
ClusterIdentifier: secondaryCluster.ID(),
InstanceClass: pulumi.String("db.r5.large"),
NeptuneSubnetGroupName: pulumi.String("default"),
}, pulumi.Provider(aws.Secondary), pulumi.DependsOn([]pulumi.Resource{
primaryClusterInstance,
}))
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.Provider;
import com.pulumi.aws.ProviderArgs;
import com.pulumi.aws.neptune.GlobalCluster;
import com.pulumi.aws.neptune.GlobalClusterArgs;
import com.pulumi.aws.neptune.Cluster;
import com.pulumi.aws.neptune.ClusterArgs;
import com.pulumi.aws.neptune.ClusterInstance;
import com.pulumi.aws.neptune.ClusterInstanceArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
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 primary = new Provider("primary", ProviderArgs.builder()
.region("us-east-2")
.build());
var secondary = new Provider("secondary", ProviderArgs.builder()
.region("us-east-1")
.build());
var example = new GlobalCluster("example", GlobalClusterArgs.builder()
.globalClusterIdentifier("global-test")
.engine("neptune")
.engineVersion("1.2.0.0")
.build());
var primaryCluster = new Cluster("primaryCluster", ClusterArgs.builder()
.engine(example.engine())
.engineVersion(example.engineVersion())
.clusterIdentifier("test-primary-cluster")
.globalClusterIdentifier(example.id())
.neptuneSubnetGroupName("default")
.build(), CustomResourceOptions.builder()
.provider(aws.primary())
.build());
var primaryClusterInstance = new ClusterInstance("primaryClusterInstance", ClusterInstanceArgs.builder()
.engine(example.engine())
.engineVersion(example.engineVersion())
.identifier("test-primary-cluster-instance")
.clusterIdentifier(primaryCluster.id())
.instanceClass("db.r5.large")
.neptuneSubnetGroupName("default")
.build(), CustomResourceOptions.builder()
.provider(aws.primary())
.build());
var secondaryCluster = new Cluster("secondaryCluster", ClusterArgs.builder()
.engine(example.engine())
.engineVersion(example.engineVersion())
.clusterIdentifier("test-secondary-cluster")
.globalClusterIdentifier(example.id())
.neptuneSubnetGroupName("default")
.build(), CustomResourceOptions.builder()
.provider(aws.secondary())
.build());
var secondaryClusterInstance = new ClusterInstance("secondaryClusterInstance", ClusterInstanceArgs.builder()
.engine(example.engine())
.engineVersion(example.engineVersion())
.identifier("test-secondary-cluster-instance")
.clusterIdentifier(secondaryCluster.id())
.instanceClass("db.r5.large")
.neptuneSubnetGroupName("default")
.build(), CustomResourceOptions.builder()
.provider(aws.secondary())
.dependsOn(primaryClusterInstance)
.build());
}
}
import pulumi
import pulumi_aws as aws
primary = aws.Provider("primary", region="us-east-2")
secondary = aws.Provider("secondary", region="us-east-1")
example = aws.neptune.GlobalCluster("example",
global_cluster_identifier="global-test",
engine="neptune",
engine_version="1.2.0.0")
primary_cluster = aws.neptune.Cluster("primaryCluster",
engine=example.engine,
engine_version=example.engine_version,
cluster_identifier="test-primary-cluster",
global_cluster_identifier=example.id,
neptune_subnet_group_name="default",
opts=pulumi.ResourceOptions(provider=aws["primary"]))
primary_cluster_instance = aws.neptune.ClusterInstance("primaryClusterInstance",
engine=example.engine,
engine_version=example.engine_version,
identifier="test-primary-cluster-instance",
cluster_identifier=primary_cluster.id,
instance_class="db.r5.large",
neptune_subnet_group_name="default",
opts=pulumi.ResourceOptions(provider=aws["primary"]))
secondary_cluster = aws.neptune.Cluster("secondaryCluster",
engine=example.engine,
engine_version=example.engine_version,
cluster_identifier="test-secondary-cluster",
global_cluster_identifier=example.id,
neptune_subnet_group_name="default",
opts=pulumi.ResourceOptions(provider=aws["secondary"]))
secondary_cluster_instance = aws.neptune.ClusterInstance("secondaryClusterInstance",
engine=example.engine,
engine_version=example.engine_version,
identifier="test-secondary-cluster-instance",
cluster_identifier=secondary_cluster.id,
instance_class="db.r5.large",
neptune_subnet_group_name="default",
opts=pulumi.ResourceOptions(provider=aws["secondary"],
depends_on=[primary_cluster_instance]))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const primary = new aws.Provider("primary", {region: "us-east-2"});
const secondary = new aws.Provider("secondary", {region: "us-east-1"});
const example = new aws.neptune.GlobalCluster("example", {
globalClusterIdentifier: "global-test",
engine: "neptune",
engineVersion: "1.2.0.0",
});
const primaryCluster = new aws.neptune.Cluster("primaryCluster", {
engine: example.engine,
engineVersion: example.engineVersion,
clusterIdentifier: "test-primary-cluster",
globalClusterIdentifier: example.id,
neptuneSubnetGroupName: "default",
}, {
provider: aws.primary,
});
const primaryClusterInstance = new aws.neptune.ClusterInstance("primaryClusterInstance", {
engine: example.engine,
engineVersion: example.engineVersion,
identifier: "test-primary-cluster-instance",
clusterIdentifier: primaryCluster.id,
instanceClass: "db.r5.large",
neptuneSubnetGroupName: "default",
}, {
provider: aws.primary,
});
const secondaryCluster = new aws.neptune.Cluster("secondaryCluster", {
engine: example.engine,
engineVersion: example.engineVersion,
clusterIdentifier: "test-secondary-cluster",
globalClusterIdentifier: example.id,
neptuneSubnetGroupName: "default",
}, {
provider: aws.secondary,
});
const secondaryClusterInstance = new aws.neptune.ClusterInstance("secondaryClusterInstance", {
engine: example.engine,
engineVersion: example.engineVersion,
identifier: "test-secondary-cluster-instance",
clusterIdentifier: secondaryCluster.id,
instanceClass: "db.r5.large",
neptuneSubnetGroupName: "default",
}, {
provider: aws.secondary,
dependsOn: [primaryClusterInstance],
});
resources:
primary:
type: pulumi:providers:aws
properties:
region: us-east-2
secondary:
type: pulumi:providers:aws
properties:
region: us-east-1
example:
type: aws:neptune:GlobalCluster
properties:
globalClusterIdentifier: global-test
engine: neptune
engineVersion: 1.2.0.0
primaryCluster:
type: aws:neptune:Cluster
properties:
engine: ${example.engine}
engineVersion: ${example.engineVersion}
clusterIdentifier: test-primary-cluster
globalClusterIdentifier: ${example.id}
neptuneSubnetGroupName: default
options:
provider: ${aws.primary}
primaryClusterInstance:
type: aws:neptune:ClusterInstance
properties:
engine: ${example.engine}
engineVersion: ${example.engineVersion}
identifier: test-primary-cluster-instance
clusterIdentifier: ${primaryCluster.id}
instanceClass: db.r5.large
neptuneSubnetGroupName: default
options:
provider: ${aws.primary}
secondaryCluster:
type: aws:neptune:Cluster
properties:
engine: ${example.engine}
engineVersion: ${example.engineVersion}
clusterIdentifier: test-secondary-cluster
globalClusterIdentifier: ${example.id}
neptuneSubnetGroupName: default
options:
provider: ${aws.secondary}
secondaryClusterInstance:
type: aws:neptune:ClusterInstance
properties:
engine: ${example.engine}
engineVersion: ${example.engineVersion}
identifier: test-secondary-cluster-instance
clusterIdentifier: ${secondaryCluster.id}
instanceClass: db.r5.large
neptuneSubnetGroupName: default
options:
provider: ${aws.secondary}
dependson:
- ${primaryClusterInstance}
New Global Cluster From Existing DB Cluster
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
// ... other configuration ...
var exampleCluster = new Aws.Neptune.Cluster("exampleCluster");
var exampleGlobalCluster = new Aws.Neptune.GlobalCluster("exampleGlobalCluster", new()
{
GlobalClusterIdentifier = "example",
SourceDbClusterIdentifier = exampleCluster.Arn,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/neptune"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleCluster, err := neptune.NewCluster(ctx, "exampleCluster", nil)
if err != nil {
return err
}
_, err = neptune.NewGlobalCluster(ctx, "exampleGlobalCluster", &neptune.GlobalClusterArgs{
GlobalClusterIdentifier: pulumi.String("example"),
SourceDbClusterIdentifier: exampleCluster.Arn,
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.neptune.Cluster;
import com.pulumi.aws.neptune.GlobalCluster;
import com.pulumi.aws.neptune.GlobalClusterArgs;
import java.util.List;
import java.util.ArrayList;
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 exampleCluster = new Cluster("exampleCluster");
var exampleGlobalCluster = new GlobalCluster("exampleGlobalCluster", GlobalClusterArgs.builder()
.globalClusterIdentifier("example")
.sourceDbClusterIdentifier(exampleCluster.arn())
.build());
}
}
import pulumi
import pulumi_aws as aws
# ... other configuration ...
example_cluster = aws.neptune.Cluster("exampleCluster")
example_global_cluster = aws.neptune.GlobalCluster("exampleGlobalCluster",
global_cluster_identifier="example",
source_db_cluster_identifier=example_cluster.arn)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
// ... other configuration ...
const exampleCluster = new aws.neptune.Cluster("exampleCluster", {});
const exampleGlobalCluster = new aws.neptune.GlobalCluster("exampleGlobalCluster", {
globalClusterIdentifier: "example",
sourceDbClusterIdentifier: exampleCluster.arn,
});
resources:
exampleCluster:
type: aws:neptune:Cluster
exampleGlobalCluster:
type: aws:neptune:GlobalCluster
properties:
globalClusterIdentifier: example
sourceDbClusterIdentifier: ${exampleCluster.arn}
Create GlobalCluster Resource
new GlobalCluster(name: string, args: GlobalClusterArgs, opts?: CustomResourceOptions);
@overload
def GlobalCluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
deletion_protection: Optional[bool] = None,
engine: Optional[str] = None,
engine_version: Optional[str] = None,
global_cluster_identifier: Optional[str] = None,
source_db_cluster_identifier: Optional[str] = None,
storage_encrypted: Optional[bool] = None)
@overload
def GlobalCluster(resource_name: str,
args: GlobalClusterArgs,
opts: Optional[ResourceOptions] = None)
func NewGlobalCluster(ctx *Context, name string, args GlobalClusterArgs, opts ...ResourceOption) (*GlobalCluster, error)
public GlobalCluster(string name, GlobalClusterArgs args, CustomResourceOptions? opts = null)
public GlobalCluster(String name, GlobalClusterArgs args)
public GlobalCluster(String name, GlobalClusterArgs args, CustomResourceOptions options)
type: aws:neptune:GlobalCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GlobalClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GlobalClusterArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GlobalClusterArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GlobalClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GlobalClusterArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
GlobalCluster Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The GlobalCluster resource accepts the following input properties:
- Global
Cluster stringIdentifier The global cluster identifier.
- Deletion
Protection bool If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to
true
. The default isfalse
.- Engine string
Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Current Valid values:
neptune
. Conflicts withsource_db_cluster_identifier
.- Engine
Version string Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will.
- NOTE: Upgrading major versions is not supported.
- Source
Db stringCluster Identifier Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value.
- Storage
Encrypted bool Specifies whether the DB cluster is encrypted. The default is
false
unlesssource_db_cluster_identifier
is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.
- Global
Cluster stringIdentifier The global cluster identifier.
- Deletion
Protection bool If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to
true
. The default isfalse
.- Engine string
Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Current Valid values:
neptune
. Conflicts withsource_db_cluster_identifier
.- Engine
Version string Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will.
- NOTE: Upgrading major versions is not supported.
- Source
Db stringCluster Identifier Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value.
- Storage
Encrypted bool Specifies whether the DB cluster is encrypted. The default is
false
unlesssource_db_cluster_identifier
is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.
- global
Cluster StringIdentifier The global cluster identifier.
- deletion
Protection Boolean If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to
true
. The default isfalse
.- engine String
Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Current Valid values:
neptune
. Conflicts withsource_db_cluster_identifier
.- engine
Version String Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will.
- NOTE: Upgrading major versions is not supported.
- source
Db StringCluster Identifier Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value.
- storage
Encrypted Boolean Specifies whether the DB cluster is encrypted. The default is
false
unlesssource_db_cluster_identifier
is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.
- global
Cluster stringIdentifier The global cluster identifier.
- deletion
Protection boolean If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to
true
. The default isfalse
.- engine string
Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Current Valid values:
neptune
. Conflicts withsource_db_cluster_identifier
.- engine
Version string Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will.
- NOTE: Upgrading major versions is not supported.
- source
Db stringCluster Identifier Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value.
- storage
Encrypted boolean Specifies whether the DB cluster is encrypted. The default is
false
unlesssource_db_cluster_identifier
is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.
- global_
cluster_ stridentifier The global cluster identifier.
- deletion_
protection bool If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to
true
. The default isfalse
.- engine str
Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Current Valid values:
neptune
. Conflicts withsource_db_cluster_identifier
.- engine_
version str Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will.
- NOTE: Upgrading major versions is not supported.
- source_
db_ strcluster_ identifier Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value.
- storage_
encrypted bool Specifies whether the DB cluster is encrypted. The default is
false
unlesssource_db_cluster_identifier
is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.
- global
Cluster StringIdentifier The global cluster identifier.
- deletion
Protection Boolean If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to
true
. The default isfalse
.- engine String
Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Current Valid values:
neptune
. Conflicts withsource_db_cluster_identifier
.- engine
Version String Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will.
- NOTE: Upgrading major versions is not supported.
- source
Db StringCluster Identifier Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value.
- storage
Encrypted Boolean Specifies whether the DB cluster is encrypted. The default is
false
unlesssource_db_cluster_identifier
is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.
Outputs
All input properties are implicitly available as output properties. Additionally, the GlobalCluster resource produces the following output properties:
- Arn string
Global Cluster Amazon Resource Name (ARN)
- Global
Cluster List<GlobalMembers Cluster Global Cluster Member> Set of objects containing Global Cluster members.
- Global
Cluster stringResource Id AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
- Id string
The provider-assigned unique ID for this managed resource.
- Status string
- Arn string
Global Cluster Amazon Resource Name (ARN)
- Global
Cluster []GlobalMembers Cluster Global Cluster Member Set of objects containing Global Cluster members.
- Global
Cluster stringResource Id AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
- Id string
The provider-assigned unique ID for this managed resource.
- Status string
- arn String
Global Cluster Amazon Resource Name (ARN)
- global
Cluster List<GlobalMembers Cluster Global Cluster Member> Set of objects containing Global Cluster members.
- global
Cluster StringResource Id AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
- id String
The provider-assigned unique ID for this managed resource.
- status String
- arn string
Global Cluster Amazon Resource Name (ARN)
- global
Cluster GlobalMembers Cluster Global Cluster Member[] Set of objects containing Global Cluster members.
- global
Cluster stringResource Id AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
- id string
The provider-assigned unique ID for this managed resource.
- status string
- arn str
Global Cluster Amazon Resource Name (ARN)
- global_
cluster_ Sequence[Globalmembers Cluster Global Cluster Member] Set of objects containing Global Cluster members.
- global_
cluster_ strresource_ id AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
- id str
The provider-assigned unique ID for this managed resource.
- status str
- arn String
Global Cluster Amazon Resource Name (ARN)
- global
Cluster List<Property Map>Members Set of objects containing Global Cluster members.
- global
Cluster StringResource Id AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
- id String
The provider-assigned unique ID for this managed resource.
- status String
Look up Existing GlobalCluster Resource
Get an existing GlobalCluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: GlobalClusterState, opts?: CustomResourceOptions): GlobalCluster
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
deletion_protection: Optional[bool] = None,
engine: Optional[str] = None,
engine_version: Optional[str] = None,
global_cluster_identifier: Optional[str] = None,
global_cluster_members: Optional[Sequence[GlobalClusterGlobalClusterMemberArgs]] = None,
global_cluster_resource_id: Optional[str] = None,
source_db_cluster_identifier: Optional[str] = None,
status: Optional[str] = None,
storage_encrypted: Optional[bool] = None) -> GlobalCluster
func GetGlobalCluster(ctx *Context, name string, id IDInput, state *GlobalClusterState, opts ...ResourceOption) (*GlobalCluster, error)
public static GlobalCluster Get(string name, Input<string> id, GlobalClusterState? state, CustomResourceOptions? opts = null)
public static GlobalCluster get(String name, Output<String> id, GlobalClusterState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
Global Cluster Amazon Resource Name (ARN)
- Deletion
Protection bool If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to
true
. The default isfalse
.- Engine string
Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Current Valid values:
neptune
. Conflicts withsource_db_cluster_identifier
.- Engine
Version string Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will.
- NOTE: Upgrading major versions is not supported.
- Global
Cluster stringIdentifier The global cluster identifier.
- Global
Cluster List<GlobalMembers Cluster Global Cluster Member Args> Set of objects containing Global Cluster members.
- Global
Cluster stringResource Id AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
- Source
Db stringCluster Identifier Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value.
- Status string
- Storage
Encrypted bool Specifies whether the DB cluster is encrypted. The default is
false
unlesssource_db_cluster_identifier
is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.
- Arn string
Global Cluster Amazon Resource Name (ARN)
- Deletion
Protection bool If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to
true
. The default isfalse
.- Engine string
Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Current Valid values:
neptune
. Conflicts withsource_db_cluster_identifier
.- Engine
Version string Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will.
- NOTE: Upgrading major versions is not supported.
- Global
Cluster stringIdentifier The global cluster identifier.
- Global
Cluster []GlobalMembers Cluster Global Cluster Member Args Set of objects containing Global Cluster members.
- Global
Cluster stringResource Id AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
- Source
Db stringCluster Identifier Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value.
- Status string
- Storage
Encrypted bool Specifies whether the DB cluster is encrypted. The default is
false
unlesssource_db_cluster_identifier
is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.
- arn String
Global Cluster Amazon Resource Name (ARN)
- deletion
Protection Boolean If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to
true
. The default isfalse
.- engine String
Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Current Valid values:
neptune
. Conflicts withsource_db_cluster_identifier
.- engine
Version String Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will.
- NOTE: Upgrading major versions is not supported.
- global
Cluster StringIdentifier The global cluster identifier.
- global
Cluster List<GlobalMembers Cluster Global Cluster Member Args> Set of objects containing Global Cluster members.
- global
Cluster StringResource Id AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
- source
Db StringCluster Identifier Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value.
- status String
- storage
Encrypted Boolean Specifies whether the DB cluster is encrypted. The default is
false
unlesssource_db_cluster_identifier
is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.
- arn string
Global Cluster Amazon Resource Name (ARN)
- deletion
Protection boolean If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to
true
. The default isfalse
.- engine string
Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Current Valid values:
neptune
. Conflicts withsource_db_cluster_identifier
.- engine
Version string Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will.
- NOTE: Upgrading major versions is not supported.
- global
Cluster stringIdentifier The global cluster identifier.
- global
Cluster GlobalMembers Cluster Global Cluster Member Args[] Set of objects containing Global Cluster members.
- global
Cluster stringResource Id AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
- source
Db stringCluster Identifier Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value.
- status string
- storage
Encrypted boolean Specifies whether the DB cluster is encrypted. The default is
false
unlesssource_db_cluster_identifier
is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.
- arn str
Global Cluster Amazon Resource Name (ARN)
- deletion_
protection bool If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to
true
. The default isfalse
.- engine str
Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Current Valid values:
neptune
. Conflicts withsource_db_cluster_identifier
.- engine_
version str Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will.
- NOTE: Upgrading major versions is not supported.
- global_
cluster_ stridentifier The global cluster identifier.
- global_
cluster_ Sequence[Globalmembers Cluster Global Cluster Member Args] Set of objects containing Global Cluster members.
- global_
cluster_ strresource_ id AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
- source_
db_ strcluster_ identifier Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value.
- status str
- storage_
encrypted bool Specifies whether the DB cluster is encrypted. The default is
false
unlesssource_db_cluster_identifier
is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.
- arn String
Global Cluster Amazon Resource Name (ARN)
- deletion
Protection Boolean If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to
true
. The default isfalse
.- engine String
Name of the database engine to be used for this DB cluster. The provider will only perform drift detection if a configuration value is provided. Current Valid values:
neptune
. Conflicts withsource_db_cluster_identifier
.- engine
Version String Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will.
- NOTE: Upgrading major versions is not supported.
- global
Cluster StringIdentifier The global cluster identifier.
- global
Cluster List<Property Map>Members Set of objects containing Global Cluster members.
- global
Cluster StringResource Id AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
- source
Db StringCluster Identifier Amazon Resource Name (ARN) to use as the primary DB Cluster of the Global Cluster on creation. The provider cannot perform drift detection of this value.
- status String
- storage
Encrypted Boolean Specifies whether the DB cluster is encrypted. The default is
false
unlesssource_db_cluster_identifier
is specified and encrypted. The provider will only perform drift detection if a configuration value is provided.
Supporting Types
GlobalClusterGlobalClusterMember
- Db
Cluster stringArn Amazon Resource Name (ARN) of member DB Cluster.
- Is
Writer bool Whether the member is the primary DB Cluster.
- Db
Cluster stringArn Amazon Resource Name (ARN) of member DB Cluster.
- Is
Writer bool Whether the member is the primary DB Cluster.
- db
Cluster StringArn Amazon Resource Name (ARN) of member DB Cluster.
- is
Writer Boolean Whether the member is the primary DB Cluster.
- db
Cluster stringArn Amazon Resource Name (ARN) of member DB Cluster.
- is
Writer boolean Whether the member is the primary DB Cluster.
- db_
cluster_ strarn Amazon Resource Name (ARN) of member DB Cluster.
- is_
writer bool Whether the member is the primary DB Cluster.
- db
Cluster StringArn Amazon Resource Name (ARN) of member DB Cluster.
- is
Writer Boolean Whether the member is the primary DB Cluster.
Import
aws_neptune_global_cluster
can be imported by using the Global Cluster identifier, e.g.
$ pulumi import aws:neptune/globalCluster:GlobalCluster example example
Certain resource arguments, like source_db_cluster_identifier
, do not have an API method for reading the information after creation. If the argument is set in configuration on an imported resource, the provider will always show a difference. To workaround this behavior, either omit the argument from configuration or use ignore_changes
to hide the difference, e.g. terraform resource “aws_neptune_global_cluster” “example” {
… other configuration …
There is no API for reading source_db_cluster_identifier
lifecycle {
ignore_changes = [source_db_cluster_identifier]
} }
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.