InstanceState class

Input properties used for looking up and filtering Instance resources.

Constructors

InstanceState({Input<String?>? aclPolicy, Input<String?>? authorizationMode, Input<InstanceAutomatedBackupConfig?>? automatedBackupConfig, Input<List<String>?>? availableMaintenanceVersions, Input<String?>? backupCollection, Input<String?>? createTime, Input<InstanceCrossInstanceReplicationConfig?>? crossInstanceReplicationConfig, Input<String?>? deletionPolicy, Input<bool?>? deletionProtectionEnabled, Input<List<InstanceDesiredAutoCreatedEndpoint>?>? desiredAutoCreatedEndpoints, Input<List<InstanceDesiredPscAutoConnection>?>? desiredPscAutoConnections, Input<List<InstanceDiscoveryEndpoint>?>? discoveryEndpoints, Input<Map<String, String>?>? effectiveLabels, Input<String?>? effectiveMaintenanceVersion, Input<List<InstanceEndpoint>?>? endpoints, Input<Map<String, String>?>? engineConfigs, Input<String?>? engineVersion, Input<InstanceGcsSource?>? gcsSource, Input<String?>? instanceId, Input<bool?>? isAclPolicyInSync, Input<String?>? kmsKey, Input<Map<String, String>?>? labels, Input<String?>? location, Input<InstanceMaintenancePolicy?>? maintenancePolicy, Input<List<InstanceMaintenanceSchedule>?>? maintenanceSchedules, Input<String?>? maintenanceVersion, Input<InstanceManagedBackupSource?>? managedBackupSource, Input<List<InstanceManagedServerCa>?>? managedServerCas, Input<String?>? mode, Input<String?>? name, Input<List<InstanceNodeConfig>?>? nodeConfigs, Input<String?>? nodeType, Input<InstancePersistenceConfig?>? persistenceConfig, Input<String?>? project, Input<List<InstancePscAttachmentDetail>?>? pscAttachmentDetails, Input<List<InstancePscAutoConnection>?>? pscAutoConnections, Input<Map<String, String>?>? pulumiLabels, Input<int?>? replicaCount, Input<String?>? serverCaMode, Input<String?>? serverCaPool, Input<int?>? shardCount, Input<String?>? state, Input<List<InstanceStateInfo>?>? stateInfos, Input<String?>? transitEncryptionMode, Input<String?>? uid, Input<String?>? updateTime, Input<InstanceZoneDistributionConfig?>? zoneDistributionConfig})
Creates a new InstanceState. aclPolicy The name of the ACL policy to attach to the instance. authorizationMode Optional. Immutable. Authorization mode of the instance. Possible values: automatedBackupConfig The automated backup config for a instance. availableMaintenanceVersions This field is used to determine the available maintenance versions for the self service update. backupCollection The backup collection full resource name. createTime Output only. Creation timestamp of the instance. crossInstanceReplicationConfig Cross instance replication config deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. deletionProtectionEnabled Optional. If set to true deletion of the instance will fail. desiredAutoCreatedEndpoints Immutable. User inputs for the auto-created endpoints connections. desiredPscAutoConnections desiredPscAutoConnections is deprecated Use desiredAutoCreatedEndpoints instead pulumi import will only work with desiredAutoCreatedEndpoints. [discoveryEndpoints] (Deprecated) [effectiveLabels] All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. [effectiveMaintenanceVersion] This field represents the actual maintenance version of the cluster. [endpoints] Endpoints for the instance. [engineConfigs] Optional. User-provided engine configurations for the instance. [engineVersion] Optional. Engine version of the instance. [gcsSource] GCS source for the instance. [instanceId] Required. The ID to use for the instance, which will become the final component of [isAclPolicyInSync] Whether the ACL policy is in sync with the cluster. [kmsKey] The KMS key used to encrypt the at-rest data of the cluster [labels] Optional. Labels to represent user-provided metadata. [location] Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource type memorystore.googleapis.com/CertificateAuthority`. maintenancePolicy Maintenance policy for a cluster maintenanceSchedules Upcoming maintenance schedule. maintenanceVersion This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the availableMaintenanceVersions field. managedBackupSource Managed backup source for the instance. managedServerCas Instance's Certificate Authority. This field will only be populated if instance's transitEncryptionMode is SERVER_AUTHENTICATION mode Optional. cluster or cluster-disabled. name Identifier. Unique name of the instance. nodeConfigs Represents configuration for nodes of the instance. nodeType Optional. Machine type for individual nodes of the instance. persistenceConfig Represents persistence configuration for a instance. project The ID of the project in which the resource belongs. pscAttachmentDetails Configuration of a service attachment of the cluster, for creating PSC connections. pscAutoConnections (Deprecated) pulumiLabels The combination of labels configured directly on the resource replicaCount Optional. Number of replica nodes per shard. If omitted the default is 0 replicas. serverCaMode The serverCaMode for the TLS enabled Memorystore instance. serverCaPool The resource name of the server CA pool for an instance with CUSTOMER_MANAGED_CAS_CA shardCount Required. Number of shards for the instance. state Output only. Current state of the instance. stateInfos Additional information about the state of the instance. transitEncryptionMode Optional. Immutable. In-transit encryption mode of the instance. uid Output only. System assigned, unique identifier for the instance. updateTime Output only. Latest update timestamp of the instance. zoneDistributionConfig Zone distribution configuration for allocation of instance resources.
const
InstanceState.fromMap(Map<String, dynamic> map)
factory

Properties

aclPolicy → Input<String?>?
The name of the ACL policy to attach to the instance. Format: projects/{project}/locations/{location}/aclPolicies/{acl_policy}
final
authorizationMode → Input<String?>?
Optional. Immutable. Authorization mode of the instance. Possible values: AUTH_DISABLED IAM_AUTH. TOKEN_AUTH is also supported, but only available in the google-beta provider.
final
automatedBackupConfig → Input<InstanceAutomatedBackupConfig?>?
The automated backup config for a instance. Structure is documented below.
final
availableMaintenanceVersions → Input<List<String>?>?
This field is used to determine the available maintenance versions for the self service update.
final
backupCollection → Input<String?>?
The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
final
createTime → Input<String?>?
Output only. Creation timestamp of the instance.
final
crossInstanceReplicationConfig → Input<InstanceCrossInstanceReplicationConfig?>?
Cross instance replication config Structure is documented below.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
deletionProtectionEnabled → Input<bool?>?
Optional. If set to true deletion of the instance will fail.
final
desiredAutoCreatedEndpoints → Input<List<InstanceDesiredAutoCreatedEndpoint>?>?
Immutable. User inputs for the auto-created endpoints connections.
final
desiredPscAutoConnections → Input<List<InstanceDesiredPscAutoConnection>?>?
desiredPscAutoConnections is deprecated Use desiredAutoCreatedEndpoints instead pulumi import will only work with desiredAutoCreatedEndpoints`.
final
discoveryEndpoints → Input<List<InstanceDiscoveryEndpoint>?>?
(Deprecated) Deprecated. Output only. Endpoints clients can connect to the instance through. Structure is documented below.
final
effectiveLabels → Input<Map<String, String>?>?
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
final
effectiveMaintenanceVersion → Input<String?>?
This field represents the actual maintenance version of the cluster.
final
endpoints → Input<List<InstanceEndpoint>?>?
Endpoints for the instance. Structure is documented below.
final
engineConfigs → Input<Map<String, String>?>?
Optional. User-provided engine configurations for the instance.
final
engineVersion → Input<String?>?
Optional. Engine version of the instance.
final
gcsSource → Input<InstanceGcsSource?>?
GCS source for the instance. Structure is documented below.
final
hashCode → int
The hash code for this object.
no setterinherited
instanceId → Input<String?>?
Required. The ID to use for the instance, which will become the final component of the instance's resource name. This value is subject to the following restrictions:
final
isAclPolicyInSync → Input<bool?>?
Whether the ACL policy is in sync with the cluster.
final
kmsKey → Input<String?>?
The KMS key used to encrypt the at-rest data of the cluster
final
labels → Input<Map<String, String>?>?
Optional. 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 effectiveLabels for all of the labels present on the resource.
final
location → Input<String?>?
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource type memorystore.googleapis.com/CertificateAuthority.
final
maintenancePolicy → Input<InstanceMaintenancePolicy?>?
Maintenance policy for a cluster Structure is documented below.
final
maintenanceSchedules → Input<List<InstanceMaintenanceSchedule>?>?
Upcoming maintenance schedule. Structure is documented below.
final
maintenanceVersion → Input<String?>?
This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the availableMaintenanceVersions field. Note: This field can only be specified when updating an existing cluster to a newer version. Downgrades are currently not supported!
final
managedBackupSource → Input<InstanceManagedBackupSource?>?
Managed backup source for the instance. Structure is documented below.
final
managedServerCas → Input<List<InstanceManagedServerCa>?>?
Instance's Certificate Authority. This field will only be populated if instance's transitEncryptionMode is SERVER_AUTHENTICATION Structure is documented below.
final
mode → Input<String?>?
Optional. cluster or cluster-disabled. Possible values: CLUSTER CLUSTER_DISABLED Possible values are: CLUSTER, CLUSTER_DISABLED.
final
name → Input<String?>?
Identifier. Unique name of the instance. Format: projects/{project}/locations/{location}/instances/{instance}
final
nodeConfigs → Input<List<InstanceNodeConfig>?>?
Represents configuration for nodes of the instance. Structure is documented below.
final
nodeType → Input<String?>?
Optional. Machine type for individual nodes of the instance. Possible values: SHARED_CORE_NANO CUSTOM_PICO CUSTOM_MICRO CUSTOM_MINI HIGHMEM_MEDIUM HIGHCPU_MEDIUM HIGHMEM_XLARGE STANDARD_SMALL STANDARD_LARGE HIGHMEM_2XLARGE
final
persistenceConfig → Input<InstancePersistenceConfig?>?
Represents persistence configuration for a instance. Structure is documented below.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
pscAttachmentDetails → Input<List<InstancePscAttachmentDetail>?>?
Configuration of a service attachment of the cluster, for creating PSC connections. Structure is documented below.
final
pscAutoConnections → Input<List<InstancePscAutoConnection>?>?
(Deprecated) Output only. User inputs and resource details of the auto-created PSC connections. Structure is documented below.
final
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
replicaCount → Input<int?>?
Optional. Number of replica nodes per shard. If omitted the default is 0 replicas.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serverCaMode → Input<String?>?
The serverCaMode for the TLS enabled Memorystore instance. If not provided, GOOGLE_MANAGED_PER_INSTANCE_CA will be used as default Possible values are: GOOGLE_MANAGED_PER_INSTANCE_CA, GOOGLE_MANAGED_SHARED_CA, CUSTOMER_MANAGED_CAS_CA, SERVER_CA_MODE_UNSPECIFIED.
final
serverCaPool → Input<String?>?
The resource name of the server CA pool for an instance with CUSTOMER_MANAGED_CAS_CA as the server_ca_mode. Format: projects/{project}/locations/{region}/caPools/{caPoolId}
final
shardCount → Input<int?>?
Required. Number of shards for the instance.
final
state → Input<String?>?
Output only. Current state of the instance. Possible values: CREATING ACTIVE UPDATING DELETING
final
stateInfos → Input<List<InstanceStateInfo>?>?
Additional information about the state of the instance. Structure is documented below.
final
transitEncryptionMode → Input<String?>?
Optional. Immutable. In-transit encryption mode of the instance. Possible values: TRANSIT_ENCRYPTION_DISABLED SERVER_AUTHENTICATION
final
uid → Input<String?>?
Output only. System assigned, unique identifier for the instance.
final
updateTime → Input<String?>?
Output only. Latest update timestamp of the instance.
final
zoneDistributionConfig → Input<InstanceZoneDistributionConfig?>?
Zone distribution configuration for allocation of instance resources. Structure is documented below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited