pulumi-gcp-kotlin/com.pulumi.gcp.compute.kotlin/ComputeFunctions

ComputeFunctions

object ComputeFunctions

Functions

Link copied to clipboard
suspend fun getAddress(argument: GetAddressPlainArgs): GetAddressResult

Get the IP address from a static address. For more information see the official API documentation.

suspend fun getAddress(argument: suspend GetAddressPlainArgsBuilder.() -> Unit): GetAddressResult
suspend fun getAddress(name: String, project: String? = null, region: String? = null): GetAddressResult
Link copied to clipboard
suspend fun getAddresses(argument: GetAddressesPlainArgs): GetAddressesResult

List IP addresses in a project. For more information see the official API list and aggregated list documentation.

suspend fun getAddresses(argument: suspend GetAddressesPlainArgsBuilder.() -> Unit): GetAddressesResult
suspend fun getAddresses(filter: String? = null, project: String? = null, region: String? = null): GetAddressesResult
Link copied to clipboard
suspend fun getBackendBucket(argument: GetBackendBucketPlainArgs): GetBackendBucketResult

Get information about a BackendBucket.

suspend fun getBackendBucket(argument: suspend GetBackendBucketPlainArgsBuilder.() -> Unit): GetBackendBucketResult
suspend fun getBackendBucket(name: String, project: String? = null): GetBackendBucketResult
Link copied to clipboard
Link copied to clipboard
suspend fun getBackendService(argument: GetBackendServicePlainArgs): GetBackendServiceResult

Provide access to a Backend Service's attribute. For more information see the official documentation and the API.

suspend fun getBackendService(argument: suspend GetBackendServicePlainArgsBuilder.() -> Unit): GetBackendServiceResult
suspend fun getBackendService(name: String, project: String? = null): GetBackendServiceResult
Link copied to clipboard
Link copied to clipboard
suspend fun getCertificate(argument: GetCertificatePlainArgs): GetCertificateResult

Get info about a Google Compute SSL Certificate from its name.

suspend fun getCertificate(argument: suspend GetCertificatePlainArgsBuilder.() -> Unit): GetCertificateResult
suspend fun getCertificate(name: String, project: String? = null): GetCertificateResult
Link copied to clipboard
suspend fun getDefaultServiceAccount(argument: GetDefaultServiceAccountPlainArgs): GetDefaultServiceAccountResult

Use this data source to retrieve default service account for this project

suspend fun getDefaultServiceAccount(project: String? = null): GetDefaultServiceAccountResult
suspend fun getDefaultServiceAccount(argument: suspend GetDefaultServiceAccountPlainArgsBuilder.() -> Unit): GetDefaultServiceAccountResult
Link copied to clipboard
suspend fun getDisk(argument: GetDiskPlainArgs): GetDiskResult

Get information about a Google Compute Persistent disks. the official documentation and its API.

suspend fun getDisk(argument: suspend GetDiskPlainArgsBuilder.() -> Unit): GetDiskResult
suspend fun getDisk(name: String, project: String? = null, zone: String? = null): GetDiskResult
Link copied to clipboard
suspend fun getDiskIamPolicy(argument: GetDiskIamPolicyPlainArgs): GetDiskIamPolicyResult

Retrieves the current IAM policy data for disk

suspend fun getDiskIamPolicy(argument: suspend GetDiskIamPolicyPlainArgsBuilder.() -> Unit): GetDiskIamPolicyResult
suspend fun getDiskIamPolicy(name: String, project: String? = null, zone: String? = null): GetDiskIamPolicyResult
Link copied to clipboard
suspend fun getForwardingRule(argument: GetForwardingRulePlainArgs): GetForwardingRuleResult

Get a forwarding rule within GCE from its name.

suspend fun getForwardingRule(argument: suspend GetForwardingRulePlainArgsBuilder.() -> Unit): GetForwardingRuleResult
suspend fun getForwardingRule(name: String, project: String? = null, region: String? = null): GetForwardingRuleResult
Link copied to clipboard
suspend fun getGlobalAddress(argument: GetGlobalAddressPlainArgs): GetGlobalAddressResult

Get the IP address from a static address reserved for a Global Forwarding Rule which are only used for HTTP load balancing. For more information see the official API documentation.

