Package com.hashicorp.cdktf.providers.google.redis_instance

Class RedisInstance

  • All Implemented Interfaces:
    com.hashicorp.cdktf.IInterpolatingParent, com.hashicorp.cdktf.ITerraformAddressable, com.hashicorp.cdktf.ITerraformDependable, com.hashicorp.cdktf.ITerraformResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:22.522Z")
@Stability(Stable)
public class RedisInstance
extends com.hashicorp.cdktf.TerraformResource
    Represents a {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance google_redis_instance}.

    • Field Detail

      • TF_RESOURCE_TYPE

        @Stability(Stable)
public static final String TF_RESOURCE_TYPE

    • Constructor Detail

      • RedisInstance

        protected RedisInstance​(software.amazon.jsii.JsiiObjectRef objRef)

      • RedisInstance

        protected RedisInstance​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • RedisInstance

        @Stability(Stable)
public RedisInstance​(@NotNull
                     software.constructs.Construct scope,
                     @NotNull
                     String id,
                     @NotNull
                     RedisInstanceConfig config)
        Create a new {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance google_redis_instance} Resource.

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        config - This parameter is required.

    • Method Detail

      • generateConfigForImport

        @Stability(Stable)
@NotNull
public static com.hashicorp.cdktf.ImportableResource generateConfigForImport​(@NotNull
                                                                             software.constructs.Construct scope,
                                                                             @NotNull
                                                                             String importToId,
                                                                             @NotNull
                                                                             String importFromId,
                                                                             @Nullable
                                                                             com.hashicorp.cdktf.TerraformProvider provider)
        Generates CDKTF code for importing a RedisInstance resource upon running "cdktf plan ".

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        importToId - The construct id used in the generated config for the RedisInstance to import. This parameter is required.
        importFromId - The id of the existing RedisInstance that should be imported. This parameter is required.
        provider - ? Optional instance of the provider where the RedisInstance to import is found.

      • generateConfigForImport

        @Stability(Stable)
@NotNull
public static com.hashicorp.cdktf.ImportableResource generateConfigForImport​(@NotNull
                                                                             software.constructs.Construct scope,
                                                                             @NotNull
                                                                             String importToId,
                                                                             @NotNull
                                                                             String importFromId)
        Generates CDKTF code for importing a RedisInstance resource upon running "cdktf plan ".

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        importToId - The construct id used in the generated config for the RedisInstance to import. This parameter is required.
        importFromId - The id of the existing RedisInstance that should be imported. This parameter is required.

      • putMaintenancePolicy

        @Stability(Stable)
public void putMaintenancePolicy​(@NotNull
                                 RedisInstanceMaintenancePolicy value)
        Parameters:
        value - This parameter is required.

      • putPersistenceConfig

        @Stability(Stable)
public void putPersistenceConfig​(@NotNull
                                 RedisInstancePersistenceConfig value)
        Parameters:
        value - This parameter is required.

      • putTimeouts

        @Stability(Stable)
public void putTimeouts​(@NotNull
                        RedisInstanceTimeouts value)
        Parameters:
        value - This parameter is required.

      • resetAlternativeLocationId

        @Stability(Stable)
public void resetAlternativeLocationId()

      • resetAuthEnabled

        @Stability(Stable)
public void resetAuthEnabled()

      • resetAuthorizedNetwork

        @Stability(Stable)
public void resetAuthorizedNetwork()

      • resetConnectMode

        @Stability(Stable)
public void resetConnectMode()

      • resetCustomerManagedKey

        @Stability(Stable)
public void resetCustomerManagedKey()

      • resetDisplayName

        @Stability(Stable)
public void resetDisplayName()

      • resetId

        @Stability(Stable)
public void resetId()

      • resetLabels

        @Stability(Stable)
public void resetLabels()

      • resetLocationId

        @Stability(Stable)
public void resetLocationId()

      • resetMaintenancePolicy

        @Stability(Stable)
public void resetMaintenancePolicy()

      • resetMaintenanceVersion

        @Stability(Stable)
public void resetMaintenanceVersion()

      • resetPersistenceConfig

        @Stability(Stable)
public void resetPersistenceConfig()

      • resetProject

        @Stability(Stable)
public void resetProject()

      • resetReadReplicasMode

        @Stability(Stable)
public void resetReadReplicasMode()

      • resetRedisConfigs

        @Stability(Stable)
public void resetRedisConfigs()

      • resetRedisVersion

        @Stability(Stable)
public void resetRedisVersion()

      • resetRegion

        @Stability(Stable)
public void resetRegion()

      • resetReplicaCount

        @Stability(Stable)
