Skip to content

Files

Latest commit

 

History

History
6622 lines (4218 loc) · 287 KB
·

redisInstance.python.md

File metadata and controls

6622 lines (4218 loc) · 287 KB
·

redisInstance Submodule

Constructs

RedisInstance

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance google_redis_instance}.

Initializers 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstance(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  memory_size_gb: typing.Union[int, float],
  name: str,
  alternative_location_id: str = None,
  auth_enabled: typing.Union[bool, IResolvable] = None,
  authorized_network: str = None,
  connect_mode: str = None,
  customer_managed_key: str = None,
  display_name: str = None,
  id: str = None,
  labels: typing.Mapping[str] = None,
  location_id: str = None,
  maintenance_policy: RedisInstanceMaintenancePolicy = None,
  maintenance_version: str = None,
  persistence_config: RedisInstancePersistenceConfig = None,
  project: str = None,
  read_replicas_mode: str = None,
  redis_configs: typing.Mapping[str] = None,
  redis_version: str = None,
  region: str = None,
  replica_count: typing.Union[int, float] = None,
  reserved_ip_range: str = None,
  secondary_ip_range: str = None,
  tags: typing.Mapping[str] = None,
  tier: str = None,
  timeouts: RedisInstanceTimeouts = None,
  transit_encryption_mode: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
memory_size_gb typing.Union[int, float] Redis memory size in GiB.
name str The ID of the instance or a fully qualified identifier for the instance.
alternative_location_id str Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones.
auth_enabled typing.Union[bool, cdktf.IResolvable] Optional.
authorized_network str The full name of the Google Compute Engine network to which the instance is connected.
connect_mode str The connection mode of the Redis instance. Default value: "DIRECT_PEERING" Possible values: ["DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS"].
customer_managed_key str Optional.
display_name str An arbitrary and optional user-provided name for the instance.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#id RedisInstance#id}.
labels typing.Mapping[str] Resource labels to represent user provided metadata.
location_id str The zone where the instance will be provisioned.
maintenance_policy RedisInstanceMaintenancePolicy maintenance_policy block.
maintenance_version str The self service update maintenance version.
persistence_config RedisInstancePersistenceConfig persistence_config block.
project str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#project RedisInstance#project}.
read_replicas_mode str Optional.
redis_configs typing.Mapping[str] 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.
redis_version str The version of Redis software.
region str The name of the Redis region of the instance.
replica_count typing.Union[int, float] Optional.
reserved_ip_range str The CIDR range of internal addresses that are reserved for this instance.
secondary_ip_range str Optional.
tags typing.Mapping[str] A map of resource manager tags.
tier str The service tier of the instance. Must be one of these values:.
timeouts RedisInstanceTimeouts timeouts block.
transit_encryption_mode str The TLS mode of the Redis instance, If not provided, TLS is disabled for the instance.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
memory_size_gbRequired
  • Type: typing.Union[int, float]

Redis memory size in GiB.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#memory_size_gb RedisInstance#memory_size_gb}

nameRequired
  • Type: str

The ID of the instance or a fully qualified identifier for the instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#name RedisInstance#name}

alternative_location_idOptional
  • Type: str

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].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#alternative_location_id RedisInstance#alternative_location_id}

auth_enabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#auth_enabled RedisInstance#auth_enabled}

authorized_networkOptional
  • Type: str

The full name of the Google Compute Engine network to which the instance is connected.

If left unspecified, the default network will be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#authorized_network RedisInstance#authorized_network}

connect_modeOptional
  • Type: str

The connection mode of the Redis instance. Default value: "DIRECT_PEERING" Possible values: ["DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#connect_mode RedisInstance#connect_mode}

customer_managed_keyOptional
  • Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#customer_managed_key RedisInstance#customer_managed_key}

display_nameOptional
  • Type: str

An arbitrary and optional user-provided name for the instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#display_name RedisInstance#display_name}

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#id RedisInstance#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

labelsOptional
  • Type: typing.Mapping[str]

Resource labels to represent user provided metadata.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#labels RedisInstance#labels}

location_idOptional
  • Type: str

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].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#location_id RedisInstance#location_id}

maintenance_policyOptional

maintenance_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#maintenance_policy RedisInstance#maintenance_policy}

maintenance_versionOptional
  • Type: str

The self service update maintenance version.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#maintenance_version RedisInstance#maintenance_version}

persistence_configOptional

persistence_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#persistence_config RedisInstance#persistence_config}

projectOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#project RedisInstance#project}.

