com.pulumi.gcp.netapp.kotlin.StoragePool.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.netapp.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map
/**
* Builder for [StoragePool].
*/
@PulumiTagMarker
public class StoragePoolResourceBuilder internal constructor() {
public var name: String? = null
public var args: StoragePoolArgs = StoragePoolArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend StoragePoolArgsBuilder.() -> Unit) {
val builder = StoragePoolArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): StoragePool {
val builtJavaResource = com.pulumi.gcp.netapp.StoragePool(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return StoragePool(builtJavaResource)
}
}
/**
* Storage pools act as containers for volumes. All volumes in a storage pool share the following information:
* * Location
* * Service level
* * Virtual Private Cloud (VPC) network
* * Active Directory policy
* * LDAP use for NFS volumes, if applicable
* * Customer-managed encryption key (CMEK) policy
* The capacity of the pool can be split up and assigned to volumes within the pool. Storage pools are a billable
* component of NetApp Volumes. Billing is based on the location, service level, and capacity allocated to a pool
* independent of consumption at the volume level.
* To get more information about storagePool, see:
* * [API documentation](https://cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.storagePools)
* * How-to Guides
* * [QUICKSTART_TITLE](https://cloud.google.com/netapp/volumes/docs/get-started/quickstarts/create-storage-pool)
* ## Example Usage
* ### Storage Pool Create
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* // Create a network or use datasource to reference existing network
* const peeringNetwork = new gcp.compute.Network("peering_network", {name: "test-network"});
* // Reserve a CIDR for NetApp Volumes to use
* // When using shared-VPCs, this resource needs to be created in host project
* const privateIpAlloc = new gcp.compute.GlobalAddress("private_ip_alloc", {
* name: "test-address",
* purpose: "VPC_PEERING",
* addressType: "INTERNAL",
* prefixLength: 16,
* network: peeringNetwork.id,
* });
* // Create a Private Service Access connection
* // When using shared-VPCs, this resource needs to be created in host project
* const _default = new gcp.servicenetworking.Connection("default", {
* network: peeringNetwork.id,
* service: "netapp.servicenetworking.goog",
* reservedPeeringRanges: [privateIpAlloc.name],
* });
* // Modify the PSA Connection to allow import/export of custom routes
* // When using shared-VPCs, this resource needs to be created in host project
* const routeUpdates = new gcp.compute.NetworkPeeringRoutesConfig("route_updates", {
* peering: _default.peering,
* network: peeringNetwork.name,
* importCustomRoutes: true,
* exportCustomRoutes: true,
* });
* // Create a storage pool
* // Create this resource in the project which is expected to own the volumes
* const testPool = new gcp.netapp.StoragePool("test_pool", {
* name: "test-pool",
* location: "us-central1",
* serviceLevel: "PREMIUM",
* capacityGib: "2048",
* network: peeringNetwork.id,
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* # Create a network or use datasource to reference existing network
* peering_network = gcp.compute.Network("peering_network", name="test-network")
* # Reserve a CIDR for NetApp Volumes to use
* # When using shared-VPCs, this resource needs to be created in host project
* private_ip_alloc = gcp.compute.GlobalAddress("private_ip_alloc",
* name="test-address",
* purpose="VPC_PEERING",
* address_type="INTERNAL",
* prefix_length=16,
* network=peering_network.id)
* # Create a Private Service Access connection
* # When using shared-VPCs, this resource needs to be created in host project
* default = gcp.servicenetworking.Connection("default",
* network=peering_network.id,
* service="netapp.servicenetworking.goog",
* reserved_peering_ranges=[private_ip_alloc.name])
* # Modify the PSA Connection to allow import/export of custom routes
* # When using shared-VPCs, this resource needs to be created in host project
* route_updates = gcp.compute.NetworkPeeringRoutesConfig("route_updates",
* peering=default.peering,
* network=peering_network.name,
* import_custom_routes=True,
* export_custom_routes=True)
* # Create a storage pool
* # Create this resource in the project which is expected to own the volumes
* test_pool = gcp.netapp.StoragePool("test_pool",
* name="test-pool",
* location="us-central1",
* service_level="PREMIUM",
* capacity_gib="2048",
* network=peering_network.id)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* // Create a network or use datasource to reference existing network
* var peeringNetwork = new Gcp.Compute.Network("peering_network", new()
* {
* Name = "test-network",
* });
* // Reserve a CIDR for NetApp Volumes to use
* // When using shared-VPCs, this resource needs to be created in host project
* var privateIpAlloc = new Gcp.Compute.GlobalAddress("private_ip_alloc", new()
* {
* Name = "test-address",
* Purpose = "VPC_PEERING",
* AddressType = "INTERNAL",
* PrefixLength = 16,
* Network = peeringNetwork.Id,
* });
* // Create a Private Service Access connection
* // When using shared-VPCs, this resource needs to be created in host project
* var @default = new Gcp.ServiceNetworking.Connection("default", new()
* {
* Network = peeringNetwork.Id,
* Service = "netapp.servicenetworking.goog",
* ReservedPeeringRanges = new[]
* {
* privateIpAlloc.Name,
* },
* });
* // Modify the PSA Connection to allow import/export of custom routes
* // When using shared-VPCs, this resource needs to be created in host project
* var routeUpdates = new Gcp.Compute.NetworkPeeringRoutesConfig("route_updates", new()
* {
* Peering = @default.Peering,
* Network = peeringNetwork.Name,
* ImportCustomRoutes = true,
* ExportCustomRoutes = true,
* });
* // Create a storage pool
* // Create this resource in the project which is expected to own the volumes
* var testPool = new Gcp.Netapp.StoragePool("test_pool", new()
* {
* Name = "test-pool",
* Location = "us-central1",
* ServiceLevel = "PREMIUM",
* CapacityGib = "2048",
* Network = peeringNetwork.Id,
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/netapp"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/servicenetworking"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* // Create a network or use datasource to reference existing network
* peeringNetwork, err := compute.NewNetwork(ctx, "peering_network", &compute.NetworkArgs{
* Name: pulumi.String("test-network"),
* })
* if err != nil {
* return err
* }
* // Reserve a CIDR for NetApp Volumes to use
* // When using shared-VPCs, this resource needs to be created in host project
* privateIpAlloc, err := compute.NewGlobalAddress(ctx, "private_ip_alloc", &compute.GlobalAddressArgs{
* Name: pulumi.String("test-address"),
* Purpose: pulumi.String("VPC_PEERING"),
* AddressType: pulumi.String("INTERNAL"),
* PrefixLength: pulumi.Int(16),
* Network: peeringNetwork.ID(),
* })
* if err != nil {
* return err
* }
* // Create a Private Service Access connection
* // When using shared-VPCs, this resource needs to be created in host project
* _, err = servicenetworking.NewConnection(ctx, "default", &servicenetworking.ConnectionArgs{
* Network: peeringNetwork.ID(),
* Service: pulumi.String("netapp.servicenetworking.goog"),
* ReservedPeeringRanges: pulumi.StringArray{
* privateIpAlloc.Name,
* },
* })
* if err != nil {
* return err
* }
* // Modify the PSA Connection to allow import/export of custom routes
* // When using shared-VPCs, this resource needs to be created in host project
* _, err = compute.NewNetworkPeeringRoutesConfig(ctx, "route_updates", &compute.NetworkPeeringRoutesConfigArgs{
* Peering: _default.Peering,
* Network: peeringNetwork.Name,
* ImportCustomRoutes: pulumi.Bool(true),
* ExportCustomRoutes: pulumi.Bool(true),
* })
* if err != nil {
* return err
* }
* // Create a storage pool
* // Create this resource in the project which is expected to own the volumes
* _, err = netapp.NewStoragePool(ctx, "test_pool", &netapp.StoragePoolArgs{
* Name: pulumi.String("test-pool"),
* Location: pulumi.String("us-central1"),
* ServiceLevel: pulumi.String("PREMIUM"),
* CapacityGib: pulumi.String("2048"),
* Network: peeringNetwork.ID(),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.gcp.compute.Network;
* import com.pulumi.gcp.compute.NetworkArgs;
* import com.pulumi.gcp.compute.GlobalAddress;
* import com.pulumi.gcp.compute.GlobalAddressArgs;
* import com.pulumi.gcp.servicenetworking.Connection;
* import com.pulumi.gcp.servicenetworking.ConnectionArgs;
* import com.pulumi.gcp.compute.NetworkPeeringRoutesConfig;
* import com.pulumi.gcp.compute.NetworkPeeringRoutesConfigArgs;
* import com.pulumi.gcp.netapp.StoragePool;
* import com.pulumi.gcp.netapp.StoragePoolArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* // Create a network or use datasource to reference existing network
* var peeringNetwork = new Network("peeringNetwork", NetworkArgs.builder()
* .name("test-network")
* .build());
* // Reserve a CIDR for NetApp Volumes to use
* // When using shared-VPCs, this resource needs to be created in host project
* var privateIpAlloc = new GlobalAddress("privateIpAlloc", GlobalAddressArgs.builder()
* .name("test-address")
* .purpose("VPC_PEERING")
* .addressType("INTERNAL")
* .prefixLength(16)
* .network(peeringNetwork.id())
* .build());
* // Create a Private Service Access connection
* // When using shared-VPCs, this resource needs to be created in host project
* var default_ = new Connection("default", ConnectionArgs.builder()
* .network(peeringNetwork.id())
* .service("netapp.servicenetworking.goog")
* .reservedPeeringRanges(privateIpAlloc.name())
* .build());
* // Modify the PSA Connection to allow import/export of custom routes
* // When using shared-VPCs, this resource needs to be created in host project
* var routeUpdates = new NetworkPeeringRoutesConfig("routeUpdates", NetworkPeeringRoutesConfigArgs.builder()
* .peering(default_.peering())
* .network(peeringNetwork.name())
* .importCustomRoutes(true)
* .exportCustomRoutes(true)
* .build());
* // Create a storage pool
* // Create this resource in the project which is expected to own the volumes
* var testPool = new StoragePool("testPool", StoragePoolArgs.builder()
* .name("test-pool")
* .location("us-central1")
* .serviceLevel("PREMIUM")
* .capacityGib("2048")
* .network(peeringNetwork.id())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* # Create a network or use datasource to reference existing network
* peeringNetwork:
* type: gcp:compute:Network
* name: peering_network
* properties:
* name: test-network
* # Reserve a CIDR for NetApp Volumes to use
* # When using shared-VPCs, this resource needs to be created in host project
* privateIpAlloc:
* type: gcp:compute:GlobalAddress
* name: private_ip_alloc
* properties:
* name: test-address
* purpose: VPC_PEERING
* addressType: INTERNAL
* prefixLength: 16
* network: ${peeringNetwork.id}
* # Create a Private Service Access connection
* # When using shared-VPCs, this resource needs to be created in host project
* default:
* type: gcp:servicenetworking:Connection
* properties:
* network: ${peeringNetwork.id}
* service: netapp.servicenetworking.goog
* reservedPeeringRanges:
* - ${privateIpAlloc.name}
* # Modify the PSA Connection to allow import/export of custom routes
* # When using shared-VPCs, this resource needs to be created in host project
* routeUpdates:
* type: gcp:compute:NetworkPeeringRoutesConfig
* name: route_updates
* properties:
* peering: ${default.peering}
* network: ${peeringNetwork.name}
* importCustomRoutes: true
* exportCustomRoutes: true
* # Create a storage pool
* # Create this resource in the project which is expected to own the volumes
* testPool:
* type: gcp:netapp:StoragePool
* name: test_pool
* properties:
* name: test-pool
* location: us-central1
* serviceLevel: PREMIUM
* capacityGib: '2048'
* network: ${peeringNetwork.id}
* ```
*
* ## Import
* storagePool can be imported using any of these accepted formats:
* * `projects/{{project}}/locations/{{location}}/storagePools/{{name}}`
* * `{{project}}/{{location}}/{{name}}`
* * `{{location}}/{{name}}`
* When using the `pulumi import` command, storagePool can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:netapp/storagePool:StoragePool default projects/{{project}}/locations/{{location}}/storagePools/{{name}}
* ```
* ```sh
* $ pulumi import gcp:netapp/storagePool:StoragePool default {{project}}/{{location}}/{{name}}
* ```
* ```sh
* $ pulumi import gcp:netapp/storagePool:StoragePool default {{location}}/{{name}}
* ```
*/
public class StoragePool internal constructor(
override val javaResource: com.pulumi.gcp.netapp.StoragePool,
) : KotlinCustomResource(javaResource, StoragePoolMapper) {
/**
* Specifies the Active Directory policy to be used. Format: `projects/{{project}}/locations/{{location}}/activeDirectories/{{name}}`.
* The policy needs to be in the same location as the storage pool.
*/
public val activeDirectory: Output?
get() = javaResource.activeDirectory().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Capacity of the storage pool (in GiB).
*/
public val capacityGib: Output
get() = javaResource.capacityGib().applyValue({ args0 -> args0 })
/**
* An optional description of this resource.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
public val effectiveLabels: Output>
get() = javaResource.effectiveLabels().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* Reports if volumes in the pool are encrypted using a Google-managed encryption key or CMEK.
*/
public val encryptionType: Output
get() = javaResource.encryptionType().applyValue({ args0 -> args0 })
/**
* Specifies the CMEK policy to be used for volume encryption. Format: `projects/{{project}}/locations/{{location}}/kmsConfigs/{{name}}`.
* The policy needs to be in the same location as the storage pool.
*/
public val kmsConfig: Output?
get() = javaResource.kmsConfig().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Labels as key value pairs. Example: `{ "owner": "Bob", "department": "finance", "purpose": "testing" }`.
* **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.
*/
public val labels: Output>?
get() = javaResource.labels().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* When enabled, the volumes uses Active Directory as LDAP name service for UID/GID lookups. Required to enable extended group support for NFSv3,
* using security identifiers for NFSv4.1 or principal names for kerberized NFSv4.1.
*/
public val ldapEnabled: Output?
get() = javaResource.ldapEnabled().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Name of the location. Usually a region name, expect for some STANDARD service level pools which require a zone name.
*/
public val location: Output
get() = javaResource.location().applyValue({ args0 -> args0 })
/**
* The resource name of the storage pool. Needs to be unique per location.
* - - -
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* VPC network name with format: `projects/{{project}}/global/networks/{{network}}`
*/
public val network: Output
get() = javaResource.network().applyValue({ args0 -> args0 })
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
public val project: Output
get() = javaResource.project().applyValue({ args0 -> args0 })
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
public val pulumiLabels: Output>
get() = javaResource.pulumiLabels().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* Service level of the storage pool.
* Possible values are: `PREMIUM`, `EXTREME`, `STANDARD`, `FLEX`.
*/
public val serviceLevel: Output
get() = javaResource.serviceLevel().applyValue({ args0 -> args0 })
/**
* Size allocated to volumes in the storage pool (in GiB).
*/
public val volumeCapacityGib: Output
get() = javaResource.volumeCapacityGib().applyValue({ args0 -> args0 })
/**
* Number of volume in the storage pool.
*/
public val volumeCount: Output
get() = javaResource.volumeCount().applyValue({ args0 -> args0 })
}
public object StoragePoolMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.netapp.StoragePool::class == javaResource::class
override fun map(javaResource: Resource): StoragePool = StoragePool(
javaResource as
com.pulumi.gcp.netapp.StoragePool,
)
}
/**
* @see [StoragePool].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [StoragePool].
*/
public suspend fun storagePool(name: String, block: suspend StoragePoolResourceBuilder.() -> Unit): StoragePool {
val builder = StoragePoolResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [StoragePool].
* @param name The _unique_ name of the resulting resource.
*/
public fun storagePool(name: String): StoragePool {
val builder = StoragePoolResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy