Package com.pulumi.gcp.redis.inputs

Class InstanceState

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  InstanceState.Builder  

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

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Detail

      • alternativeLocationId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> alternativeLocationId()
        Returns:
        Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [locationId].

      • authEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> authEnabled()
        Returns:
        Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled.

      • authString

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> authString()
        Returns:
        AUTH String set on the instance. This field will only be populated if auth_enabled is true.

      • authorizedNetwork

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> authorizedNetwork()
        Returns:
        The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.

      • connectMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> connectMode()
        Returns:
        The connection mode of the Redis instance. Default value is `DIRECT_PEERING`. Possible values are `DIRECT_PEERING` and `PRIVATE_SERVICE_ACCESS`.

      • createTime

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> createTime()
        Returns:
        (Output) Output only. The time when the policy was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

      • currentLocationId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> currentLocationId()
        Returns:
        The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [locationId] provided by the user at creation time. For Standard Tier instances, this can be either [locationId] or [alternativeLocationId] and can change after a failover event.

      • customerManagedKey

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> customerManagedKey()
        Returns:
        Optional. The KMS key reference that you want to use to encrypt the data at rest for this Redis instance. If this is provided, CMEK is enabled.

      • displayName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> displayName()
        Returns:
        An arbitrary and optional user-provided name for the instance.

      • host

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> host()
        Returns:
        Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.

      • labels

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> labels()
        Returns:
        Resource labels to represent user provided metadata.

      • locationId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> locationId()
        Returns:
        The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternativeLocationId] is also provided, it must be different from [locationId].

      • maintenancePolicy

        public java.util.Optional<com.pulumi.core.Output<InstanceMaintenancePolicyArgs>> maintenancePolicy()
        Returns:
        Maintenance policy for an instance. Structure is documented below.

      • maintenanceSchedule

        public java.util.Optional<com.pulumi.core.Output<InstanceMaintenanceScheduleArgs>> maintenanceSchedule()
        Returns:
        Upcoming maintenance schedule. Structure is documented below.

      • memorySizeGb

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> memorySizeGb()
        Returns:
        Redis memory size in GiB.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        The ID of the instance or a fully qualified identifier for the instance.

      • nodes

        public java.util.Optional<com.pulumi.core.Output<java.util.List<InstanceNodeArgs>>> nodes()
        Returns:
        Output only. Info per node. Structure is documented below.

      • persistenceConfig

        public java.util.Optional<com.pulumi.core.Output<InstancePersistenceConfigArgs>> persistenceConfig()
        Returns:
        Persistence configuration for an instance. Structure is documented below.

      • persistenceIamIdentity

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> persistenceIamIdentity()
        Returns:
        Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:". The value may change over time for a given instance so should be checked before each import/export operation.

      • port

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> port()
        Returns:
        The port number of the exposed Redis endpoint.

      • project

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> project()
        Returns:
        The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

      • readEndpoint

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> readEndpoint()
        Returns:
        Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'.

      • readEndpointPort

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> readEndpointPort()
        Returns:
        Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.

      • readReplicasMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> readReplicasMode()
        Returns:
        Optional. Read replica mode. Can only be specified when trying to create the instance. If not set, Memorystore Redis backend will default to READ_REPLICAS_DISABLED. - READ_REPLICAS_DISABLED: If disabled, read endpoint will not be provided and the instance cannot scale up or down the number of replicas. - READ_REPLICAS_ENABLED: If enabled, read endpoint will be provided and the instance can scale up and down the number of replicas. Possible values are `READ_REPLICAS_DISABLED` and `READ_REPLICAS_ENABLED`.

      • redisConfigs

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> redisConfigs()
        Returns:
        Redis configuration parameters, according to http://redis.io/topics/config. Please check Memorystore documentation for the list of supported parameters: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs

      • redisVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> redisVersion()
        Returns:
        The version of Redis software. If not provided, latest supported version will be used. Please check the API documentation linked at the top for the latest valid values.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        The name of the Redis region of the instance.

      • replicaCount

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> replicaCount()
        Returns:
        Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is [1-5] and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0.

      • reservedIpRange

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> reservedIpRange()
        Returns:
        The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.

      • secondaryIpRange

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> secondaryIpRange()
        Returns:
        Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto".

      • serverCaCerts

        public java.util.Optional<com.pulumi.core.Output<java.util.List<InstanceServerCaCertArgs>>> serverCaCerts()
        Returns:
        List of server CA certificates for the instance. Structure is documented below.

      • tier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> tier()
        Returns:
        The service tier of the instance. Must be one of these values: - BASIC: standalone instance - STANDARD_HA: highly available primary/replica instances Default value is `BASIC`. Possible values are `BASIC` and `STANDARD_HA`.

      • transitEncryptionMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> transitEncryptionMode()
        Returns:
        The TLS mode of the Redis instance, If not provided, TLS is disabled for the instance. - SERVER_AUTHENTICATION: Client to Server traffic encryption enabled with server authentication Default value is `DISABLED`. Possible values are `SERVER_AUTHENTICATION` and `DISABLED`.