public void resetReplicaCount()

      • resetReservedIpRange

        @Stability(Stable)
public void resetReservedIpRange()

      • resetSecondaryIpRange

        @Stability(Stable)
public void resetSecondaryIpRange()

      • resetTier

        @Stability(Stable)
public void resetTier()

      • resetTimeouts

        @Stability(Stable)
public void resetTimeouts()

      • resetTransitEncryptionMode

        @Stability(Stable)
public void resetTransitEncryptionMode()

      • synthesizeAttributes

        @Stability(Stable)
@NotNull
protected Map<String,​Object> synthesizeAttributes()
        Overrides:
        synthesizeAttributes in class com.hashicorp.cdktf.TerraformResource

      • synthesizeHclAttributes

        @Stability(Stable)
@NotNull
protected Map<String,​Object> synthesizeHclAttributes()
        Overrides:
        synthesizeHclAttributes in class com.hashicorp.cdktf.TerraformResource

      • getAuthString

        @Stability(Stable)
@NotNull
public String getAuthString()

      • getCreateTime

        @Stability(Stable)
@NotNull
public String getCreateTime()

      • getCurrentLocationId

        @Stability(Stable)
@NotNull
public String getCurrentLocationId()

      • getEffectiveLabels

        @Stability(Stable)
@NotNull
public com.hashicorp.cdktf.StringMap getEffectiveLabels()

      • getHost

        @Stability(Stable)
@NotNull
public String getHost()

      • getPersistenceIamIdentity

        @Stability(Stable)
@NotNull
public String getPersistenceIamIdentity()

      • getPort

        @Stability(Stable)
@NotNull
public Number getPort()

      • getReadEndpoint

        @Stability(Stable)
@NotNull
public String getReadEndpoint()

      • getReadEndpointPort

        @Stability(Stable)
@NotNull
public Number getReadEndpointPort()

      • getTerraformLabels

        @Stability(Stable)
@NotNull
public com.hashicorp.cdktf.StringMap getTerraformLabels()

      • getAlternativeLocationIdInput

        @Stability(Stable)
@Nullable
public String getAlternativeLocationIdInput()

      • getAuthEnabledInput

        @Stability(Stable)
@Nullable
public Object getAuthEnabledInput()

      • getAuthorizedNetworkInput

        @Stability(Stable)
@Nullable
public String getAuthorizedNetworkInput()

      • getConnectModeInput

        @Stability(Stable)
@Nullable
public String getConnectModeInput()

      • getCustomerManagedKeyInput

        @Stability(Stable)
@Nullable
public String getCustomerManagedKeyInput()

      • getDisplayNameInput

        @Stability(Stable)
@Nullable
public String getDisplayNameInput()

      • getIdInput

        @Stability(Stable)
@Nullable
public String getIdInput()

      • getLabelsInput

        @Stability(Stable)
@Nullable
public Map<String,​String> getLabelsInput()

      • getLocationIdInput

        @Stability(Stable)
@Nullable
public String getLocationIdInput()

      • getMaintenanceVersionInput

        @Stability(Stable)
@Nullable
public String getMaintenanceVersionInput()

      • getMemorySizeGbInput

        @Stability(Stable)
@Nullable
public Number getMemorySizeGbInput()

      • getNameInput

        @Stability(Stable)
@Nullable
public String getNameInput()

      • getProjectInput

        @Stability(Stable)
@Nullable
public String getProjectInput()

      • getReadReplicasModeInput

        @Stability(Stable)
@Nullable
public String getReadReplicasModeInput()

      • getRedisConfigsInput

        @Stability(Stable)
@Nullable
public Map<String,​String> getRedisConfigsInput()

      • getRedisVersionInput

        @Stability(Stable)
@Nullable
public String getRedisVersionInput()

      • getRegionInput

        @Stability(Stable)
@Nullable
public String getRegionInput()

      • getReplicaCountInput

        @Stability(Stable)
@Nullable
public Number getReplicaCountInput()

      • getReservedIpRangeInput

        @Stability(Stable)
@Nullable
public String getReservedIpRangeInput()

      • getSecondaryIpRangeInput

        @Stability(Stable)
@Nullable
public String getSecondaryIpRangeInput()

      • getTierInput

        @Stability(Stable)
@Nullable
public String getTierInput()

      • getTimeoutsInput

        @Stability(Stable)
@Nullable
public Object getTimeoutsInput()

      • getTransitEncryptionModeInput

        @Stability(Stable)
@Nullable
public String getTransitEncryptionModeInput()

      • getAlternativeLocationId

        @Stability(Stable)
@NotNull
public String getAlternativeLocationId()

      • setAlternativeLocationId

        @Stability(Stable)