suspend fun getGlobalAddress(argument: suspend GetGlobalAddressPlainArgsBuilder.() -> Unit): GetGlobalAddressResult
suspend fun getGlobalAddress(name: String, project: String? = null): GetGlobalAddressResult
Link copied to clipboard
suspend fun getGlobalForwardingRule(argument: GetGlobalForwardingRulePlainArgs): GetGlobalForwardingRuleResult

Get a global forwarding rule within GCE from its name.

suspend fun getGlobalForwardingRule(argument: suspend GetGlobalForwardingRulePlainArgsBuilder.() -> Unit): GetGlobalForwardingRuleResult
suspend fun getGlobalForwardingRule(name: String, project: String? = null): GetGlobalForwardingRuleResult
Link copied to clipboard
suspend fun getHcVpnGateway(argument: GetHcVpnGatewayPlainArgs): GetHcVpnGatewayResult

Get a HA VPN Gateway within GCE from its name.

suspend fun getHcVpnGateway(argument: suspend GetHcVpnGatewayPlainArgsBuilder.() -> Unit): GetHcVpnGatewayResult
suspend fun getHcVpnGateway(name: String, project: String? = null, region: String? = null): GetHcVpnGatewayResult
Link copied to clipboard
suspend fun getHealthCheck(argument: GetHealthCheckPlainArgs): GetHealthCheckResult

Get information about a HealthCheck.

suspend fun getHealthCheck(argument: suspend GetHealthCheckPlainArgsBuilder.() -> Unit): GetHealthCheckResult
suspend fun getHealthCheck(name: String, project: String? = null): GetHealthCheckResult
Link copied to clipboard
suspend fun getImage(argument: GetImagePlainArgs): GetImageResult

Get information about a Google Compute Image. Check that your service account has the compute.imageUser role if you want to share custom images from another project. If you want to use pubimg, do not forget to specify the dedicated project. For more information see the official documentation and its API.

suspend fun getImage(argument: suspend GetImagePlainArgsBuilder.() -> Unit): GetImageResult
suspend fun getImage(family: String? = null, filter: String? = null, mostRecent: Boolean? = null, name: String? = null, project: String? = null): GetImageResult
Link copied to clipboard
suspend fun getImageIamPolicy(argument: GetImageIamPolicyPlainArgs): GetImageIamPolicyResult

Retrieves the current IAM policy data for image

suspend fun getImageIamPolicy(argument: suspend GetImageIamPolicyPlainArgsBuilder.() -> Unit): GetImageIamPolicyResult
suspend fun getImageIamPolicy(image: String, project: String? = null): GetImageIamPolicyResult
Link copied to clipboard
suspend fun getInstance(argument: GetInstancePlainArgs): GetInstanceResult

Get information about a VM instance resource within GCE. For more information see the official documentation and API.

suspend fun getInstance(argument: suspend GetInstancePlainArgsBuilder.() -> Unit): GetInstanceResult
suspend fun getInstance(name: String? = null, project: String? = null, selfLink: String? = null, zone: String? = null): GetInstanceResult
Link copied to clipboard
suspend fun getInstanceGroup(argument: GetInstanceGroupPlainArgs): GetInstanceGroupResult

Get a Compute Instance Group within GCE. For more information, see the official documentation and API

suspend fun getInstanceGroup(argument: suspend GetInstanceGroupPlainArgsBuilder.() -> Unit): GetInstanceGroupResult
suspend fun getInstanceGroup(name: String? = null, project: String? = null, selfLink: String? = null, zone: String? = null): GetInstanceGroupResult
Link copied to clipboard
suspend fun getInstanceGroupManager(argument: GetInstanceGroupManagerPlainArgs): GetInstanceGroupManagerResult

Get a Compute Instance Group Manager within GCE. For more information, see the official documentation and API

suspend fun getInstanceGroupManager(argument: suspend GetInstanceGroupManagerPlainArgsBuilder.() -> Unit): GetInstanceGroupManagerResult
suspend fun getInstanceGroupManager(name: String? = null, project: String? = null, selfLink: String? = null, zone: String? = null): GetInstanceGroupManagerResult
Link copied to clipboard
suspend fun getInstanceIamPolicy(argument: GetInstanceIamPolicyPlainArgs): GetInstanceIamPolicyResult

Retrieves the current IAM policy data for instance

suspend fun getInstanceIamPolicy(argument: suspend GetInstanceIamPolicyPlainArgsBuilder.() -> Unit): GetInstanceIamPolicyResult
suspend fun getInstanceIamPolicy(instanceName: String, project: String? = null, zone: String? = null): GetInstanceIamPolicyResult
Link copied to clipboard
suspend fun getInstanceSerialPort(argument: GetInstanceSerialPortPlainArgs): GetInstanceSerialPortResult

Get the serial port output from a Compute Instance. For more information see the official API documentation.

suspend fun getInstanceSerialPort(argument: suspend GetInstanceSerialPortPlainArgsBuilder.() -> Unit): GetInstanceSerialPortResult
suspend fun getInstanceSerialPort(instance: String, port: Int, project: String? = null, zone: String? = null): GetInstanceSerialPortResult
Link copied to clipboard
suspend fun getInstanceTemplate(argument: GetInstanceTemplatePlainArgs): GetInstanceTemplateResult

Get information about a VM instance template resource within GCE. For more information see the official documentation and API.

suspend fun getInstanceTemplate(argument: suspend GetInstanceTemplatePlainArgsBuilder.() -> Unit): GetInstanceTemplateResult
suspend fun getInstanceTemplate(filter: String? = null, mostRecent: Boolean? = null, name: String? = null, project: String? = null, selfLinkUnique: String? = null): GetInstanceTemplateResult
Link copied to clipboard
suspend fun getLBIPRanges(): GetLBIPRangesResult

Use this data source to access IP ranges in your firewall rules. https://cloud.google.com/compute/docs/load-balancing/health-checks#health_check_source_ips_and_firewall_rules

Link copied to clipboard
Link copied to clipboard
suspend fun getNetblockIPRanges(argument: GetNetblockIPRangesPlainArgs): GetNetblockIPRangesResult

Use this data source to get the IP addresses from different special IP ranges on Google Cloud Platform.

suspend fun getNetblockIPRanges(rangeType: String? = null): GetNetblockIPRangesResult
suspend fun getNetblockIPRanges(argument: suspend GetNetblockIPRangesPlainArgsBuilder.() -> Unit): GetNetblockIPRangesResult
Link copied to clipboard
suspend fun getNetwork(argument: GetNetworkPlainArgs): GetNetworkResult

Get a network within GCE from its name.

suspend fun getNetwork(argument: suspend GetNetworkPlainArgsBuilder.() -> Unit): GetNetworkResult
suspend fun getNetwork(name: String, project: String? = null): GetNetworkResult
Link copied to clipboard
suspend fun getNetworkEndpointGroup(argument: GetNetworkEndpointGroupPlainArgs): GetNetworkEndpointGroupResult

Use this data source to access a Network Endpoint Group's attributes. The NEG may be found by providing either a self_link, or a name and a zone.

suspend fun getNetworkEndpointGroup(argument: suspend GetNetworkEndpointGroupPlainArgsBuilder.() -> Unit): GetNetworkEndpointGroupResult
suspend fun getNetworkEndpointGroup(name: String? = null, project: String? = null, selfLink: String? = null, zone: String? = null): GetNetworkEndpointGroupResult
Link copied to clipboard
suspend fun getNetworkPeering(argument: GetNetworkPeeringPlainArgs): GetNetworkPeeringResult

Get information of a specified compute network peering. For more information see the official documentation and API.

suspend fun getNetworkPeering(argument: suspend GetNetworkPeeringPlainArgsBuilder.() -> Unit): GetNetworkPeeringResult
suspend fun getNetworkPeering(name: String, network: String): GetNetworkPeeringResult
Link copied to clipboard
suspend fun getNodeTypes(argument: GetNodeTypesPlainArgs): GetNodeTypesResult

Provides available node types for Compute Engine sole-tenant nodes in a zone for a given project. For more information, see the official documentation and API.

suspend fun getNodeTypes(argument: suspend GetNodeTypesPlainArgsBuilder.() -> Unit): GetNodeTypesResult
suspend fun getNodeTypes(project: String? = null, zone: String? = null): GetNodeTypesResult
Link copied to clipboard
Link copied to clipboard
suspend fun getRegionDiskIamPolicy(argument: GetRegionDiskIamPolicyPlainArgs): GetRegionDiskIamPolicyResult

Retrieves the current IAM policy data for regiondisk

