Package com.pulumi.aws.neptune

Class Cluster

  • public class Cluster
extends com.pulumi.resources.CustomResource
    Provides an Neptune Cluster Resource. A Cluster Resource defines attributes that are applied to the entire cluster of Neptune Cluster Instances. Changes to a Neptune Cluster can occur when you manually change a parameter, such as `backupRetentionPeriod`, and are reflected in the next maintenance window. Because of this, this provider may report a difference in its planning phase because a modification has not yet taken place. You can use the `applyImmediately` flag to instruct the service to apply the change immediately (see documentation below). ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.neptune.Cluster;
 import com.pulumi.aws.neptune.ClusterArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var default_ = new Cluster("default", ClusterArgs.builder()
             .clusterIdentifier("neptune-cluster-demo")
             .engine("neptune")
             .backupRetentionPeriod(5)
             .preferredBackupWindow("07:00-09:00")
             .skipFinalSnapshot(true)
             .iamDatabaseAuthenticationEnabled(true)
             .applyImmediately(true)
             .build());
 
     }
 }
    > **Note:** AWS Neptune does not support user name/password–based access control. See the AWS [Docs](https://docs.aws.amazon.com/neptune/latest/userguide/limits.html) for more information. ## Import Using `pulumi import`, import `aws.neptune.Cluster` using the cluster identifier. For example: ```sh $ pulumi import aws:neptune/cluster:Cluster example my-cluster ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Cluster​(java.lang.String name)  
      Cluster​(java.lang.String name, ClusterArgs args)  
      Cluster​(java.lang.String name, ClusterArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Constructor Detail

      • Cluster

        public Cluster​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Cluster

        public Cluster​(java.lang.String name,
               @Nullable
               ClusterArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Cluster

        public Cluster​(java.lang.String name,
               @Nullable
               ClusterArgs args,
               @Nullable
               com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • allowMajorVersionUpgrade

        public com.pulumi.core.Output<java.lang.Boolean> allowMajorVersionUpgrade()
        Returns:
        Whether upgrades between different major versions are allowed. You must set it to `true` when providing an `engineVersion` parameter that uses a different major version than the DB cluster's current version. Default is `false`.

      • applyImmediately

        public com.pulumi.core.Output<java.lang.Boolean> applyImmediately()
        Returns:
        Whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        Neptune Cluster ARN

      • availabilityZones

        public com.pulumi.core.Output<java.util.List<java.lang.String>> availabilityZones()
        Returns:
        List of EC2 Availability Zones that instances in the Neptune cluster can be created in.

      • backupRetentionPeriod

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> backupRetentionPeriod()
        Returns:
        Days to retain backups for. Default `1`

      • clusterIdentifier

        public com.pulumi.core.Output<java.lang.String> clusterIdentifier()
        Returns:
        Cluster identifier. If omitted, Terraform will assign a random, unique identifier.

      • clusterIdentifierPrefix

        public com.pulumi.core.Output<java.lang.String> clusterIdentifierPrefix()
        Returns:
        Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `clusterIdentifier`.

      • clusterMembers

        public com.pulumi.core.Output<java.util.List<java.lang.String>> clusterMembers()
        Returns:
        List of Neptune Instances that are a part of this cluster

      • clusterResourceId

        public com.pulumi.core.Output<java.lang.String> clusterResourceId()
        Returns:
        Neptune Cluster Resource ID

      • copyTagsToSnapshot

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> copyTagsToSnapshot()
        Returns:
        If set to true, tags are copied to any snapshot of the DB cluster that is created.

      • deletionProtection

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> deletionProtection()
        Returns:
        Value that indicates whether the DB cluster has deletion protection enabled.The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

      • enableCloudwatchLogsExports

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> enableCloudwatchLogsExports()
        Returns:
        List of the log types this DB cluster is configured to export to CloudWatch Logs. Currently only supports `audit` and `slowquery`.

      • endpoint

        public com.pulumi.core.Output<java.lang.String> endpoint()
        Returns:
        DNS address of the Neptune instance

      • engine

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> engine()
        Returns:
        Name of the database engine to be used for this Neptune cluster. Defaults to `neptune`.

      • engineVersion

        public com.pulumi.core.Output<java.lang.String> engineVersion()
        Returns:
        Database engine version.

      • finalSnapshotIdentifier

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> finalSnapshotIdentifier()
        Returns:
        Name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.

      • globalClusterIdentifier

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> globalClusterIdentifier()
        Returns:
        Global cluster identifier specified on `aws.neptune.GlobalCluster`.

      • hostedZoneId

        public com.pulumi.core.Output<java.lang.String> hostedZoneId()
        Returns:
        Route53 Hosted Zone ID of the endpoint

      • iamDatabaseAuthenticationEnabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> iamDatabaseAuthenticationEnabled()
        Returns:
        Whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

      • iamRoles

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> iamRoles()
        Returns:
        List of ARNs for the IAM roles to associate to the Neptune Cluster.

      • kmsKeyArn

        public com.pulumi.core.Output<java.lang.String> kmsKeyArn()
        Returns:
        ARN for the KMS encryption key. When specifying `kmsKeyArn`, `storageEncrypted` needs to be set to true.

      • neptuneClusterParameterGroupName

        public com.pulumi.core.Output<java.lang.String> neptuneClusterParameterGroupName()
        Returns:
        Cluster parameter group to associate with the cluster.

      • neptuneInstanceParameterGroupName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> neptuneInstanceParameterGroupName()
        Returns:
        Name of DB parameter group to apply to all instances in the cluster. When upgrading, AWS does not return this value, so do not reference it in other arguments—either leave it unset, configure each instance directly, or ensure it matches the `engineVersion`.

      • neptuneSubnetGroupName

        public com.pulumi.core.Output<java.lang.String> neptuneSubnetGroupName()
        Returns:
        Neptune subnet group to associate with this Neptune instance.

      • networkType

        public com.pulumi.core.Output<java.lang.String> networkType()
        Returns:
        Network type of the Neptune cluster. Valid values: `IPV4`, `DUAL`. Default: `IPV4`. Specifying `DUAL` enables dual-stack IPv4/IPv6 connectivity. The Neptune DB subnet group associated with the cluster must be backed by IPv6-capable subnets. See the [Neptune dual-stack documentation](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dualstack-db-cluster.html) for prerequisites.

      • port

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> port()
        Returns:
        Port on which the Neptune accepts connections. Default is `8182`.

      • preferredBackupWindow

        public com.pulumi.core.Output<java.lang.String> preferredBackupWindow()
        Returns:
        Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00

      • preferredMaintenanceWindow

        public com.pulumi.core.Output<java.lang.String> preferredMaintenanceWindow()
        Returns:
        Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30

      • readerEndpoint

        public com.pulumi.core.Output<java.lang.String> readerEndpoint()
        Returns:
        Read-only endpoint for the Neptune cluster, automatically load-balanced across replicas

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • replicationSourceIdentifier

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> replicationSourceIdentifier()
        Returns:
        ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.

      • serverlessV2ScalingConfiguration

        public com.pulumi.core.Output<java.util.Optional<ClusterServerlessV2ScalingConfiguration>> serverlessV2ScalingConfiguration()
        Returns:
        If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.

      • skipFinalSnapshot

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> skipFinalSnapshot()
        Returns:
        Whether a final Neptune snapshot is created before the Neptune cluster is deleted. If true is specified, no Neptune snapshot is created. If false is specified, a Neptune snapshot is created before the Neptune cluster is deleted, using the value from `finalSnapshotIdentifier`. Default is `false`.

      • snapshotIdentifier

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> snapshotIdentifier()
        Returns:
        Whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a Neptune cluster snapshot, or the ARN when specifying a Neptune snapshot. Automated snapshots **should not** be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.

      • storageEncrypted

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> storageEncrypted()
        Returns:
        Whether the Neptune cluster is encrypted. The default is `false` if not specified.

      • storageType

        public com.pulumi.core.Output<java.lang.String> storageType()
        Returns:
        Storage type associated with the cluster `standard/iopt1`. Default: `standard`.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the Neptune cluster. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • vpcSecurityGroupIds

        public com.pulumi.core.Output<java.util.List<java.lang.String>> vpcSecurityGroupIds()
        Returns:
        List of VPC security groups to associate with the Cluster

      • get

        public static Cluster get​(java.lang.String name,
                          com.pulumi.core.Output<java.lang.String> id,
                          @Nullable
                          ClusterState state,
                          @Nullable
                          com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.