public void setAlternativeLocationId​(@NotNull
                                     String value)

      • getAuthEnabled

        @Stability(Stable)
@NotNull
public Object getAuthEnabled()

      • setAuthEnabled

        @Stability(Stable)
public void setAuthEnabled​(@NotNull
                           Boolean value)

      • setAuthEnabled

        @Stability(Stable)
public void setAuthEnabled​(@NotNull
                           com.hashicorp.cdktf.IResolvable value)

      • getAuthorizedNetwork

        @Stability(Stable)
@NotNull
public String getAuthorizedNetwork()

      • setAuthorizedNetwork

        @Stability(Stable)
public void setAuthorizedNetwork​(@NotNull
                                 String value)

      • getConnectMode

        @Stability(Stable)
@NotNull
public String getConnectMode()

      • setConnectMode

        @Stability(Stable)
public void setConnectMode​(@NotNull
                           String value)

      • getCustomerManagedKey

        @Stability(Stable)
@NotNull
public String getCustomerManagedKey()

      • setCustomerManagedKey

        @Stability(Stable)
public void setCustomerManagedKey​(@NotNull
                                  String value)

      • getDisplayName

        @Stability(Stable)
@NotNull
public String getDisplayName()

      • setDisplayName

        @Stability(Stable)
public void setDisplayName​(@NotNull
                           String value)

      • getId

        @Stability(Stable)
@NotNull
public String getId()

      • setId

        @Stability(Stable)
public void setId​(@NotNull
                  String value)

      • getLabels

        @Stability(Stable)
@NotNull
public Map<String,​String> getLabels()

      • setLabels

        @Stability(Stable)
public void setLabels​(@NotNull
                      Map<String,​String> value)

      • getLocationId

        @Stability(Stable)
@NotNull
public String getLocationId()

      • setLocationId

        @Stability(Stable)
public void setLocationId​(@NotNull
                          String value)

      • getMaintenanceVersion

        @Stability(Stable)
@NotNull
public String getMaintenanceVersion()

      • setMaintenanceVersion

        @Stability(Stable)
public void setMaintenanceVersion​(@NotNull
                                  String value)

      • getMemorySizeGb

        @Stability(Stable)
@NotNull
public Number getMemorySizeGb()

      • setMemorySizeGb

        @Stability(Stable)
public void setMemorySizeGb​(@NotNull
                            Number value)

      • getName

        @Stability(Stable)
@NotNull
public String getName()

      • setName

        @Stability(Stable)
public void setName​(@NotNull
                    String value)

      • getProject

        @Stability(Stable)
@NotNull
public String getProject()

      • setProject

        @Stability(Stable)
public void setProject​(@NotNull
                       String value)

      • getReadReplicasMode

        @Stability(Stable)
@NotNull
public String getReadReplicasMode()

      • setReadReplicasMode

        @Stability(Stable)
public void setReadReplicasMode​(@NotNull
                                String value)

      • getRedisConfigs

        @Stability(Stable)
@NotNull
public Map<String,​String> getRedisConfigs()

      • setRedisConfigs

        @Stability(Stable)
public void setRedisConfigs​(@NotNull
                            Map<String,​String> value)

      • getRedisVersion

        @Stability(Stable)
@NotNull
public String getRedisVersion()

      • setRedisVersion

        @Stability(Stable)
public void setRedisVersion​(@NotNull
                            String value)

      • getRegion

        @Stability(Stable)
@NotNull
public String getRegion()

      • setRegion

        @Stability(Stable)
public void setRegion​(@NotNull
                      String value)

      • getReplicaCount

        @Stability(Stable)
@NotNull
public Number getReplicaCount()

      • setReplicaCount

        @Stability(Stable)
public void setReplicaCount​(@NotNull
                            Number value)

      • getReservedIpRange

        @Stability(Stable)
@NotNull
public String getReservedIpRange()

      • setReservedIpRange

        @Stability(Stable)
public void setReservedIpRange​(@NotNull
                               String value)

      • getSecondaryIpRange

        @Stability(Stable)
@NotNull
public String getSecondaryIpRange()

      • setSecondaryIpRange

        @Stability(Stable)
public void setSecondaryIpRange​(@NotNull
                                String value)

      • getTier

        @Stability(Stable)
@NotNull
public String getTier()

      • setTier

        @Stability(Stable)
public void setTier​(@NotNull
                    String value)

      • getTransitEncryptionMode

        @Stability(Stable)
@NotNull
public String getTransitEncryptionMode()

      • setTransitEncryptionMode

        @Stability(Stable)
public void setTransitEncryptionMode​(@NotNull
                                     String value)