Package com.pulumi.aws.neptune

Class ClusterArgs

  • public final class ClusterArgs
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • allowMajorVersionUpgrade

        public java.util.Optional<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 java.util.Optional<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`.

      • availabilityZones

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

      • clusterIdentifier

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

      • clusterIdentifierPrefix

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

      • copyTagsToSnapshot

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

      • deletionProtection

        public java.util.Optional<com.pulumi.core.Output<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 java.util.Optional<com.pulumi.core.Output<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`.

      • engine

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

      • engineVersion

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

      • finalSnapshotIdentifier

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

      • iamDatabaseAuthenticationEnabled

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

      • iamRoles

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

      • kmsKeyArn

        public java.util.Optional<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 java.util.Optional<com.pulumi.core.Output<java.lang.String>> neptuneClusterParameterGroupName()
        Returns:
        Cluster parameter group to associate with the cluster.

      • neptuneInstanceParameterGroupName

        public java.util.Optional<com.pulumi.core.Output<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 java.util.Optional<com.pulumi.core.Output<java.lang.String>> neptuneSubnetGroupName()
        Returns:
        Neptune subnet group to associate with this Neptune instance.

      • networkType

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

      • preferredBackupWindow

        public java.util.Optional<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 java.util.Optional<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

      • region

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

      • skipFinalSnapshot

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

      • storageType

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

      • tags

        public java.util.Optional<com.pulumi.core.Output<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.

      • vpcSecurityGroupIds

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