aws_sdk_neptunegraph/client/

create_graph.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateGraph`](crate::operation::create_graph::builders::CreateGraphFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`graph_name(impl Into<String>)`](crate::operation::create_graph::builders::CreateGraphFluentBuilder::graph_name) / [`set_graph_name(Option<String>)`](crate::operation::create_graph::builders::CreateGraphFluentBuilder::set_graph_name):<br>required: **true**<br><p>A name for the new Neptune Analytics graph to be created.</p> <p>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. Only lowercase letters are allowed.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_graph::builders::CreateGraphFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_graph::builders::CreateGraphFluentBuilder::set_tags):<br>required: **false**<br><p>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.</p><br>
    ///   - [`public_connectivity(bool)`](crate::operation::create_graph::builders::CreateGraphFluentBuilder::public_connectivity) / [`set_public_connectivity(Option<bool>)`](crate::operation::create_graph::builders::CreateGraphFluentBuilder::set_public_connectivity):<br>required: **false**<br><p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (<code>true</code> to enable, or <code>false</code> to disable.</p><br>
    ///   - [`kms_key_identifier(impl Into<String>)`](crate::operation::create_graph::builders::CreateGraphFluentBuilder::kms_key_identifier) / [`set_kms_key_identifier(Option<String>)`](crate::operation::create_graph::builders::CreateGraphFluentBuilder::set_kms_key_identifier):<br>required: **false**<br><p>Specifies a KMS key to use to encrypt data in the new graph.</p><br>
    ///   - [`vector_search_configuration(VectorSearchConfiguration)`](crate::operation::create_graph::builders::CreateGraphFluentBuilder::vector_search_configuration) / [`set_vector_search_configuration(Option<VectorSearchConfiguration>)`](crate::operation::create_graph::builders::CreateGraphFluentBuilder::set_vector_search_configuration):<br>required: **false**<br><p>Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified as <code>dimension=</code>value. Max = 65,535</p><br>
    ///   - [`replica_count(i32)`](crate::operation::create_graph::builders::CreateGraphFluentBuilder::replica_count) / [`set_replica_count(Option<i32>)`](crate::operation::create_graph::builders::CreateGraphFluentBuilder::set_replica_count):<br>required: **false**<br><p>The number of replicas in other AZs. Min =0, Max = 2, Default = 1.</p><important>  <p>Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.</p> </important><br>
    ///   - [`deletion_protection(bool)`](crate::operation::create_graph::builders::CreateGraphFluentBuilder::deletion_protection) / [`set_deletion_protection(Option<bool>)`](crate::operation::create_graph::builders::CreateGraphFluentBuilder::set_deletion_protection):<br>required: **false**<br><p>Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. (<code>true</code> or <code>false</code>).</p><br>
    ///   - [`provisioned_memory(i32)`](crate::operation::create_graph::builders::CreateGraphFluentBuilder::provisioned_memory) / [`set_provisioned_memory(Option<i32>)`](crate::operation::create_graph::builders::CreateGraphFluentBuilder::set_provisioned_memory):<br>required: **true**<br><p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 16</p><br>
    /// - On success, responds with [`CreateGraphOutput`](crate::operation::create_graph::CreateGraphOutput) with field(s):
    ///   - [`id(String)`](crate::operation::create_graph::CreateGraphOutput::id): <p>The ID of the graph.</p>
    ///   - [`name(String)`](crate::operation::create_graph::CreateGraphOutput::name): <p>The graph name. For example: <code>my-graph-1</code>.</p> <p>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. Only lowercase letters are allowed.</p>
    ///   - [`arn(String)`](crate::operation::create_graph::CreateGraphOutput::arn): <p>The ARN of the graph.</p>
    ///   - [`status(Option<GraphStatus>)`](crate::operation::create_graph::CreateGraphOutput::status): <p>The current status of the graph.</p>
    ///   - [`status_reason(Option<String>)`](crate::operation::create_graph::CreateGraphOutput::status_reason): <p>The reason the status was given.</p>
    ///   - [`create_time(Option<DateTime>)`](crate::operation::create_graph::CreateGraphOutput::create_time): <p>The time when the graph was created.</p>
    ///   - [`provisioned_memory(Option<i32>)`](crate::operation::create_graph::CreateGraphOutput::provisioned_memory): <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.</p> <p>Min = 16</p>
    ///   - [`endpoint(Option<String>)`](crate::operation::create_graph::CreateGraphOutput::endpoint): <p>The graph endpoint.</p>
    ///   - [`public_connectivity(Option<bool>)`](crate::operation::create_graph::CreateGraphOutput::public_connectivity): <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.</p><note>  <p>If enabling public connectivity for the first time, there will be a delay while it is enabled.</p> </note>
    ///   - [`vector_search_configuration(Option<VectorSearchConfiguration>)`](crate::operation::create_graph::CreateGraphOutput::vector_search_configuration): <p>The vector-search configuration for the graph, which specifies the vector dimension to use in the vector index, if any.</p>
    ///   - [`replica_count(Option<i32>)`](crate::operation::create_graph::CreateGraphOutput::replica_count): <p>The number of replicas in other AZs.</p> <p>Default: If not specified, the default value is 1.</p>
    ///   - [`kms_key_identifier(Option<String>)`](crate::operation::create_graph::CreateGraphOutput::kms_key_identifier): <p>Specifies the KMS key used to encrypt data in the new graph.</p>
    ///   - [`source_snapshot_id(Option<String>)`](crate::operation::create_graph::CreateGraphOutput::source_snapshot_id): <p>The ID of the source graph.</p>
    ///   - [`deletion_protection(Option<bool>)`](crate::operation::create_graph::CreateGraphOutput::deletion_protection): <p>A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.</p>
    ///   - [`build_number(Option<String>)`](crate::operation::create_graph::CreateGraphOutput::build_number): <p>The build number of the graph software.</p>
    /// - On failure, responds with [`SdkError<CreateGraphError>`](crate::operation::create_graph::CreateGraphError)
    pub fn create_graph(&self) -> crate::operation::create_graph::builders::CreateGraphFluentBuilder {
        crate::operation::create_graph::builders::CreateGraphFluentBuilder::new(self.handle.clone())
    }
}