ClusterEndpoint class
Provides an Neptune Cluster Endpoint Resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.neptune.ClusterEndpoint("example", {
clusterIdentifier: test.clusterIdentifier,
clusterEndpointIdentifier: "example",
endpointType: "READER",
});
import pulumi
import pulumi_aws as aws
example = aws.neptune.ClusterEndpoint("example",
cluster_identifier=test["clusterIdentifier"],
cluster_endpoint_identifier="example",
endpoint_type="READER")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Neptune.ClusterEndpoint("example", new()
{
ClusterIdentifier = test.ClusterIdentifier,
ClusterEndpointIdentifier = "example",
EndpointType = "READER",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/neptune"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := neptune.NewClusterEndpoint(ctx, "example", &neptune.ClusterEndpointArgs{
ClusterIdentifier: pulumi.Any(test.ClusterIdentifier),
ClusterEndpointIdentifier: pulumi.String("example"),
EndpointType: pulumi.String("READER"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_neptune_clusterendpoint" "example" {
cluster_identifier = test.clusterIdentifier
cluster_endpoint_identifier = "example"
endpoint_type = "READER"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.neptune.ClusterEndpoint;
import com.pulumi.aws.neptune.ClusterEndpointArgs;
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 ClusterEndpoint("example", ClusterEndpointArgs.builder()
.clusterIdentifier(test.clusterIdentifier())
.clusterEndpointIdentifier("example")
.endpointType("READER")
.build());
}
}
resources:
example:
type: aws:neptune:ClusterEndpoint
properties:
clusterIdentifier: ${test.clusterIdentifier}
clusterEndpointIdentifier: example
endpointType: READER
Import
Using pulumi import, import aws.neptune.ClusterEndpoint using the cluster-identifier:endpoint-identfier. For example:
$ pulumi import aws:neptune/clusterEndpoint:ClusterEndpoint example my-cluster:my-endpoint
Constructors
- ClusterEndpoint(String name, {ClusterEndpointArgs? args, CustomResourceOptions? options})
-
Creates a new ClusterEndpoint.
nameThe Pulumi resource name.argsArguments used to configure this ClusterEndpoint. The set of arguments for ClusterEndpoint.optionsResource options controlling this resource's behavior. - ClusterEndpoint.reference(String urn)
- Creates a typed reference to an existing ClusterEndpoint resource.
Properties
-
arn
↔ Output<
String> -
Neptune Cluster Endpoint ARN.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
clusterEndpointIdentifier
↔ Output<
String> -
The identifier of the endpoint.
latefinal
-
clusterIdentifier
↔ Output<
String> -
The DB cluster identifier of the DB cluster associated with the endpoint.
latefinal
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
endpoint
↔ Output<
String> -
The DNS address of the endpoint.
latefinal
-
endpointType
↔ Output<
String> -
The type of the endpoint. One of:
READER,WRITER,ANY.latefinal -
excludedMembers
↔ Output<
List< String> ?> -
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
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
-
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
-
staticMembers
↔ Output<
List< String> ?> -
List of DB instance identifiers that are part of the custom endpoint group.
latefinal
-
A map of tags to assign to the Neptune cluster. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A 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, {ClusterEndpointState? state, CustomResourceOptions? options}) → ClusterEndpoint -
Gets an existing ClusterEndpoint resource's state with the given
nameandid.