AWS Classic

v5.21.1 published on Thursday, Nov 17, 2022 by Pulumi

ClusterEndpoint

Provides an Neptune Cluster Endpoint Resource.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Neptune.ClusterEndpoint("example", new()
    {
        ClusterIdentifier = aws_neptune_cluster.Test.Cluster_identifier,
        ClusterEndpointIdentifier = "example",
        EndpointType = "READER",
    });

});
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 {
		_, err := neptune.NewClusterEndpoint(ctx, "example", &neptune.ClusterEndpointArgs{
			ClusterIdentifier:         pulumi.Any(aws_neptune_cluster.Test.Cluster_identifier),
			ClusterEndpointIdentifier: pulumi.String("example"),
			EndpointType:              pulumi.String("READER"),
		})
		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.ClusterEndpoint;
import com.pulumi.aws.neptune.ClusterEndpointArgs;
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 example = new ClusterEndpoint("example", ClusterEndpointArgs.builder()        
            .clusterIdentifier(aws_neptune_cluster.test().cluster_identifier())
            .clusterEndpointIdentifier("example")
            .endpointType("READER")
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.neptune.ClusterEndpoint("example",
    cluster_identifier=aws_neptune_cluster["test"]["cluster_identifier"],
    cluster_endpoint_identifier="example",
    endpoint_type="READER")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.neptune.ClusterEndpoint("example", {
    clusterIdentifier: aws_neptune_cluster.test.cluster_identifier,
    clusterEndpointIdentifier: "example",
    endpointType: "READER",
});
resources:
  example:
    type: aws:neptune:ClusterEndpoint
    properties:
      clusterIdentifier: ${aws_neptune_cluster.test.cluster_identifier}
      clusterEndpointIdentifier: example
      endpointType: READER

Create ClusterEndpoint Resource

new ClusterEndpoint(name: string, args: ClusterEndpointArgs, opts?: CustomResourceOptions);
@overload
def ClusterEndpoint(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    cluster_endpoint_identifier: Optional[str] = None,
                    cluster_identifier: Optional[str] = None,
                    endpoint_type: Optional[str] = None,
                    excluded_members: Optional[Sequence[str]] = None,
                    static_members: Optional[Sequence[str]] = None,
                    tags: Optional[Mapping[str, str]] = None)
@overload
def ClusterEndpoint(resource_name: str,
                    args: ClusterEndpointArgs,
                    opts: Optional[ResourceOptions] = None)
func NewClusterEndpoint(ctx *Context, name string, args ClusterEndpointArgs, opts ...ResourceOption) (*ClusterEndpoint, error)
public ClusterEndpoint(string name, ClusterEndpointArgs args, CustomResourceOptions? opts = null)
public ClusterEndpoint(String name, ClusterEndpointArgs args)
public ClusterEndpoint(String name, ClusterEndpointArgs args, CustomResourceOptions options)
type: aws:neptune:ClusterEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ClusterEndpointArgs
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 ClusterEndpointArgs
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 ClusterEndpointArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClusterEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ClusterEndpointArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ClusterEndpoint 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 ClusterEndpoint resource accepts the following input properties:

ClusterEndpointIdentifier string

The identifier of the endpoint.

ClusterIdentifier string

The DB cluster identifier of the DB cluster associated with the endpoint.

EndpointType string

The type of the endpoint. One of: READER, WRITER, ANY.

ExcludedMembers 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.

StaticMembers List<string>

List of DB instance identifiers that are part of the custom endpoint group.

Tags Dictionary<string, string>

A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

ClusterEndpointIdentifier string

The identifier of the endpoint.

ClusterIdentifier string

The DB cluster identifier of the DB cluster associated with the endpoint.

EndpointType string

The type of the endpoint. One of: READER, WRITER, ANY.

ExcludedMembers []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.

StaticMembers []string

List of DB instance identifiers that are part of the custom endpoint group.

Tags map[string]string

A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

clusterEndpointIdentifier String

The identifier of the endpoint.

clusterIdentifier String

The DB cluster identifier of the DB cluster associated with the endpoint.

endpointType String

The type of the endpoint. One of: READER, WRITER, ANY.

excludedMembers 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.

staticMembers List<String>

List of DB instance identifiers that are part of the custom endpoint group.

tags Map<String,String>

A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

clusterEndpointIdentifier string

The identifier of the endpoint.

clusterIdentifier string

The DB cluster identifier of the DB cluster associated with the endpoint.

endpointType string

The type of the endpoint. One of: READER, WRITER, ANY.

excludedMembers 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.

staticMembers string[]

List of DB instance identifiers that are part of the custom endpoint group.

tags {[key: string]: string}

A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

cluster_endpoint_identifier str

The identifier of the endpoint.

cluster_identifier str

The DB cluster identifier of the DB cluster associated with the endpoint.

endpoint_type str

The type of the endpoint. One of: READER, WRITER, ANY.

excluded_members Sequence[str]

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.

static_members Sequence[str]

List of DB instance identifiers that are part of the custom endpoint group.

tags Mapping[str, str]

A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

clusterEndpointIdentifier String

The identifier of the endpoint.

clusterIdentifier String

The DB cluster identifier of the DB cluster associated with the endpoint.

endpointType String

The type of the endpoint. One of: READER, WRITER, ANY.

excludedMembers 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.

staticMembers List<String>

List of DB instance identifiers that are part of the custom endpoint group.

tags Map<String>

A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

All input properties are implicitly available as output properties. Additionally, the ClusterEndpoint resource produces the following output properties:

Arn string

The Neptune Cluster Endpoint Amazon Resource Name (ARN).

Endpoint string

The DNS address of the endpoint.

Id string

The provider-assigned unique ID for this managed resource.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string

The Neptune Cluster Endpoint Amazon Resource Name (ARN).

Endpoint string

The DNS address of the endpoint.

Id string

The provider-assigned unique ID for this managed resource.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

The Neptune Cluster Endpoint Amazon Resource Name (ARN).

endpoint String

The DNS address of the endpoint.

id String

The provider-assigned unique ID for this managed resource.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string

The Neptune Cluster Endpoint Amazon Resource Name (ARN).

endpoint string

The DNS address of the endpoint.

id string

The provider-assigned unique ID for this managed resource.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str

The Neptune Cluster Endpoint Amazon Resource Name (ARN).

endpoint str

The DNS address of the endpoint.

id str

The provider-assigned unique ID for this managed resource.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

The Neptune Cluster Endpoint Amazon Resource Name (ARN).

endpoint String

The DNS address of the endpoint.

id String

The provider-assigned unique ID for this managed resource.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up Existing ClusterEndpoint Resource

Get an existing ClusterEndpoint 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?: ClusterEndpointState, opts?: CustomResourceOptions): ClusterEndpoint
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        cluster_endpoint_identifier: Optional[str] = None,
        cluster_identifier: Optional[str] = None,
        endpoint: Optional[str] = None,
        endpoint_type: Optional[str] = None,
        excluded_members: Optional[Sequence[str]] = None,
        static_members: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> ClusterEndpoint
func GetClusterEndpoint(ctx *Context, name string, id IDInput, state *ClusterEndpointState, opts ...ResourceOption) (*ClusterEndpoint, error)
public static ClusterEndpoint Get(string name, Input<string> id, ClusterEndpointState? state, CustomResourceOptions? opts = null)
public static ClusterEndpoint get(String name, Output<String> id, ClusterEndpointState 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.
The following state arguments are supported:
Arn string

The Neptune Cluster Endpoint Amazon Resource Name (ARN).

ClusterEndpointIdentifier string

The identifier of the endpoint.

ClusterIdentifier string

The DB cluster identifier of the DB cluster associated with the endpoint.

Endpoint string

The DNS address of the endpoint.

EndpointType string

The type of the endpoint. One of: READER, WRITER, ANY.

ExcludedMembers 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.

StaticMembers List<string>

List of DB instance identifiers that are part of the custom endpoint group.

Tags Dictionary<string, string>

A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string

The Neptune Cluster Endpoint Amazon Resource Name (ARN).

ClusterEndpointIdentifier string

The identifier of the endpoint.

ClusterIdentifier string

The DB cluster identifier of the DB cluster associated with the endpoint.

Endpoint string

The DNS address of the endpoint.

EndpointType string

The type of the endpoint. One of: READER, WRITER, ANY.

ExcludedMembers []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.

StaticMembers []string

List of DB instance identifiers that are part of the custom endpoint group.

Tags map[string]string

A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

The Neptune Cluster Endpoint Amazon Resource Name (ARN).

clusterEndpointIdentifier String

The identifier of the endpoint.

clusterIdentifier String

The DB cluster identifier of the DB cluster associated with the endpoint.

endpoint String

The DNS address of the endpoint.

endpointType String

The type of the endpoint. One of: READER, WRITER, ANY.

excludedMembers 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.

staticMembers List<String>

List of DB instance identifiers that are part of the custom endpoint group.

tags Map<String,String>

A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string

The Neptune Cluster Endpoint Amazon Resource Name (ARN).

clusterEndpointIdentifier string

The identifier of the endpoint.

clusterIdentifier string

The DB cluster identifier of the DB cluster associated with the endpoint.

endpoint string

The DNS address of the endpoint.

endpointType string

The type of the endpoint. One of: READER, WRITER, ANY.

excludedMembers 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.

staticMembers string[]

List of DB instance identifiers that are part of the custom endpoint group.

tags {[key: string]: string}

A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str

The Neptune Cluster Endpoint Amazon Resource Name (ARN).

cluster_endpoint_identifier str

The identifier of the endpoint.

cluster_identifier str

The DB cluster identifier of the DB cluster associated with the endpoint.

endpoint str

The DNS address of the endpoint.

endpoint_type str

The type of the endpoint. One of: READER, WRITER, ANY.

excluded_members Sequence[str]

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.

static_members Sequence[str]

List of DB instance identifiers that are part of the custom endpoint group.

tags Mapping[str, str]

A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

The Neptune Cluster Endpoint Amazon Resource Name (ARN).

clusterEndpointIdentifier String

The identifier of the endpoint.

clusterIdentifier String

The DB cluster identifier of the DB cluster associated with the endpoint.

endpoint String

The DNS address of the endpoint.

endpointType String

The type of the endpoint. One of: READER, WRITER, ANY.

excludedMembers 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.

staticMembers List<String>

List of DB instance identifiers that are part of the custom endpoint group.

tags Map<String>

A map of tags to assign to the Neptune cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Import

aws_neptune_cluster_endpoint can be imported by using the cluster-identifier:endpoint-identfier, e.g.,

 $ pulumi import aws:neptune/clusterEndpoint:ClusterEndpoint example my-cluster:my-endpoint

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.