suspend fun getRegionDiskIamPolicy(argument: suspend GetRegionDiskIamPolicyPlainArgsBuilder.() -> Unit): GetRegionDiskIamPolicyResult
suspend fun getRegionDiskIamPolicy(name: String, project: String? = null, region: String? = null): GetRegionDiskIamPolicyResult
Link copied to clipboard
suspend fun getRegionInstanceGroup(argument: GetRegionInstanceGroupPlainArgs): GetRegionInstanceGroupResult

Get a Compute Region Instance Group within GCE. For more information, see the official documentation and API.

suspend fun getRegionInstanceGroup(argument: suspend GetRegionInstanceGroupPlainArgsBuilder.() -> Unit): GetRegionInstanceGroupResult
suspend fun getRegionInstanceGroup(name: String? = null, project: String? = null, region: String? = null, selfLink: String? = null): GetRegionInstanceGroupResult
Link copied to clipboard
suspend fun getRegionInstanceTemplate(argument: GetRegionInstanceTemplatePlainArgs): GetRegionInstanceTemplateResult

Get information about a VM instance template resource within GCE. For more information see the official documentation and API.

suspend fun getRegionInstanceTemplate(argument: suspend GetRegionInstanceTemplatePlainArgsBuilder.() -> Unit): GetRegionInstanceTemplateResult
suspend fun getRegionInstanceTemplate(filter: String? = null, mostRecent: Boolean? = null, name: String? = null, project: String? = null, region: String? = null): GetRegionInstanceTemplateResult
Link copied to clipboard
suspend fun getRegionNetworkEndpointGroup(argument: GetRegionNetworkEndpointGroupPlainArgs): GetRegionNetworkEndpointGroupResult

Use this data source to access a Region Network Endpoint Group's attributes. The RNEG may be found by providing either a self_link, or a name and a region.

suspend fun getRegionNetworkEndpointGroup(argument: suspend GetRegionNetworkEndpointGroupPlainArgsBuilder.() -> Unit): GetRegionNetworkEndpointGroupResult
suspend fun getRegionNetworkEndpointGroup(name: String? = null, project: String? = null, region: String? = null, selfLink: String? = null): GetRegionNetworkEndpointGroupResult
Link copied to clipboard
suspend fun getRegions(argument: GetRegionsPlainArgs): GetRegionsResult

Provides access to available Google Compute regions for a given project. See more about regions and zones in the upstream docs.

suspend fun getRegions(argument: suspend GetRegionsPlainArgsBuilder.() -> Unit): GetRegionsResult
suspend fun getRegions(project: String? = null, status: String? = null): GetRegionsResult
Link copied to clipboard
suspend fun getRegionSslCertificate(argument: GetRegionSslCertificatePlainArgs): GetRegionSslCertificateResult

Get info about a Region Google Compute SSL Certificate from its name.

suspend fun getRegionSslCertificate(argument: suspend GetRegionSslCertificatePlainArgsBuilder.() -> Unit): GetRegionSslCertificateResult
suspend fun getRegionSslCertificate(name: String, project: String? = null, region: String? = null): GetRegionSslCertificateResult
Link copied to clipboard
suspend fun getResourcePolicy(argument: GetResourcePolicyPlainArgs): GetResourcePolicyResult

Provide access to a Resource Policy's attributes. For more information see the official documentation or the API.

suspend fun getResourcePolicy(argument: suspend GetResourcePolicyPlainArgsBuilder.() -> Unit): GetResourcePolicyResult
suspend fun getResourcePolicy(name: String, project: String? = null, region: String? = null): GetResourcePolicyResult
Link copied to clipboard
suspend fun getRouter(argument: GetRouterPlainArgs): GetRouterResult

Get a router within GCE from its name and VPC.

suspend fun getRouter(argument: suspend GetRouterPlainArgsBuilder.() -> Unit): GetRouterResult
suspend fun getRouter(name: String, network: String, project: String? = null, region: String? = null): GetRouterResult
Link copied to clipboard
suspend fun getRouterNat(argument: GetRouterNatPlainArgs): GetRouterNatResult

To get more information about Snapshot, see:

suspend fun getRouterNat(argument: suspend GetRouterNatPlainArgsBuilder.() -> Unit): GetRouterNatResult
suspend fun getRouterNat(name: String, project: String? = null, region: String? = null, router: String): GetRouterNatResult
Link copied to clipboard
suspend fun getRouterStatus(argument: GetRouterStatusPlainArgs): GetRouterStatusResult

