com.pulumi.azurenative.network.Route Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-native Show documentation
Show all versions of azure-native Show documentation
A native Pulumi package for creating and managing Azure resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azurenative.network;
import com.pulumi.azurenative.Utilities;
import com.pulumi.azurenative.network.RouteArgs;
import com.pulumi.core.Alias;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Route resource.
* Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2020-11-01.
*
* Other available API versions: 2019-06-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01.
*
* ## Example Usage
* ### Create route
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.network.Route;
* import com.pulumi.azurenative.network.RouteArgs;
* 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) {
* var route = new Route("route", RouteArgs.builder()
* .addressPrefix("10.0.3.0/24")
* .nextHopType("VirtualNetworkGateway")
* .resourceGroupName("rg1")
* .routeName("route1")
* .routeTableName("testrt")
* .build());
*
* }
* }
*
* }
*
*
* ## Import
*
* An existing resource can be imported using its type token, name, and identifier, e.g.
*
* ```sh
* $ pulumi import azure-native:network:Route route1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}
* ```
*
*/
@ResourceType(type="azure-native:network:Route")
public class Route extends com.pulumi.resources.CustomResource {
/**
* The destination CIDR to which the route applies.
*
*/
@Export(name="addressPrefix", refs={String.class}, tree="[0]")
private Output addressPrefix;
/**
* @return The destination CIDR to which the route applies.
*
*/
public Output> addressPrefix() {
return Codegen.optional(this.addressPrefix);
}
/**
* A unique read-only string that changes whenever the resource is updated.
*
*/
@Export(name="etag", refs={String.class}, tree="[0]")
private Output etag;
/**
* @return A unique read-only string that changes whenever the resource is updated.
*
*/
public Output etag() {
return this.etag;
}
/**
* A value indicating whether this route overrides overlapping BGP routes regardless of LPM.
*
*/
@Export(name="hasBgpOverride", refs={Boolean.class}, tree="[0]")
private Output hasBgpOverride;
/**
* @return A value indicating whether this route overrides overlapping BGP routes regardless of LPM.
*
*/
public Output hasBgpOverride() {
return this.hasBgpOverride;
}
/**
* The name of the resource that is unique within a resource group. This name can be used to access the resource.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return The name of the resource that is unique within a resource group. This name can be used to access the resource.
*
*/
public Output> name() {
return Codegen.optional(this.name);
}
/**
* The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
*
*/
@Export(name="nextHopIpAddress", refs={String.class}, tree="[0]")
private Output nextHopIpAddress;
/**
* @return The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
*
*/
public Output> nextHopIpAddress() {
return Codegen.optional(this.nextHopIpAddress);
}
/**
* The type of Azure hop the packet should be sent to.
*
*/
@Export(name="nextHopType", refs={String.class}, tree="[0]")
private Output nextHopType;
/**
* @return The type of Azure hop the packet should be sent to.
*
*/
public Output nextHopType() {
return this.nextHopType;
}
/**
* The provisioning state of the route resource.
*
*/
@Export(name="provisioningState", refs={String.class}, tree="[0]")
private Output provisioningState;
/**
* @return The provisioning state of the route resource.
*
*/
public Output provisioningState() {
return this.provisioningState;
}
/**
* The type of the resource.
*
*/
@Export(name="type", refs={String.class}, tree="[0]")
private Output type;
/**
* @return The type of the resource.
*
*/
public Output> type() {
return Codegen.optional(this.type);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public Route(java.lang.String name) {
this(name, RouteArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public Route(java.lang.String name, RouteArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public Route(java.lang.String name, RouteArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:network:Route", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private Route(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:network:Route", name, null, makeResourceOptions(options, id), false);
}
private static RouteArgs makeArgs(RouteArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? RouteArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.aliases(List.of(
Output.of(Alias.builder().type("azure-native:network/v20150501preview:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20150615:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20160330:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20160601:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20160901:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20161201:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20170301:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20170601:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20170801:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20170901:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20171001:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20171101:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20180101:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20180201:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20180401:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20180601:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20180701:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20180801:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20181001:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20181101:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20181201:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20190201:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20190401:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20190601:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20190701:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20190801:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20190901:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20191101:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20191201:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20200301:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20200401:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20200501:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20200601:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20200701:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20200801:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20201101:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20210201:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20210301:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20210501:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20210801:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20220101:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20220501:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20220701:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20220901:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20221101:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20230201:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20230401:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20230501:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20230601:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20230901:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20231101:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20240101:Route").build()),
Output.of(Alias.builder().type("azure-native:network/v20240301:Route").build())
))
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static Route get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new Route(name, id, options);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy