1. Packages
  2. Google Cloud Native
  3. API Docs
  4. file
  5. file/v1beta1
  6. getInstance

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.file/v1beta1.getInstance

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Gets the details of a specific instance.

    Using getInstance

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
    function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>
    def get_instance(instance_id: Optional[str] = None,
                     location: Optional[str] = None,
                     project: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetInstanceResult
    def get_instance_output(instance_id: Optional[pulumi.Input[str]] = None,
                     location: Optional[pulumi.Input[str]] = None,
                     project: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]
    func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
    func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

    > Note: This function is named LookupInstance in the Go SDK.

    public static class GetInstance 
    {
        public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
        public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: google-native:file/v1beta1:getInstance
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceId string
    Location string
    Project string
    InstanceId string
    Location string
    Project string
    instanceId String
    location String
    project String
    instanceId string
    location string
    project string
    instanceId String
    location String
    project String

    getInstance Result

    The following output properties are available:

    CapacityGb string
    The storage capacity of the instance in gigabytes (GB = 1024^3 bytes). This capacity can be increased up to max_capacity_gb GB in multipliers of capacity_step_size_gb GB.
    CapacityStepSizeGb string
    The increase/decrease capacity step size.
    CreateTime string
    The time when the instance was created.
    Description string
    The description of the instance (2048 characters or less).
    DirectoryServices Pulumi.GoogleNative.File.V1Beta1.Outputs.DirectoryServicesConfigResponse
    Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1".
    Etag string
    Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
    FileShares List<Pulumi.GoogleNative.File.V1Beta1.Outputs.FileShareConfigResponse>
    File system shares on the instance. For this version, only a single file share is supported.
    KmsKeyName string
    KMS key name used for data encryption.
    Labels Dictionary<string, string>
    Resource labels to represent user provided metadata.
    MaxCapacityGb string
    The max capacity of the instance.
    MaxShareCount string
    The max number of shares allowed.
    MultiShareEnabled bool
    Indicates whether this instance uses a multi-share configuration with which it can have more than one file-share or none at all. File-shares are added, updated and removed through the separate file-share APIs.
    Name string
    The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
    Networks List<Pulumi.GoogleNative.File.V1Beta1.Outputs.NetworkConfigResponse>
    VPC networks to which the instance is connected. For this version, only a single network is supported.
    Protocol string
    Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: NFS_V3.
    SatisfiesPzs bool
    Reserved for future use.
    State string
    The instance state.
    StatusMessage string
    Additional information about the instance state, if available.
    SuspensionReasons List<string>
    Field indicates all the reasons the instance is in "SUSPENDED" state.
    Tier string
    The service tier of the instance.
    CapacityGb string
    The storage capacity of the instance in gigabytes (GB = 1024^3 bytes). This capacity can be increased up to max_capacity_gb GB in multipliers of capacity_step_size_gb GB.
    CapacityStepSizeGb string
    The increase/decrease capacity step size.
    CreateTime string
    The time when the instance was created.
    Description string
    The description of the instance (2048 characters or less).
    DirectoryServices DirectoryServicesConfigResponse
    Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1".
    Etag string
    Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
    FileShares []FileShareConfigResponse
    File system shares on the instance. For this version, only a single file share is supported.
    KmsKeyName string
    KMS key name used for data encryption.
    Labels map[string]string
    Resource labels to represent user provided metadata.
    MaxCapacityGb string
    The max capacity of the instance.
    MaxShareCount string
    The max number of shares allowed.
    MultiShareEnabled bool
    Indicates whether this instance uses a multi-share configuration with which it can have more than one file-share or none at all. File-shares are added, updated and removed through the separate file-share APIs.
    Name string
    The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
    Networks []NetworkConfigResponse
    VPC networks to which the instance is connected. For this version, only a single network is supported.
    Protocol string
    Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: NFS_V3.
    SatisfiesPzs bool
    Reserved for future use.
    State string
    The instance state.
    StatusMessage string
    Additional information about the instance state, if available.
    SuspensionReasons []string
    Field indicates all the reasons the instance is in "SUSPENDED" state.
    Tier string
    The service tier of the instance.
    capacityGb String
    The storage capacity of the instance in gigabytes (GB = 1024^3 bytes). This capacity can be increased up to max_capacity_gb GB in multipliers of capacity_step_size_gb GB.
    capacityStepSizeGb String
    The increase/decrease capacity step size.
    createTime String
    The time when the instance was created.
    description String
    The description of the instance (2048 characters or less).
    directoryServices DirectoryServicesConfigResponse
    Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1".
    etag String
    Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
    fileShares List<FileShareConfigResponse>
    File system shares on the instance. For this version, only a single file share is supported.
    kmsKeyName String
    KMS key name used for data encryption.
    labels Map<String,String>
    Resource labels to represent user provided metadata.
    maxCapacityGb String
    The max capacity of the instance.
    maxShareCount String
    The max number of shares allowed.
    multiShareEnabled Boolean
    Indicates whether this instance uses a multi-share configuration with which it can have more than one file-share or none at all. File-shares are added, updated and removed through the separate file-share APIs.
    name String
    The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
    networks List<NetworkConfigResponse>
    VPC networks to which the instance is connected. For this version, only a single network is supported.
    protocol String
    Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: NFS_V3.
    satisfiesPzs Boolean
    Reserved for future use.
    state String
    The instance state.
    statusMessage String
    Additional information about the instance state, if available.
    suspensionReasons List<String>
    Field indicates all the reasons the instance is in "SUSPENDED" state.
    tier String
    The service tier of the instance.
    capacityGb string
    The storage capacity of the instance in gigabytes (GB = 1024^3 bytes). This capacity can be increased up to max_capacity_gb GB in multipliers of capacity_step_size_gb GB.
    capacityStepSizeGb string
    The increase/decrease capacity step size.
    createTime string
    The time when the instance was created.
    description string
    The description of the instance (2048 characters or less).
    directoryServices DirectoryServicesConfigResponse
    Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1".
    etag string
    Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
    fileShares FileShareConfigResponse[]
    File system shares on the instance. For this version, only a single file share is supported.
    kmsKeyName string
    KMS key name used for data encryption.
    labels {[key: string]: string}
    Resource labels to represent user provided metadata.
    maxCapacityGb string
    The max capacity of the instance.
    maxShareCount string
    The max number of shares allowed.
    multiShareEnabled boolean
    Indicates whether this instance uses a multi-share configuration with which it can have more than one file-share or none at all. File-shares are added, updated and removed through the separate file-share APIs.
    name string
    The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
    networks NetworkConfigResponse[]
    VPC networks to which the instance is connected. For this version, only a single network is supported.
    protocol string
    Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: NFS_V3.
    satisfiesPzs boolean
    Reserved for future use.
    state string
    The instance state.
    statusMessage string
    Additional information about the instance state, if available.
    suspensionReasons string[]
    Field indicates all the reasons the instance is in "SUSPENDED" state.
    tier string
    The service tier of the instance.
    capacity_gb str
    The storage capacity of the instance in gigabytes (GB = 1024^3 bytes). This capacity can be increased up to max_capacity_gb GB in multipliers of capacity_step_size_gb GB.
    capacity_step_size_gb str
    The increase/decrease capacity step size.
    create_time str
    The time when the instance was created.
    description str
    The description of the instance (2048 characters or less).
    directory_services DirectoryServicesConfigResponse
    Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1".
    etag str
    Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
    file_shares Sequence[FileShareConfigResponse]
    File system shares on the instance. For this version, only a single file share is supported.
    kms_key_name str
    KMS key name used for data encryption.
    labels Mapping[str, str]
    Resource labels to represent user provided metadata.
    max_capacity_gb str
    The max capacity of the instance.
    max_share_count str
    The max number of shares allowed.
    multi_share_enabled bool
    Indicates whether this instance uses a multi-share configuration with which it can have more than one file-share or none at all. File-shares are added, updated and removed through the separate file-share APIs.
    name str
    The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
    networks Sequence[NetworkConfigResponse]
    VPC networks to which the instance is connected. For this version, only a single network is supported.
    protocol str
    Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: NFS_V3.
    satisfies_pzs bool
    Reserved for future use.
    state str
    The instance state.
    status_message str
    Additional information about the instance state, if available.
    suspension_reasons Sequence[str]
    Field indicates all the reasons the instance is in "SUSPENDED" state.
    tier str
    The service tier of the instance.
    capacityGb String
    The storage capacity of the instance in gigabytes (GB = 1024^3 bytes). This capacity can be increased up to max_capacity_gb GB in multipliers of capacity_step_size_gb GB.
    capacityStepSizeGb String
    The increase/decrease capacity step size.
    createTime String
    The time when the instance was created.
    description String
    The description of the instance (2048 characters or less).
    directoryServices Property Map
    Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1".
    etag String
    Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
    fileShares List<Property Map>
    File system shares on the instance. For this version, only a single file share is supported.
    kmsKeyName String
    KMS key name used for data encryption.
    labels Map<String>
    Resource labels to represent user provided metadata.
    maxCapacityGb String
    The max capacity of the instance.
    maxShareCount String
    The max number of shares allowed.
    multiShareEnabled Boolean
    Indicates whether this instance uses a multi-share configuration with which it can have more than one file-share or none at all. File-shares are added, updated and removed through the separate file-share APIs.
    name String
    The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
    networks List<Property Map>
    VPC networks to which the instance is connected. For this version, only a single network is supported.
    protocol String
    Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: NFS_V3.
    satisfiesPzs Boolean
    Reserved for future use.
    state String
    The instance state.
    statusMessage String
    Additional information about the instance state, if available.
    suspensionReasons List<String>
    Field indicates all the reasons the instance is in "SUSPENDED" state.
    tier String
    The service tier of the instance.

    Supporting Types

    DirectoryServicesConfigResponse

    ManagedActiveDirectory Pulumi.GoogleNative.File.V1Beta1.Inputs.ManagedActiveDirectoryConfigResponse
    Configuration for Managed Service for Microsoft Active Directory.
    ManagedActiveDirectory ManagedActiveDirectoryConfigResponse
    Configuration for Managed Service for Microsoft Active Directory.
    managedActiveDirectory ManagedActiveDirectoryConfigResponse
    Configuration for Managed Service for Microsoft Active Directory.
    managedActiveDirectory ManagedActiveDirectoryConfigResponse
    Configuration for Managed Service for Microsoft Active Directory.
    managed_active_directory ManagedActiveDirectoryConfigResponse
    Configuration for Managed Service for Microsoft Active Directory.
    managedActiveDirectory Property Map
    Configuration for Managed Service for Microsoft Active Directory.

    FileShareConfigResponse

    CapacityGb string
    File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes.
    Name string
    The name of the file share (must be 32 characters or less for Enterprise and High Scale SSD tiers and 16 characters or less for all other tiers).
    NfsExportOptions List<Pulumi.GoogleNative.File.V1Beta1.Inputs.NfsExportOptionsResponse>
    Nfs Export Options. There is a limit of 10 export options per file share.
    SourceBackup string
    The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.
    CapacityGb string
    File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes.
    Name string
    The name of the file share (must be 32 characters or less for Enterprise and High Scale SSD tiers and 16 characters or less for all other tiers).
    NfsExportOptions []NfsExportOptionsResponse
    Nfs Export Options. There is a limit of 10 export options per file share.
    SourceBackup string
    The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.
    capacityGb String
    File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes.
    name String
    The name of the file share (must be 32 characters or less for Enterprise and High Scale SSD tiers and 16 characters or less for all other tiers).
    nfsExportOptions List<NfsExportOptionsResponse>
    Nfs Export Options. There is a limit of 10 export options per file share.
    sourceBackup String
    The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.
    capacityGb string
    File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes.
    name string
    The name of the file share (must be 32 characters or less for Enterprise and High Scale SSD tiers and 16 characters or less for all other tiers).
    nfsExportOptions NfsExportOptionsResponse[]
    Nfs Export Options. There is a limit of 10 export options per file share.
    sourceBackup string
    The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.
    capacity_gb str
    File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes.
    name str
    The name of the file share (must be 32 characters or less for Enterprise and High Scale SSD tiers and 16 characters or less for all other tiers).
    nfs_export_options Sequence[NfsExportOptionsResponse]
    Nfs Export Options. There is a limit of 10 export options per file share.
    source_backup str
    The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.
    capacityGb String
    File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes.
    name String
    The name of the file share (must be 32 characters or less for Enterprise and High Scale SSD tiers and 16 characters or less for all other tiers).
    nfsExportOptions List<Property Map>
    Nfs Export Options. There is a limit of 10 export options per file share.
    sourceBackup String
    The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.

    ManagedActiveDirectoryConfigResponse

    Computer string
    The computer name is used as a prefix to the mount remote target. Example: if the computer_name is my-computer, the mount command will look like: $mount -o vers=4,sec=krb5 my-computer.filestore.:.
    Domain string
    Fully qualified domain name.
    Computer string
    The computer name is used as a prefix to the mount remote target. Example: if the computer_name is my-computer, the mount command will look like: $mount -o vers=4,sec=krb5 my-computer.filestore.:.
    Domain string
    Fully qualified domain name.
    computer String
    The computer name is used as a prefix to the mount remote target. Example: if the computer_name is my-computer, the mount command will look like: $mount -o vers=4,sec=krb5 my-computer.filestore.:.
    domain String
    Fully qualified domain name.
    computer string
    The computer name is used as a prefix to the mount remote target. Example: if the computer_name is my-computer, the mount command will look like: $mount -o vers=4,sec=krb5 my-computer.filestore.:.
    domain string
    Fully qualified domain name.
    computer str
    The computer name is used as a prefix to the mount remote target. Example: if the computer_name is my-computer, the mount command will look like: $mount -o vers=4,sec=krb5 my-computer.filestore.:.
    domain str
    Fully qualified domain name.
    computer String
    The computer name is used as a prefix to the mount remote target. Example: if the computer_name is my-computer, the mount command will look like: $mount -o vers=4,sec=krb5 my-computer.filestore.:.
    domain String
    Fully qualified domain name.

    NetworkConfigResponse

    ConnectMode string
    The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.
    IpAddresses List<string>
    IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or IPv6 addresses in the format {block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}.
    Modes List<string>
    Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
    Network string
    The name of the Google Compute Engine VPC network to which the instance is connected.
    ReservedIpRange string
    Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * Allocated IP address range when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the internal IP address ranges that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network.
    ConnectMode string
    The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.
    IpAddresses []string
    IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or IPv6 addresses in the format {block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}.
    Modes []string
    Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
    Network string
    The name of the Google Compute Engine VPC network to which the instance is connected.
    ReservedIpRange string
    Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * Allocated IP address range when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the internal IP address ranges that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network.
    connectMode String
    The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.
    ipAddresses List<String>
    IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or IPv6 addresses in the format {block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}.
    modes List<String>
    Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
    network String
    The name of the Google Compute Engine VPC network to which the instance is connected.
    reservedIpRange String
    Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * Allocated IP address range when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the internal IP address ranges that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network.
    connectMode string
    The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.
    ipAddresses string[]
    IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or IPv6 addresses in the format {block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}.
    modes string[]
    Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
    network string
    The name of the Google Compute Engine VPC network to which the instance is connected.
    reservedIpRange string
    Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * Allocated IP address range when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the internal IP address ranges that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network.
    connect_mode str
    The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.
    ip_addresses Sequence[str]
    IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or IPv6 addresses in the format {block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}.
    modes Sequence[str]
    Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
    network str
    The name of the Google Compute Engine VPC network to which the instance is connected.
    reserved_ip_range str
    Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * Allocated IP address range when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the internal IP address ranges that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network.
    connectMode String
    The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.
    ipAddresses List<String>
    IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or IPv6 addresses in the format {block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}.
    modes List<String>
    Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
    network String
    The name of the Google Compute Engine VPC network to which the instance is connected.
    reservedIpRange String
    Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * Allocated IP address range when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the internal IP address ranges that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network.

    NfsExportOptionsResponse

    AccessMode string
    Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
    AnonGid string
    An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
    AnonUid string
    An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
    IpRanges List<string>
    List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
    SecurityFlavors List<string>
    The security flavors allowed for mount operations. The default is AUTH_SYS.
    SquashMode string
    Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
    AccessMode string
    Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
    AnonGid string
    An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
    AnonUid string
    An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
    IpRanges []string
    List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
    SecurityFlavors []string
    The security flavors allowed for mount operations. The default is AUTH_SYS.
    SquashMode string
    Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
    accessMode String
    Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
    anonGid String
    An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
    anonUid String
    An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
    ipRanges List<String>
    List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
    securityFlavors List<String>
    The security flavors allowed for mount operations. The default is AUTH_SYS.
    squashMode String
    Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
    accessMode string
    Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
    anonGid string
    An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
    anonUid string
    An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
    ipRanges string[]
    List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
    securityFlavors string[]
    The security flavors allowed for mount operations. The default is AUTH_SYS.
    squashMode string
    Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
    access_mode str
    Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
    anon_gid str
    An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
    anon_uid str
    An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
    ip_ranges Sequence[str]
    List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
    security_flavors Sequence[str]
    The security flavors allowed for mount operations. The default is AUTH_SYS.
    squash_mode str
    Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
    accessMode String
    Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
    anonGid String
    An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
    anonUid String
    An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
    ipRanges List<String>
    List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
    securityFlavors List<String>
    The security flavors allowed for mount operations. The default is AUTH_SYS.
    squashMode String
    Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi