Package software.amazon.awscdk.services.neptunegraph

Class CfnGraph.Builder

java.lang.Object

software.amazon.awscdk.services.neptunegraph.CfnGraph.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGraph>

Enclosing class:

CfnGraph

@Stability(Stable)
public static final class CfnGraph.Builder
extends Object
implements software.amazon.jsii.Builder<CfnGraph>

A fluent builder for CfnGraph.

Method Summary

Modifier and Type	Method	Description
CfnGraph	build()
static CfnGraph.Builder	create(software.constructs.Construct scope, String id)
CfnGraph.Builder	deletionProtection(Boolean deletionProtection)	Value that indicates whether the Graph has deletion protection enabled.
CfnGraph.Builder	deletionProtection(IResolvable deletionProtection)	Value that indicates whether the Graph has deletion protection enabled.
CfnGraph.Builder	graphName(String graphName)	Contains a user-supplied name for the Graph.
CfnGraph.Builder	provisionedMemory(Number provisionedMemory)	Memory for the Graph.
CfnGraph.Builder	publicConnectivity(Boolean publicConnectivity)	Specifies whether the Graph can be reached over the internet.
CfnGraph.Builder	publicConnectivity(IResolvable publicConnectivity)	Specifies whether the Graph can be reached over the internet.
CfnGraph.Builder	replicaCount(Number replicaCount)	Specifies the number of replicas you want when finished.
CfnGraph.Builder	tags(List<? extends CfnTag> tags)	The tags associated with this graph.
CfnGraph.Builder	vectorSearchConfiguration(IResolvable vectorSearchConfiguration)	The vector search configuration.
CfnGraph.Builder	vectorSearchConfiguration(CfnGraph.VectorSearchConfigurationProperty vectorSearchConfiguration)	The vector search configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnGraph.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnGraph.Builder.

provisionedMemory

@Stability(Stable)
public CfnGraph.Builder provisionedMemory(Number provisionedMemory)

Memory for the Graph.

Parameters:

provisionedMemory - Memory for the Graph. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-provisionedmemory

deletionProtection

@Stability(Stable)
public CfnGraph.Builder deletionProtection(Boolean deletionProtection)

Value that indicates whether the Graph has deletion protection enabled.

The graph can't be deleted when deletion protection is enabled.

Default: If not specified, the default value is true.

Parameters:

deletionProtection - Value that indicates whether the Graph has deletion protection enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-deletionprotection

deletionProtection

@Stability(Stable)
public CfnGraph.Builder deletionProtection(IResolvable deletionProtection)

Value that indicates whether the Graph has deletion protection enabled.

The graph can't be deleted when deletion protection is enabled.

Default: If not specified, the default value is true.

Parameters:

deletionProtection - Value that indicates whether the Graph has deletion protection enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-deletionprotection

graphName

@Stability(Stable)
public CfnGraph.Builder graphName(String graphName)

Contains a user-supplied name for the Graph.

If you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters.

Important: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Parameters:

graphName - Contains a user-supplied name for the Graph. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-graphname

publicConnectivity

@Stability(Stable)
public CfnGraph.Builder publicConnectivity(Boolean publicConnectivity)

Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication.

When the Graph is publicly reachable, its Domain Name System (DNS) endpoint resolves to the public IP address from the internet.

When the Graph isn't publicly reachable, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC.

Default: If not specified, the default value is false.

Parameters:

publicConnectivity - Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-publicconnectivity

publicConnectivity

@Stability(Stable)
public CfnGraph.Builder publicConnectivity(IResolvable publicConnectivity)

Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication.

When the Graph is publicly reachable, its Domain Name System (DNS) endpoint resolves to the public IP address from the internet.

When the Graph isn't publicly reachable, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC.

Default: If not specified, the default value is false.

Parameters:

publicConnectivity - Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-publicconnectivity

replicaCount

@Stability(Stable)
public CfnGraph.Builder replicaCount(Number replicaCount)

Specifies the number of replicas you want when finished. All replicas will be provisioned in different availability zones.

Replica Count should always be less than or equal to 2.

Default: If not specified, the default value is 1.

Parameters:

replicaCount - Specifies the number of replicas you want when finished. All replicas will be provisioned in different availability zones. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-replicacount

tags

@Stability(Stable)
public CfnGraph.Builder tags(List<? extends CfnTag> tags)

The tags associated with this graph.

Parameters:

tags - The tags associated with this graph. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-tags

vectorSearchConfiguration

@Stability(Stable)
public CfnGraph.Builder vectorSearchConfiguration(IResolvable vectorSearchConfiguration)

The vector search configuration.

Parameters:

vectorSearchConfiguration - The vector search configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-vectorsearchconfiguration

vectorSearchConfiguration

@Stability(Stable)
public CfnGraph.Builder vectorSearchConfiguration(CfnGraph.VectorSearchConfigurationProperty vectorSearchConfiguration)

The vector search configuration.

Parameters:

vectorSearchConfiguration - The vector search configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html#cfn-neptunegraph-graph-vectorsearchconfiguration

build

@Stability(Stable)
public CfnGraph build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnGraph>

Returns:

a newly built instance of CfnGraph.