Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. neptunegraph
  5. getGraph

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.neptunegraph.getGraph

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::NeptuneGraph::Graph resource creates an Amazon NeptuneGraph Graph.

    Using getGraph

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGraph(args: GetGraphArgs, opts?: InvokeOptions): Promise<GetGraphResult>
function getGraphOutput(args: GetGraphOutputArgs, opts?: InvokeOptions): Output<GetGraphResult>
    def get_graph(graph_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGraphResult
def get_graph_output(graph_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetGraphResult]
    func LookupGraph(ctx *Context, args *LookupGraphArgs, opts ...InvokeOption) (*LookupGraphResult, error)
func LookupGraphOutput(ctx *Context, args *LookupGraphOutputArgs, opts ...InvokeOption) LookupGraphResultOutput

    > Note: This function is named LookupGraph in the Go SDK.

    public static class GetGraph 
{
    public static Task<GetGraphResult> InvokeAsync(GetGraphArgs args, InvokeOptions? opts = null)
    public static Output<GetGraphResult> Invoke(GetGraphInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGraphResult> getGraph(GetGraphArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:neptunegraph:getGraph
  arguments:
    # arguments dictionary

    The following arguments are supported:

    GraphId string
    The auto-generated id assigned by the service.
    GraphId string
    The auto-generated id assigned by the service.
    graphId String
    The auto-generated id assigned by the service.
    graphId string
    The auto-generated id assigned by the service.
    graph_id str
    The auto-generated id assigned by the service.
    graphId String
    The auto-generated id assigned by the service.

    getGraph Result

    The following output properties are available:

    DeletionProtection bool

    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.

    Endpoint string
    The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
    GraphArn string
    Graph resource ARN
    GraphId string
    The auto-generated id assigned by the service.
    ProvisionedMemory int
    Memory for the Graph.
    PublicConnectivity bool

    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.

    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags associated with this graph.
    DeletionProtection bool

    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.

    Endpoint string
    The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
    GraphArn string
    Graph resource ARN
    GraphId string
    The auto-generated id assigned by the service.
    ProvisionedMemory int
    Memory for the Graph.
    PublicConnectivity bool

    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.

    Tags Tag
    The tags associated with this graph.
    deletionProtection Boolean

    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.

    endpoint String
    The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
    graphArn String
    Graph resource ARN
    graphId String
    The auto-generated id assigned by the service.
    provisionedMemory Integer
    Memory for the Graph.
    publicConnectivity Boolean

    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.

    tags List<Tag>
    The tags associated with this graph.
    deletionProtection boolean

    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.

    endpoint string
    The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
    graphArn string
    Graph resource ARN
    graphId string
    The auto-generated id assigned by the service.
    provisionedMemory number
    Memory for the Graph.
    publicConnectivity boolean

    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.

    tags Tag[]
    The tags associated with this graph.
    deletion_protection bool

    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.

    endpoint str
    The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
    graph_arn str
    Graph resource ARN
    graph_id str
    The auto-generated id assigned by the service.
    provisioned_memory int
    Memory for the Graph.
    public_connectivity bool

    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.

    tags Sequence[root_Tag]
    The tags associated with this graph.
    deletionProtection Boolean

    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.

    endpoint String
    The connection endpoint for the graph. For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com
    graphArn String
    Graph resource ARN
    graphId String
    The auto-generated id assigned by the service.
    provisionedMemory Number
    Memory for the Graph.
    publicConnectivity Boolean

    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.

    tags List<Property Map>
    The tags associated with this graph.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native