CfnGraphProps
- class aws_cdk.aws_neptunegraph.CfnGraphProps(*, provisioned_memory, deletion_protection=None, graph_name=None, public_connectivity=None, replica_count=None, tags=None, vector_search_configuration=None)
Bases:
object
Properties for defining a
CfnGraph
.- Parameters:
provisioned_memory (
Union
[int
,float
]) – The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128deletion_protection (
Union
[bool
,IResolvable
,None
]) – A value that indicates whether the graph has deletion protection enabled. The graph can’t be deleted when deletion protection is enabled.graph_name (
Optional
[str
]) – The graph name. For example:my-graph-1
. The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. If you don’t specify a graph name, a unique graph name is generated for you using the prefixgraph-for
, followed by a combination ofStack Name
and aUUID
.public_connectivity (
Union
[bool
,IResolvable
,None
]) – Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. When the graph is publicly available, its domain name system (DNS) endpoint resolves to the public IP address from the internet. When the graph isn’t publicly available, you need to create aPrivateGraphEndpoint
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. .. epigraph:: If enabling public connectivity for the first time, there will be a delay while it is enabled.replica_count (
Union
[int
,float
,None
]) – The number of replicas in other AZs. Default: If not specified, the default value is 1.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.vector_search_configuration (
Union
[IResolvable
,VectorSearchConfigurationProperty
,Dict
[str
,Any
],None
]) – Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified asdimension=
value. Max = 65,535
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_neptunegraph as neptunegraph cfn_graph_props = neptunegraph.CfnGraphProps( provisioned_memory=123, # the properties below are optional deletion_protection=False, graph_name="graphName", public_connectivity=False, replica_count=123, tags=[CfnTag( key="key", value="value" )], vector_search_configuration=neptunegraph.CfnGraph.VectorSearchConfigurationProperty( vector_search_dimension=123 ) )
Attributes
- deletion_protection
A value that indicates whether the graph has deletion protection enabled.
The graph can’t be deleted when deletion protection is enabled.
- graph_name
my-graph-1
.The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.
If you don’t specify a graph name, a unique graph name is generated for you using the prefix
graph-for
, followed by a combination ofStack Name
and aUUID
.- See:
- Type:
The graph name. For example
- provisioned_memory
The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.
Min = 128
- public_connectivity
Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.
When the graph is publicly available, its domain name system (DNS) endpoint resolves to the public IP address from the internet. When the graph isn’t publicly available, 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. .. epigraph:
If enabling public connectivity for the first time, there will be a delay while it is enabled.
- replica_count
The number of replicas in other AZs.
Default: If not specified, the default value is 1.
- tags
Adds metadata tags to the new graph.
These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.
- vector_search_configuration
Specifies the number of dimensions for vector embeddings that will be loaded into the graph.
The value is specified as
dimension=
value. Max = 65,535