com.pulumi.alicloud.cen.kotlin.RouteService.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-alicloud-kotlin Show documentation
Show all versions of pulumi-alicloud-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.alicloud.cen.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.String
import kotlin.Suppress
import kotlin.Unit
/**
* Builder for [RouteService].
*/
@PulumiTagMarker
public class RouteServiceResourceBuilder internal constructor() {
public var name: String? = null
public var args: RouteServiceArgs = RouteServiceArgs()
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 RouteServiceArgsBuilder.() -> Unit) {
val builder = RouteServiceArgsBuilder()
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(): RouteService {
val builtJavaResource = com.pulumi.alicloud.cen.RouteService(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return RouteService(builtJavaResource)
}
}
/**
* Provides a CEN Route Service resource. The virtual border routers (VBRs) and Cloud Connect Network (CCN) instances attached to Cloud Enterprise Network (CEN) instances can access the cloud services deployed in VPCs through the CEN instances.
* For information about CEN Route Service and how to use it, see [What is Route Service](https://www.alibabacloud.com/help/en/cen/developer-reference/api-cbn-2017-09-12-resolveandrouteserviceincen).
* > **NOTE:** Available since v1.99.0.
* > **NOTE:** Ensure that at least one VPC in the selected region is attached to the CEN instance.
* ## Example Usage
* Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as alicloud from "@pulumi/alicloud";
* const default = alicloud.getRegions({
* current: true,
* });
* const example = new alicloud.vpc.Network("example", {
* vpcName: "tf_example",
* cidrBlock: "172.17.3.0/24",
* });
* const exampleInstance = new alicloud.cen.Instance("example", {
* cenInstanceName: "tf_example",
* description: "an example for cen",
* });
* const exampleInstanceAttachment = new alicloud.cen.InstanceAttachment("example", {
* instanceId: exampleInstance.id,
* childInstanceId: example.id,
* childInstanceType: "VPC",
* childInstanceRegionId: _default.then(_default => _default.regions?.[0]?.id),
* });
* const exampleRouteService = new alicloud.cen.RouteService("example", {
* accessRegionId: _default.then(_default => _default.regions?.[0]?.id),
* hostRegionId: _default.then(_default => _default.regions?.[0]?.id),
* hostVpcId: example.id,
* cenId: exampleInstanceAttachment.instanceId,
* host: "100.118.28.52/32",
* });
* ```
* ```python
* import pulumi
* import pulumi_alicloud as alicloud
* default = alicloud.get_regions(current=True)
* example = alicloud.vpc.Network("example",
* vpc_name="tf_example",
* cidr_block="172.17.3.0/24")
* example_instance = alicloud.cen.Instance("example",
* cen_instance_name="tf_example",
* description="an example for cen")
* example_instance_attachment = alicloud.cen.InstanceAttachment("example",
* instance_id=example_instance.id,
* child_instance_id=example.id,
* child_instance_type="VPC",
* child_instance_region_id=default.regions[0].id)
* example_route_service = alicloud.cen.RouteService("example",
* access_region_id=default.regions[0].id,
* host_region_id=default.regions[0].id,
* host_vpc_id=example.id,
* cen_id=example_instance_attachment.instance_id,
* host="100.118.28.52/32")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using AliCloud = Pulumi.AliCloud;
* return await Deployment.RunAsync(() =>
* {
* var @default = AliCloud.GetRegions.Invoke(new()
* {
* Current = true,
* });
* var example = new AliCloud.Vpc.Network("example", new()
* {
* VpcName = "tf_example",
* CidrBlock = "172.17.3.0/24",
* });
* var exampleInstance = new AliCloud.Cen.Instance("example", new()
* {
* CenInstanceName = "tf_example",
* Description = "an example for cen",
* });
* var exampleInstanceAttachment = new AliCloud.Cen.InstanceAttachment("example", new()
* {
* InstanceId = exampleInstance.Id,
* ChildInstanceId = example.Id,
* ChildInstanceType = "VPC",
* ChildInstanceRegionId = @default.Apply(@default => @default.Apply(getRegionsResult => getRegionsResult.Regions[0]?.Id)),
* });
* var exampleRouteService = new AliCloud.Cen.RouteService("example", new()
* {
* AccessRegionId = @default.Apply(@default => @default.Apply(getRegionsResult => getRegionsResult.Regions[0]?.Id)),
* HostRegionId = @default.Apply(@default => @default.Apply(getRegionsResult => getRegionsResult.Regions[0]?.Id)),
* HostVpcId = example.Id,
* CenId = exampleInstanceAttachment.InstanceId,
* Host = "100.118.28.52/32",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
* "github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/cen"
* "github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _default, err := alicloud.GetRegions(ctx, &alicloud.GetRegionsArgs{
* Current: pulumi.BoolRef(true),
* }, nil)
* if err != nil {
* return err
* }
* example, err := vpc.NewNetwork(ctx, "example", &vpc.NetworkArgs{
* VpcName: pulumi.String("tf_example"),
* CidrBlock: pulumi.String("172.17.3.0/24"),
* })
* if err != nil {
* return err
* }
* exampleInstance, err := cen.NewInstance(ctx, "example", &cen.InstanceArgs{
* CenInstanceName: pulumi.String("tf_example"),
* Description: pulumi.String("an example for cen"),
* })
* if err != nil {
* return err
* }
* exampleInstanceAttachment, err := cen.NewInstanceAttachment(ctx, "example", &cen.InstanceAttachmentArgs{
* InstanceId: exampleInstance.ID(),
* ChildInstanceId: example.ID(),
* ChildInstanceType: pulumi.String("VPC"),
* ChildInstanceRegionId: pulumi.String(_default.Regions[0].Id),
* })
* if err != nil {
* return err
* }
* _, err = cen.NewRouteService(ctx, "example", &cen.RouteServiceArgs{
* AccessRegionId: pulumi.String(_default.Regions[0].Id),
* HostRegionId: pulumi.String(_default.Regions[0].Id),
* HostVpcId: example.ID(),
* CenId: exampleInstanceAttachment.InstanceId,
* Host: pulumi.String("100.118.28.52/32"),
* })
* 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.alicloud.AlicloudFunctions;
* import com.pulumi.alicloud.inputs.GetRegionsArgs;
* import com.pulumi.alicloud.vpc.Network;
* import com.pulumi.alicloud.vpc.NetworkArgs;
* import com.pulumi.alicloud.cen.Instance;
* import com.pulumi.alicloud.cen.InstanceArgs;
* import com.pulumi.alicloud.cen.InstanceAttachment;
* import com.pulumi.alicloud.cen.InstanceAttachmentArgs;
* import com.pulumi.alicloud.cen.RouteService;
* import com.pulumi.alicloud.cen.RouteServiceArgs;
* 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) {
* final var default = AlicloudFunctions.getRegions(GetRegionsArgs.builder()
* .current(true)
* .build());
* var example = new Network("example", NetworkArgs.builder()
* .vpcName("tf_example")
* .cidrBlock("172.17.3.0/24")
* .build());
* var exampleInstance = new Instance("exampleInstance", InstanceArgs.builder()
* .cenInstanceName("tf_example")
* .description("an example for cen")
* .build());
* var exampleInstanceAttachment = new InstanceAttachment("exampleInstanceAttachment", InstanceAttachmentArgs.builder()
* .instanceId(exampleInstance.id())
* .childInstanceId(example.id())
* .childInstanceType("VPC")
* .childInstanceRegionId(default_.regions()[0].id())
* .build());
* var exampleRouteService = new RouteService("exampleRouteService", RouteServiceArgs.builder()
* .accessRegionId(default_.regions()[0].id())
* .hostRegionId(default_.regions()[0].id())
* .hostVpcId(example.id())
* .cenId(exampleInstanceAttachment.instanceId())
* .host("100.118.28.52/32")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: alicloud:vpc:Network
* properties:
* vpcName: tf_example
* cidrBlock: 172.17.3.0/24
* exampleInstance:
* type: alicloud:cen:Instance
* name: example
* properties:
* cenInstanceName: tf_example
* description: an example for cen
* exampleInstanceAttachment:
* type: alicloud:cen:InstanceAttachment
* name: example
* properties:
* instanceId: ${exampleInstance.id}
* childInstanceId: ${example.id}
* childInstanceType: VPC
* childInstanceRegionId: ${default.regions[0].id}
* exampleRouteService:
* type: alicloud:cen:RouteService
* name: example
* properties:
* accessRegionId: ${default.regions[0].id}
* hostRegionId: ${default.regions[0].id}
* hostVpcId: ${example.id}
* cenId: ${exampleInstanceAttachment.instanceId}
* host: 100.118.28.52/32
* variables:
* default:
* fn::invoke:
* Function: alicloud:getRegions
* Arguments:
* current: true
* ```
*
* ## Import
* CEN Route Service can be imported using the id, e.g.
* ```sh
* $ pulumi import alicloud:cen/routeService:RouteService example cen-ahixm0efqh********:cn-shanghai:100.118.28.52/32:cn-shanghai
* ```
*/
public class RouteService internal constructor(
override val javaResource: com.pulumi.alicloud.cen.RouteService,
) : KotlinCustomResource(javaResource, RouteServiceMapper) {
/**
* The region of the network instances that access the cloud services.
*/
public val accessRegionId: Output
get() = javaResource.accessRegionId().applyValue({ args0 -> args0 })
/**
* The ID of the CEN instance.
*/
public val cenId: Output
get() = javaResource.cenId().applyValue({ args0 -> args0 })
/**
* The description of the cloud service.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The domain name or IP address of the cloud service.
*/
public val host: Output
get() = javaResource.host().applyValue({ args0 -> args0 })
/**
* The region of the cloud service.
*/
public val hostRegionId: Output
get() = javaResource.hostRegionId().applyValue({ args0 -> args0 })
/**
* The VPC associated with the cloud service.
* > **NOTE:** The values of `host_region_id` and `access_region_id` must be consistent.
*/
public val hostVpcId: Output
get() = javaResource.hostVpcId().applyValue({ args0 -> args0 })
/**
* The status of the cloud service.
*/
public val status: Output
get() = javaResource.status().applyValue({ args0 -> args0 })
}
public object RouteServiceMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.alicloud.cen.RouteService::class == javaResource::class
override fun map(javaResource: Resource): RouteService = RouteService(
javaResource as
com.pulumi.alicloud.cen.RouteService,
)
}
/**
* @see [RouteService].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [RouteService].
*/
public suspend fun routeService(
name: String,
block: suspend RouteServiceResourceBuilder.() -> Unit,
): RouteService {
val builder = RouteServiceResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [RouteService].
* @param name The _unique_ name of the resulting resource.
*/
public fun routeService(name: String): RouteService {
val builder = RouteServiceResourceBuilder()
builder.name(name)
return builder.build()
}