read_replicas_modeOptional
  • Type: str

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: ["READ_REPLICAS_DISABLED", "READ_REPLICAS_ENABLED"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#read_replicas_mode RedisInstance#read_replicas_mode}

redis_configsOptional
  • Type: typing.Mapping[str]

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#redis_configs RedisInstance#redis_configs}

redis_versionOptional
  • Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#redis_version RedisInstance#redis_version}

regionOptional
  • Type: str

The name of the Redis region of the instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#region RedisInstance#region}

replica_countOptional
  • Type: typing.Union[int, float]

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#replica_count RedisInstance#replica_count}

reserved_ip_rangeOptional
  • Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#reserved_ip_range RedisInstance#reserved_ip_range}

secondary_ip_rangeOptional
  • Type: str

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".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#secondary_ip_range RedisInstance#secondary_ip_range}

tagsOptional
  • Type: typing.Mapping[str]

A map of resource manager tags.

Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/{tag_key_value}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#tags RedisInstance#tags}

tierOptional
  • Type: str

The service tier of the instance. Must be one of these values:.

  • BASIC: standalone instance
  • STANDARD_HA: highly available primary/replica instances Default value: "BASIC" Possible values: ["BASIC", "STANDARD_HA"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#tier RedisInstance#tier}

timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#timeouts RedisInstance#timeouts}

transit_encryption_modeOptional
  • Type: str

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: "DISABLED" Possible values: ["SERVER_AUTHENTICATION", "DISABLED"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#transit_encryption_mode RedisInstance#transit_encryption_mode}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_maintenance_policy No description.
put_persistence_config No description.
put_timeouts No description.
reset_alternative_location_id No description.
reset_auth_enabled No description.
reset_authorized_network No description.
reset_connect_mode No description.
reset_customer_managed_key No description.
reset_display_name No description.
reset_id No description.
reset_labels No description.
reset_location_id No description.
reset_maintenance_policy No description.
reset_maintenance_version No description.
reset_persistence_config No description.
reset_project No description.
reset_read_replicas_mode No description.
reset_redis_configs No description.
reset_redis_version No description.
reset_region No description.
reset_replica_count No description.
reset_reserved_ip_range No description.
reset_secondary_ip_range No description.
reset_tags No description.
reset_tier No description.
reset_timeouts No description.
reset_transit_encryption_mode No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

move_to_id 
def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

put_maintenance_policy 
def put_maintenance_policy(
  description: str = None,
  weekly_maintenance_window: typing.Union[IResolvable, typing.List[RedisInstanceMaintenancePolicyWeeklyMaintenanceWindow]] = None
) -> None
descriptionOptional
  • Type: str

Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#description RedisInstance#description}

weekly_maintenance_windowOptional

weekly_maintenance_window block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#weekly_maintenance_window RedisInstance#weekly_maintenance_window}

put_persistence_config 
def put_persistence_config(
  persistence_mode: str = None,
  rdb_snapshot_period: str = None,
  rdb_snapshot_start_time: str = None
) -> None
persistence_modeOptional
  • Type: str

Optional. Controls whether Persistence features are enabled. If not provided, the existing value will be used.

  • DISABLED: Persistence is disabled for the instance, and any existing snapshots are deleted.
  • RDB: RDB based Persistence is enabled. Possible values: ["DISABLED", "RDB"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#persistence_mode RedisInstance#persistence_mode}

rdb_snapshot_periodOptional
  • Type: str

Optional. Available snapshot periods for scheduling.

  • ONE_HOUR: Snapshot every 1 hour.
  • SIX_HOURS: Snapshot every 6 hours.
  • TWELVE_HOURS: Snapshot every 12 hours.
  • TWENTY_FOUR_HOURS: Snapshot every 24 hours. Possible values: ["ONE_HOUR", "SIX_HOURS", "TWELVE_HOURS", "TWENTY_FOUR_HOURS"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#rdb_snapshot_period RedisInstance#rdb_snapshot_period}

rdb_snapshot_start_timeOptional
  • Type: str

Optional.

Date and time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#rdb_snapshot_start_time RedisInstance#rdb_snapshot_start_time}

put_timeouts 
def put_timeouts(
  create: str = None,
  delete: str = None,
  update: str = None
) -> None
createOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#create RedisInstance#create}.

deleteOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#delete RedisInstance#delete}.

updateOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#update RedisInstance#update}.

reset_alternative_location_id 
def reset_alternative_location_id() -> None
reset_auth_enabled 
def reset_auth_enabled() -> None
reset_authorized_network 
def reset_authorized_network() -> None
reset_connect_mode 
def reset_connect_mode() -> None
reset_customer_managed_key 
def reset_customer_managed_key() -> None
reset_display_name 
def reset_display_name() -> None
reset_id 
def reset_id() -> None
reset_labels 
def reset_labels() -> None
reset_location_id 
def reset_location_id() -> None
reset_maintenance_policy 
def reset_maintenance_policy() -> None
reset_maintenance_version 
def reset_maintenance_version() -> None
reset_persistence_config 
def reset_persistence_config() -> None
reset_project 
def reset_project() -> None
reset_read_replicas_mode 
def reset_read_replicas_mode() -> None
reset_redis_configs 
def reset_redis_configs() -> None
reset_redis_version 
def reset_redis_version() -> None
reset_region 
def reset_region() -> None
reset_replica_count 
def reset_replica_count() -> None
reset_reserved_ip_range 
def reset_reserved_ip_range() -> None
reset_secondary_ip_range 
def reset_secondary_ip_range() -> None
reset_tags 
def reset_tags() -> None
reset_tier 
def reset_tier() -> None
reset_timeouts 
def reset_timeouts() -> None
reset_transit_encryption_mode 
def reset_transit_encryption_mode() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a RedisInstance resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstance.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstance.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstance.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstance.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a RedisInstance resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

The construct id used in the generated config for the RedisInstance to import.

import_from_idRequired
  • Type: str

The id of the existing RedisInstance that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the RedisInstance to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
auth_string str No description.
create_time str No description.
current_location_id str No description.
effective_labels cdktf.StringMap No description.
host str No description.
maintenance_policy RedisInstanceMaintenancePolicyOutputReference No description.
maintenance_schedule RedisInstanceMaintenanceScheduleList No description.
nodes RedisInstanceNodesList No description.
persistence_config RedisInstancePersistenceConfigOutputReference No description.
persistence_iam_identity str No description.
port typing.Union[int, float] No description.
read_endpoint str No description.
read_endpoint_port typing.Union[int, float] No description.
server_ca_certs RedisInstanceServerCaCertsList No description.
terraform_labels cdktf.StringMap No description.
timeouts RedisInstanceTimeoutsOutputReference No description.
alternative_location_id_input str No description.
auth_enabled_input typing.Union[bool, cdktf.IResolvable] No description.
authorized_network_input str No description.
connect_mode_input str No description.
customer_managed_key_input str No description.
display_name_input str No description.
id_input str No description.
labels_input typing.Mapping[str] No description.
location_id_input str No description.
maintenance_policy_input RedisInstanceMaintenancePolicy No description.
maintenance_version_input str No description.
memory_size_gb_input typing.Union[int, float] No description.
name_input str No description.
persistence_config_input RedisInstancePersistenceConfig No description.
project_input str No description.
read_replicas_mode_input str No description.
redis_configs_input typing.Mapping[str] No description.
redis_version_input str No description.
region_input str No description.
replica_count_input typing.Union[int, float] No description.
reserved_ip_range_input str No description.
secondary_ip_range_input str No description.
tags_input typing.Mapping[str] No description.
tier_input str No description.
timeouts_input typing.Union[cdktf.IResolvable, RedisInstanceTimeouts] No description.
transit_encryption_mode_input str No description.
alternative_location_id str No description.
auth_enabled typing.Union[bool, cdktf.IResolvable] No description.
authorized_network str No description.
connect_mode str No description.
customer_managed_key str No description.
display_name str No description.
id str No description.
labels typing.Mapping[str] No description.
location_id str No description.
maintenance_version str No description.
memory_size_gb typing.Union[int, float] No description.
name str No description.
project str No description.
read_replicas_mode str No description.
redis_configs typing.Mapping[str] No description.
redis_version str No description.
region str No description.
replica_count typing.Union[int, float] No description.
reserved_ip_range str No description.
secondary_ip_range str No description.
tags typing.Mapping[str] No description.
tier str No description.
transit_encryption_mode str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
auth_stringRequired 
auth_string: str
  • Type: str
create_timeRequired 
create_time: str
  • Type: str
current_location_idRequired 
current_location_id: str
  • Type: str
effective_labelsRequired 
effective_labels: StringMap
  • Type: cdktf.StringMap
hostRequired 
host: str
  • Type: str
maintenance_policyRequired 
maintenance_policy: RedisInstanceMaintenancePolicyOutputReference
maintenance_scheduleRequired 
maintenance_schedule: RedisInstanceMaintenanceScheduleList
nodesRequired 
nodes: RedisInstanceNodesList
persistence_configRequired 
persistence_config: RedisInstancePersistenceConfigOutputReference
persistence_iam_identityRequired 
persistence_iam_identity: str
  • Type: str
portRequired 
port: typing.Union[int, float]
  • Type: typing.Union[int, float]
read_endpointRequired 
read_endpoint: str
  • Type: str
read_endpoint_portRequired 
read_endpoint_port: typing.Union[int, float]
  • Type: typing.Union[int, float]
server_ca_certsRequired 
server_ca_certs: RedisInstanceServerCaCertsList
terraform_labelsRequired 
terraform_labels: StringMap
  • Type: cdktf.StringMap
timeoutsRequired 
timeouts: RedisInstanceTimeoutsOutputReference
alternative_location_id_inputOptional 
alternative_location_id_input: str
  • Type: str
auth_enabled_inputOptional 
auth_enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
authorized_network_inputOptional 
authorized_network_input: str
  • Type: str
connect_mode_inputOptional 
connect_mode_input: str
  • Type: str
customer_managed_key_inputOptional 
customer_managed_key_input: str
  • Type: str
display_name_inputOptional 
display_name_input: str
  • Type: str
id_inputOptional 
id_input: str
  • Type: str
labels_inputOptional 
labels_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
location_id_inputOptional 
location_id_input: str
  • Type: str
maintenance_policy_inputOptional 
maintenance_policy_input: RedisInstanceMaintenancePolicy
maintenance_version_inputOptional 
maintenance_version_input: str
  • Type: str
memory_size_gb_inputOptional 
memory_size_gb_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
name_inputOptional 
name_input: str
  • Type: str
persistence_config_inputOptional 
persistence_config_input: RedisInstancePersistenceConfig
project_inputOptional 
project_input: str
  • Type: str
read_replicas_mode_inputOptional 
read_replicas_mode_input: str
  • Type: str
redis_configs_inputOptional 
redis_configs_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
redis_version_inputOptional 
redis_version_input: str
  • Type: str
region_inputOptional 
region_input: str
  • Type: str
replica_count_inputOptional 
replica_count_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
reserved_ip_range_inputOptional 
reserved_ip_range_input: str
  • Type: str
secondary_ip_range_inputOptional 
secondary_ip_range_input: str
  • Type: str
tags_inputOptional 
tags_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
tier_inputOptional 
tier_input: str
  • Type: str
timeouts_inputOptional 
timeouts_input: typing.Union[IResolvable, RedisInstanceTimeouts]
transit_encryption_mode_inputOptional 
transit_encryption_mode_input: str
  • Type: str
alternative_location_idRequired 
alternative_location_id: str
  • Type: str
auth_enabledRequired 
auth_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
authorized_networkRequired 
authorized_network: str
  • Type: str
connect_modeRequired 
connect_mode: str
  • Type: str
customer_managed_keyRequired 
customer_managed_key: str
  • Type: str
display_nameRequired 
display_name: str
  • Type: str
idRequired 
id: str
  • Type: str
labelsRequired 
labels: typing.Mapping[str]
  • Type: typing.Mapping[str]
location_idRequired 
location_id: str
  • Type: str
maintenance_versionRequired 
maintenance_version: str
  • Type: str
memory_size_gbRequired 
memory_size_gb: typing.Union[int, float]
  • Type: typing.Union[int, float]
nameRequired 
name: str
  • Type: str
projectRequired 
project: str
  • Type: str
read_replicas_modeRequired 
read_replicas_mode: str
  • Type: str
redis_configsRequired 
redis_configs: typing.Mapping[str]
  • Type: typing.Mapping[str]
redis_versionRequired 
redis_version: str
  • Type: str
regionRequired 
region: str
  • Type: str
replica_countRequired 
replica_count: typing.Union[int, float]
  • Type: typing.Union[int, float]
reserved_ip_rangeRequired 
reserved_ip_range: str
  • Type: str
secondary_ip_rangeRequired 
secondary_ip_range: str
  • Type: str
tagsRequired 
tags: typing.Mapping[str]
  • Type: typing.Mapping[str]
tierRequired 
tier: str
  • Type: str
transit_encryption_modeRequired 
transit_encryption_mode: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

RedisInstanceConfig

Initializer 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  memory_size_gb: typing.Union[int, float],
  name: str,
  alternative_location_id: str = None,
  auth_enabled: typing.Union[bool, IResolvable] = None,
  authorized_network: str = None,
  connect_mode: str = None,
  customer_managed_key: str = None,
  display_name: str = None,
  id: str = None,
  labels: typing.Mapping[str] = None,
  location_id: str = None,
  maintenance_policy: RedisInstanceMaintenancePolicy = None,
  maintenance_version: str = None,
  persistence_config: RedisInstancePersistenceConfig = None,
  project: str = None,
  read_replicas_mode: str = None,
  redis_configs: typing.Mapping[str] = None,
  redis_version: str = None,
  region: str = None,
  replica_count: typing.Union[int, float] = None,
  reserved_ip_range: str = None,
  secondary_ip_range: str = None,
  tags: typing.Mapping[str] = None,
  tier: str = None,
  timeouts: RedisInstanceTimeouts = None,
  transit_encryption_mode: str = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
memory_size_gb typing.Union[int, float] Redis memory size in GiB.
name str The ID of the instance or a fully qualified identifier for the instance.
alternative_location_id str Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones.
auth_enabled typing.Union[bool, cdktf.IResolvable] Optional.
authorized_network str The full name of the Google Compute Engine network to which the instance is connected.
connect_mode str The connection mode of the Redis instance. Default value: "DIRECT_PEERING" Possible values: ["DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS"].
customer_managed_key str Optional.
display_name str An arbitrary and optional user-provided name for the instance.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#id RedisInstance#id}.
labels typing.Mapping[str] Resource labels to represent user provided metadata.
location_id str The zone where the instance will be provisioned.
maintenance_policy RedisInstanceMaintenancePolicy maintenance_policy block.
maintenance_version str The self service update maintenance version.
persistence_config RedisInstancePersistenceConfig persistence_config block.
project str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#project RedisInstance#project}.
read_replicas_mode str Optional.
redis_configs typing.Mapping[str] 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.
redis_version str The version of Redis software.
region str The name of the Redis region of the instance.
replica_count typing.Union[int, float] Optional.
reserved_ip_range str The CIDR range of internal addresses that are reserved for this instance.
secondary_ip_range str Optional.
tags typing.Mapping[str] A map of resource manager tags.
tier str The service tier of the instance. Must be one of these values:.
timeouts RedisInstanceTimeouts timeouts block.
transit_encryption_mode str The TLS mode of the Redis instance, If not provided, TLS is disabled for the instance.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
memory_size_gbRequired 
memory_size_gb: typing.Union[int, float]
  • Type: typing.Union[int, float]

Redis memory size in GiB.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#memory_size_gb RedisInstance#memory_size_gb}

nameRequired 
name: str
  • Type: str

The ID of the instance or a fully qualified identifier for the instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#name RedisInstance#name}

alternative_location_idOptional 
alternative_location_id: str
  • Type: str

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].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#alternative_location_id RedisInstance#alternative_location_id}

auth_enabledOptional 
auth_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#auth_enabled RedisInstance#auth_enabled}

authorized_networkOptional 
authorized_network: str
  • Type: str

The full name of the Google Compute Engine network to which the instance is connected.

If left unspecified, the default network will be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#authorized_network RedisInstance#authorized_network}

connect_modeOptional 
connect_mode: str
  • Type: str

The connection mode of the Redis instance. Default value: "DIRECT_PEERING" Possible values: ["DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#connect_mode RedisInstance#connect_mode}

customer_managed_keyOptional 
customer_managed_key: str
  • Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#customer_managed_key RedisInstance#customer_managed_key}

display_nameOptional 
display_name: str
  • Type: str

An arbitrary and optional user-provided name for the instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#display_name RedisInstance#display_name}

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#id RedisInstance#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

labelsOptional 
labels: typing.Mapping[str]
  • Type: typing.Mapping[str]

Resource labels to represent user provided metadata.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#labels RedisInstance#labels}

location_idOptional 
location_id: str
  • Type: str

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].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#location_id RedisInstance#location_id}

maintenance_policyOptional 
maintenance_policy: RedisInstanceMaintenancePolicy

maintenance_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#maintenance_policy RedisInstance#maintenance_policy}

maintenance_versionOptional 
maintenance_version: str
  • Type: str

The self service update maintenance version.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#maintenance_version RedisInstance#maintenance_version}

persistence_configOptional 
persistence_config: RedisInstancePersistenceConfig

persistence_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#persistence_config RedisInstance#persistence_config}

projectOptional 
project: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#project RedisInstance#project}.

read_replicas_modeOptional 
read_replicas_mode: str
  • Type: str

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: ["READ_REPLICAS_DISABLED", "READ_REPLICAS_ENABLED"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#read_replicas_mode RedisInstance#read_replicas_mode}

redis_configsOptional 
redis_configs: typing.Mapping[str]
  • Type: typing.Mapping[str]

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#redis_configs RedisInstance#redis_configs}

redis_versionOptional 
redis_version: str
  • Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#redis_version RedisInstance#redis_version}

regionOptional 
region: str
  • Type: str

The name of the Redis region of the instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#region RedisInstance#region}

replica_countOptional 
replica_count: typing.Union[int, float]
  • Type: typing.Union[int, float]

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#replica_count RedisInstance#replica_count}

reserved_ip_rangeOptional 
reserved_ip_range: str
  • Type: str

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#reserved_ip_range RedisInstance#reserved_ip_range}

secondary_ip_rangeOptional 
secondary_ip_range: str
  • Type: str

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".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#secondary_ip_range RedisInstance#secondary_ip_range}

tagsOptional 
tags: typing.Mapping[str]
  • Type: typing.Mapping[str]

A map of resource manager tags.

Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/{tag_key_value}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#tags RedisInstance#tags}

tierOptional 
tier: str
  • Type: str

The service tier of the instance. Must be one of these values:.

  • BASIC: standalone instance
  • STANDARD_HA: highly available primary/replica instances Default value: "BASIC" Possible values: ["BASIC", "STANDARD_HA"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#tier RedisInstance#tier}

timeoutsOptional 
timeouts: RedisInstanceTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#timeouts RedisInstance#timeouts}

transit_encryption_modeOptional 
transit_encryption_mode: str
  • Type: str

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: "DISABLED" Possible values: ["SERVER_AUTHENTICATION", "DISABLED"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#transit_encryption_mode RedisInstance#transit_encryption_mode}

RedisInstanceMaintenancePolicy

Initializer 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceMaintenancePolicy(
  description: str = None,
  weekly_maintenance_window: typing.Union[IResolvable, typing.List[RedisInstanceMaintenancePolicyWeeklyMaintenanceWindow]] = None
)

Properties

Name Type Description
description str Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
weekly_maintenance_window typing.Union[cdktf.IResolvable, typing.List[RedisInstanceMaintenancePolicyWeeklyMaintenanceWindow]] weekly_maintenance_window block.
descriptionOptional 
description: str
  • Type: str

Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#description RedisInstance#description}

weekly_maintenance_windowOptional 
weekly_maintenance_window: typing.Union[IResolvable, typing.List[RedisInstanceMaintenancePolicyWeeklyMaintenanceWindow]]

weekly_maintenance_window block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#weekly_maintenance_window RedisInstance#weekly_maintenance_window}

RedisInstanceMaintenancePolicyWeeklyMaintenanceWindow

Initializer 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceMaintenancePolicyWeeklyMaintenanceWindow(
  day: str,
  start_time: RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime
)

Properties

Name Type Description
day str Required. The day of week that maintenance updates occur.
start_time RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime start_time block.
dayRequired 
day: str
  • Type: str

Required. The day of week that maintenance updates occur.

  • DAY_OF_WEEK_UNSPECIFIED: The day of the week is unspecified.
  • MONDAY: Monday
  • TUESDAY: Tuesday
  • WEDNESDAY: Wednesday
  • THURSDAY: Thursday
  • FRIDAY: Friday
  • SATURDAY: Saturday
  • SUNDAY: Sunday Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#day RedisInstance#day}

start_timeRequired 
start_time: RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime

start_time block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#start_time RedisInstance#start_time}

RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime

Initializer 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime(
  hours: typing.Union[int, float] = None,
  minutes: typing.Union[int, float] = None,
  nanos: typing.Union[int, float] = None,
  seconds: typing.Union[int, float] = None
)

Properties

Name Type Description
hours typing.Union[int, float] Hours of day in 24 hour format.
minutes typing.Union[int, float] Minutes of hour of day. Must be from 0 to 59.
nanos typing.Union[int, float] Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
seconds typing.Union[int, float] Seconds of minutes of the time.
hoursOptional 
hours: typing.Union[int, float]
  • Type: typing.Union[int, float]

Hours of day in 24 hour format.

Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#hours RedisInstance#hours}

minutesOptional 
minutes: typing.Union[int, float]
  • Type: typing.Union[int, float]

Minutes of hour of day. Must be from 0 to 59.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#minutes RedisInstance#minutes}

nanosOptional 
nanos: typing.Union[int, float]
  • Type: typing.Union[int, float]

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#nanos RedisInstance#nanos}

secondsOptional 
seconds: typing.Union[int, float]
  • Type: typing.Union[int, float]

Seconds of minutes of the time.

Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#seconds RedisInstance#seconds}

RedisInstanceMaintenanceSchedule

Initializer 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceMaintenanceSchedule()

RedisInstanceNodes

Initializer 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceNodes()

RedisInstancePersistenceConfig

Initializer 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstancePersistenceConfig(
  persistence_mode: str = None,
  rdb_snapshot_period: str = None,
  rdb_snapshot_start_time: str = None
)

Properties

Name Type Description
persistence_mode str Optional. Controls whether Persistence features are enabled. If not provided, the existing value will be used.
rdb_snapshot_period str Optional. Available snapshot periods for scheduling.
rdb_snapshot_start_time str Optional.
persistence_modeOptional 
persistence_mode: str
  • Type: str

Optional. Controls whether Persistence features are enabled. If not provided, the existing value will be used.

  • DISABLED: Persistence is disabled for the instance, and any existing snapshots are deleted.
  • RDB: RDB based Persistence is enabled. Possible values: ["DISABLED", "RDB"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#persistence_mode RedisInstance#persistence_mode}

rdb_snapshot_periodOptional 
rdb_snapshot_period: str
  • Type: str

Optional. Available snapshot periods for scheduling.

  • ONE_HOUR: Snapshot every 1 hour.
  • SIX_HOURS: Snapshot every 6 hours.
  • TWELVE_HOURS: Snapshot every 12 hours.
  • TWENTY_FOUR_HOURS: Snapshot every 24 hours. Possible values: ["ONE_HOUR", "SIX_HOURS", "TWELVE_HOURS", "TWENTY_FOUR_HOURS"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#rdb_snapshot_period RedisInstance#rdb_snapshot_period}

rdb_snapshot_start_timeOptional 
rdb_snapshot_start_time: str
  • Type: str

Optional.

Date and time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#rdb_snapshot_start_time RedisInstance#rdb_snapshot_start_time}

RedisInstanceServerCaCerts

Initializer 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceServerCaCerts()

RedisInstanceTimeouts

Initializer 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceTimeouts(
  create: str = None,
  delete: str = None,
  update: str = None
)

Properties

Name Type Description
create str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#create RedisInstance#create}.
delete str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#delete RedisInstance#delete}.
update str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#update RedisInstance#update}.
createOptional 
create: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#create RedisInstance#create}.

deleteOptional 
delete: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#delete RedisInstance#delete}.

updateOptional 
update: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#update RedisInstance#update}.

Classes

RedisInstanceMaintenancePolicyOutputReference

Initializers 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceMaintenancePolicyOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
put_weekly_maintenance_window No description.
reset_description No description.
reset_weekly_maintenance_window No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

put_weekly_maintenance_window 
def put_weekly_maintenance_window(
  value: typing.Union[IResolvable, typing.List[RedisInstanceMaintenancePolicyWeeklyMaintenanceWindow]]
) -> None
valueRequired
reset_description 
def reset_description() -> None
reset_weekly_maintenance_window 
def reset_weekly_maintenance_window() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
create_time str No description.
update_time str No description.
weekly_maintenance_window RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowList No description.
description_input str No description.
weekly_maintenance_window_input typing.Union[cdktf.IResolvable, typing.List[RedisInstanceMaintenancePolicyWeeklyMaintenanceWindow]] No description.
description str No description.
internal_value RedisInstanceMaintenancePolicy No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
create_timeRequired 
create_time: str
  • Type: str
update_timeRequired 
update_time: str
  • Type: str
weekly_maintenance_windowRequired 
weekly_maintenance_window: RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowList
description_inputOptional 
description_input: str
  • Type: str
weekly_maintenance_window_inputOptional 
weekly_maintenance_window_input: typing.Union[IResolvable, typing.List[RedisInstanceMaintenancePolicyWeeklyMaintenanceWindow]]
descriptionRequired 
description: str
  • Type: str
internal_valueOptional 
internal_value: RedisInstanceMaintenancePolicy

RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowList

Initializers 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
internal_value typing.Union[cdktf.IResolvable, typing.List[RedisInstanceMaintenancePolicyWeeklyMaintenanceWindow]] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, typing.List[RedisInstanceMaintenancePolicyWeeklyMaintenanceWindow]]

RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowOutputReference

Initializers 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

complex_object_indexRequired
  • Type: typing.Union[int, float]

the index of this item in the list.

complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
put_start_time No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

put_start_time 
def put_start_time(
  hours: typing.Union[int, float] = None,
  minutes: typing.Union[int, float] = None,
  nanos: typing.Union[int, float] = None,
  seconds: typing.Union[int, float] = None
) -> None
hoursOptional
  • Type: typing.Union[int, float]

Hours of day in 24 hour format.

Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#hours RedisInstance#hours}

minutesOptional
  • Type: typing.Union[int, float]

Minutes of hour of day. Must be from 0 to 59.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#minutes RedisInstance#minutes}

nanosOptional
  • Type: typing.Union[int, float]

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#nanos RedisInstance#nanos}

secondsOptional
  • Type: typing.Union[int, float]

Seconds of minutes of the time.

Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.34.0/docs/resources/redis_instance#seconds RedisInstance#seconds}

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
duration str No description.
start_time RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTimeOutputReference No description.
day_input str No description.
start_time_input RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime No description.
day str No description.
internal_value typing.Union[cdktf.IResolvable, RedisInstanceMaintenancePolicyWeeklyMaintenanceWindow] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
durationRequired 
duration: str
  • Type: str
start_timeRequired 
start_time: RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTimeOutputReference
day_inputOptional 
day_input: str
  • Type: str
start_time_inputOptional 
start_time_input: RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime
dayRequired 
day: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, RedisInstanceMaintenancePolicyWeeklyMaintenanceWindow]

RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTimeOutputReference

Initializers 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTimeOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_hours No description.
reset_minutes No description.
reset_nanos No description.
reset_seconds No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_hours 
def reset_hours() -> None
reset_minutes 
def reset_minutes() -> None
reset_nanos 
def reset_nanos() -> None
reset_seconds 
def reset_seconds() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
hours_input typing.Union[int, float] No description.
minutes_input typing.Union[int, float] No description.
nanos_input typing.Union[int, float] No description.
seconds_input typing.Union[int, float] No description.
hours typing.Union[int, float] No description.
minutes typing.Union[int, float] No description.
nanos typing.Union[int, float] No description.
seconds typing.Union[int, float] No description.
internal_value RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
hours_inputOptional 
hours_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
minutes_inputOptional 
minutes_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
nanos_inputOptional 
nanos_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
seconds_inputOptional 
seconds_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
hoursRequired 
hours: typing.Union[int, float]
  • Type: typing.Union[int, float]
minutesRequired 
minutes: typing.Union[int, float]
  • Type: typing.Union[int, float]
nanosRequired 
nanos: typing.Union[int, float]
  • Type: typing.Union[int, float]
secondsRequired 
seconds: typing.Union[int, float]
  • Type: typing.Union[int, float]
internal_valueOptional 
internal_value: RedisInstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime

RedisInstanceMaintenanceScheduleList

Initializers 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceMaintenanceScheduleList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> RedisInstanceMaintenanceScheduleOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str

RedisInstanceMaintenanceScheduleOutputReference

Initializers 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceMaintenanceScheduleOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

complex_object_indexRequired
  • Type: typing.Union[int, float]

the index of this item in the list.

complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
end_time str No description.
schedule_deadline_time str No description.
start_time str No description.
internal_value RedisInstanceMaintenanceSchedule No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
end_timeRequired 
end_time: str
  • Type: str
schedule_deadline_timeRequired 
schedule_deadline_time: str
  • Type: str
start_timeRequired 
start_time: str
  • Type: str
internal_valueOptional 
internal_value: RedisInstanceMaintenanceSchedule

RedisInstanceNodesList

Initializers 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceNodesList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> RedisInstanceNodesOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str

RedisInstanceNodesOutputReference

Initializers 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceNodesOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

complex_object_indexRequired
  • Type: typing.Union[int, float]

the index of this item in the list.

complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
id str No description.
zone str No description.
internal_value RedisInstanceNodes No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
idRequired 
id: str
  • Type: str
zoneRequired 
zone: str
  • Type: str
internal_valueOptional 
internal_value: RedisInstanceNodes

RedisInstancePersistenceConfigOutputReference

Initializers 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstancePersistenceConfigOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_persistence_mode No description.
reset_rdb_snapshot_period No description.
reset_rdb_snapshot_start_time No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_persistence_mode 
def reset_persistence_mode() -> None
reset_rdb_snapshot_period 
def reset_rdb_snapshot_period() -> None
reset_rdb_snapshot_start_time 
def reset_rdb_snapshot_start_time() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
rdb_next_snapshot_time str No description.
persistence_mode_input str No description.
rdb_snapshot_period_input str No description.
rdb_snapshot_start_time_input str No description.
persistence_mode str No description.
rdb_snapshot_period str No description.
rdb_snapshot_start_time str No description.
internal_value RedisInstancePersistenceConfig No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
rdb_next_snapshot_timeRequired 
rdb_next_snapshot_time: str
  • Type: str
persistence_mode_inputOptional 
persistence_mode_input: str
  • Type: str
rdb_snapshot_period_inputOptional 
rdb_snapshot_period_input: str
  • Type: str
rdb_snapshot_start_time_inputOptional 
rdb_snapshot_start_time_input: str
  • Type: str
persistence_modeRequired 
persistence_mode: str
  • Type: str
rdb_snapshot_periodRequired 
rdb_snapshot_period: str
  • Type: str
rdb_snapshot_start_timeRequired 
rdb_snapshot_start_time: str
  • Type: str
internal_valueOptional 
internal_value: RedisInstancePersistenceConfig

RedisInstanceServerCaCertsList

Initializers 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceServerCaCertsList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> RedisInstanceServerCaCertsOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str

RedisInstanceServerCaCertsOutputReference

Initializers 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceServerCaCertsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

complex_object_indexRequired
  • Type: typing.Union[int, float]

the index of this item in the list.

complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
cert str No description.
create_time str No description.
expire_time str No description.
serial_number str No description.
sha1_fingerprint str No description.
internal_value RedisInstanceServerCaCerts No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
certRequired 
cert: str
  • Type: str
create_timeRequired 
create_time: str
  • Type: str
expire_timeRequired 
expire_time: str
  • Type: str
serial_numberRequired 
serial_number: str
  • Type: str
sha1_fingerprintRequired 
sha1_fingerprint: str
  • Type: str
internal_valueOptional 
internal_value: RedisInstanceServerCaCerts

RedisInstanceTimeoutsOutputReference

Initializers 

from cdktf_cdktf_provider_google import redis_instance

redisInstance.RedisInstanceTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_create No description.
reset_delete No description.
reset_update No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_create 
def reset_create() -> None
reset_delete 
def reset_delete() -> None
reset_update 
def reset_update() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
create_input str No description.
delete_input str No description.
update_input str No description.
create str No description.
delete str No description.
update str No description.
internal_value typing.Union[cdktf.IResolvable, RedisInstanceTimeouts] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
create_inputOptional 
create_input: str
  • Type: str
delete_inputOptional 
delete_input: str
  • Type: str
update_inputOptional 
update_input: str
  • Type: str
createRequired 
create: str
  • Type: str
deleteRequired 
delete: str
  • Type: str
updateRequired 
update: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, RedisInstanceTimeouts]