Get a Cloud Router's status within GCE from its name and region. This data source exposes the routes learned by a Cloud Router via BGP peers. For more information see the official documentation and API.

suspend fun getRouterStatus(argument: suspend GetRouterStatusPlainArgsBuilder.() -> Unit): GetRouterStatusResult
suspend fun getRouterStatus(name: String, project: String? = null, region: String? = null): GetRouterStatusResult
Link copied to clipboard
suspend fun getSnapshot(argument: GetSnapshotPlainArgs): GetSnapshotResult

To get more information about Snapshot, see:

suspend fun getSnapshot(argument: suspend GetSnapshotPlainArgsBuilder.() -> Unit): GetSnapshotResult
suspend fun getSnapshot(filter: String? = null, mostRecent: Boolean? = null, name: String? = null, project: String? = null): GetSnapshotResult
Link copied to clipboard
suspend fun getSnapshotIamPolicy(argument: GetSnapshotIamPolicyPlainArgs): GetSnapshotIamPolicyResult

Retrieves the current IAM policy data for snapshot

suspend fun getSnapshotIamPolicy(argument: suspend GetSnapshotIamPolicyPlainArgsBuilder.() -> Unit): GetSnapshotIamPolicyResult
suspend fun getSnapshotIamPolicy(name: String, project: String? = null): GetSnapshotIamPolicyResult
Link copied to clipboard
suspend fun getSSLPolicy(argument: GetSSLPolicyPlainArgs): GetSSLPolicyResult

Gets an SSL Policy within GCE from its name, for use with Target HTTPS and Target SSL Proxies. For more information see the official documentation.

suspend fun getSSLPolicy(argument: suspend GetSSLPolicyPlainArgsBuilder.() -> Unit): GetSSLPolicyResult
suspend fun getSSLPolicy(name: String, project: String? = null): GetSSLPolicyResult
Link copied to clipboard
suspend fun getSubnetwork(argument: GetSubnetworkPlainArgs): GetSubnetworkResult

Get a subnetwork within GCE from its name and region.

suspend fun getSubnetwork(argument: suspend GetSubnetworkPlainArgsBuilder.() -> Unit): GetSubnetworkResult
suspend fun getSubnetwork(name: String? = null, project: String? = null, region: String? = null, selfLink: String? = null): GetSubnetworkResult
Link copied to clipboard
suspend fun getSubnetworkIamPolicy(argument: GetSubnetworkIamPolicyPlainArgs): GetSubnetworkIamPolicyResult

Retrieves the current IAM policy data for subnetwork

suspend fun getSubnetworkIamPolicy(argument: suspend GetSubnetworkIamPolicyPlainArgsBuilder.() -> Unit): GetSubnetworkIamPolicyResult
suspend fun getSubnetworkIamPolicy(project: String? = null, region: String? = null, subnetwork: String): GetSubnetworkIamPolicyResult
Link copied to clipboard
suspend fun getVPNGateway(argument: GetVPNGatewayPlainArgs): GetVPNGatewayResult

Get a VPN gateway within GCE from its name.

suspend fun getVPNGateway(argument: suspend GetVPNGatewayPlainArgsBuilder.() -> Unit): GetVPNGatewayResult
suspend fun getVPNGateway(name: String, project: String? = null, region: String? = null): GetVPNGatewayResult
Link copied to clipboard
suspend fun getZones(argument: GetZonesPlainArgs): GetZonesResult

Provides access to available Google Compute zones in a region for a given project. See more about regions and zones in the upstream docs.

suspend fun getZones(argument: suspend GetZonesPlainArgsBuilder.() -> Unit): GetZonesResult
suspend fun getZones(project: String? = null, region: String? = null, status: String? = null): GetZonesResult
Link copied to clipboard
suspend fun RouterStatus(argument: RouterStatusPlainArgs): RouterStatusResult

Get a Cloud Router's status within GCE from its name and region. This data source exposes the routes learned by a Cloud Router via BGP peers. For more information see the official documentation and API.

suspend fun RouterStatus(argument: suspend RouterStatusPlainArgsBuilder.() -> Unit): RouterStatusResult
suspend fun RouterStatus(name: String, project: String? = null, region: String? = null): RouterStatusResult