Class CfnGraph
The AWS ::NeptuneGraph::Graph resource creates an graph.
Inherited Members
Namespace: Amazon.CDK.AwsNeptunegraph
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnGraph : CfnResource, IInspectable, ITaggableV2Syntax (vb)
Public Class CfnGraph
Inherits CfnResource
Implements IInspectable, ITaggableV2Remarks
is a memory-optimized graph database engine for analytics. For more information, see .
You can use AWS ::NeptuneGraph::Graph.DeletionProtection to help guard against unintended deletion of your graph.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html
CloudformationResource: AWS::NeptuneGraph::Graph
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Aws_neptunegraph;
var cfnGraph = new CfnGraph(this, "MyCfnGraph", new CfnGraphProps {
ProvisionedMemory = 123,
// the properties below are optional
DeletionProtection = false,
GraphName = "graphName",
PublicConnectivity = false,
ReplicaCount = 123,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VectorSearchConfiguration = new VectorSearchConfigurationProperty {
VectorSearchDimension = 123
}
});Synopsis
Constructors
| Cfn |
Used by jsii to construct an instance of this class from a Javascript-owned object reference |
| Cfn |
Used by jsii to construct an instance of this class from DeputyProps |
| Cfn |
Properties
| Attr |
The connection endpoint for the graph. |
| Attr |
The ARN of the graph. |
| Attr |
The ID of the graph. |
| Cdk |
Tag Manager which manages the tags for this resource. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| Cfn |
|
| Deletion |
A value that indicates whether the graph has deletion protection enabled. |
| Graph |
The graph name. |
| Provisioned |
The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. |
| Public |
Specifies whether or not the graph can be reachable over the internet. |
| Replica |
The number of replicas in other AZs. |
| Tags | Adds metadata tags to the new graph. |
| Vector |
Specifies the number of dimensions for vector embeddings that will be loaded into the graph. |
Methods
| Inspect(Tree |
Examines the CloudFormation resource and discloses attributes. |
| RenderProperties(IDictionary<String, Object>) |
Constructors
CfnGraph(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnGraph(ByRefValue reference)Parameters
- reference Amazon.
JSII. Runtime. Deputy. By Ref Value The Javascript-owned object reference
CfnGraph(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnGraph(DeputyBase.DeputyProps props)Parameters
- props Amazon.
JSII. Runtime. Deputy. Deputy Base. Deputy Props The deputy props
CfnGraph(Construct, String, ICfnGraphProps)
public CfnGraph(Construct scope, string id, ICfnGraphProps props)Parameters
- scope Constructs.
Construct Scope in which this resource is defined.
- id System.
String Construct identifier for this resource (unique in its scope).
- props ICfn
Graph Props Resource properties.
Properties
AttrEndpoint
The connection endpoint for the graph.
public virtual string AttrEndpoint { get; }Property Value
System.
Remarks
For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
CloudformationAttribute: Endpoint
AttrGraphArn
The ARN of the graph.
public virtual string AttrGraphArn { get; }Property Value
System.
Remarks
For example: arn:aws:neptune-graph:us-east-1:111122223333:graph/g-12a3bcdef4
CloudformationAttribute: GraphArn
AttrGraphId
The ID of the graph.
public virtual string AttrGraphId { get; }Property Value
System.
Remarks
For example: g-12a3bcdef4
CloudformationAttribute: GraphId
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }Property Value
System.
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }Property Value
System.
Overrides
DeletionProtection
A value that indicates whether the graph has deletion protection enabled.
public virtual object DeletionProtection { get; set; }Property Value
System.
GraphName
The graph name.
public virtual string GraphName { get; set; }Property Value
System.
Remarks
For example: my-graph-1 .
ProvisionedMemory
The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.
public virtual double ProvisionedMemory { get; set; }Property Value
System.
PublicConnectivity
Specifies whether or not the graph can be reachable over the internet.
public virtual object PublicConnectivity { get; set; }Property Value
System.
Remarks
All access to graphs is IAM authenticated.
ReplicaCount
The number of replicas in other AZs.
public virtual Nullable<double> ReplicaCount { get; set; }Property Value
System.
Tags
Adds metadata tags to the new graph.
public virtual ICfnTag[] Tags { get; set; }Property Value
ICfn
VectorSearchConfiguration
Specifies the number of dimensions for vector embeddings that will be loaded into the graph.
public virtual object VectorSearchConfiguration { get; set; }Property Value
System.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)Parameters
- inspector Tree
Inspector tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)Parameters
- props System.
Collections. <System.Generic. IDictionary String , System.Object >
Returns
System.