com.pulumi.azurenative.cache.FirewallRule 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
A native Pulumi package for creating and managing Azure resources.
The newest version!
// *** 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.cache;

import com.pulumi.azurenative.Utilities;
import com.pulumi.azurenative.cache.FirewallRuleArgs;
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.String;
import java.util.List;
import javax.annotation.Nullable;

/**
 * A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect
 * Azure REST API version: 2023-04-01. Prior API version in Azure Native 1.x: 2020-06-01.
 * 
 * Other available API versions: 2023-05-01-preview, 2023-08-01, 2024-03-01, 2024-04-01-preview, 2024-11-01.
 * 
 * ## Example Usage
 * ### RedisCacheFirewallRuleCreate
 * 
 *  * {@code
 * package generated_program;
 * 
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.azurenative.cache.FirewallRule;
 * import com.pulumi.azurenative.cache.FirewallRuleArgs;
 * 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 firewallRule = new FirewallRule("firewallRule", FirewallRuleArgs.builder()
 *             .cacheName("cache1")
 *             .endIP("192.168.1.4")
 *             .resourceGroupName("rg1")
 *             .ruleName("rule1")
 *             .startIP("192.168.1.1")
 *             .build());
 * 
 *     }
 * }
 * 
 * }
 * 
 * 
 * ## Import
 * 
 * An existing resource can be imported using its type token, name, and identifier, e.g.
 * 
 * ```sh
 * $ pulumi import azure-native:cache:FirewallRule cache1/rule1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules/{ruleName} 
 * ```
 * 
 */
@ResourceType(type="azure-native:cache:FirewallRule")
public class FirewallRule extends com.pulumi.resources.CustomResource {
    /**
     * highest IP address included in the range
     * 
     */
    @Export(name="endIP", refs={String.class}, tree="[0]")
    private Output endIP;

    /**
     * @return highest IP address included in the range
     * 
     */
    public Output endIP() {
        return this.endIP;
    }
    /**
     * The name of the resource
     * 
     */
    @Export(name="name", refs={String.class}, tree="[0]")
    private Output name;

    /**
     * @return The name of the resource
     * 
     */
    public Output name() {
        return this.name;
    }
    /**
     * lowest IP address included in the range
     * 
     */
    @Export(name="startIP", refs={String.class}, tree="[0]")
    private Output startIP;

    /**
     * @return lowest IP address included in the range
     * 
     */
    public Output startIP() {
        return this.startIP;
    }
    /**
     * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
     * 
     */
    @Export(name="type", refs={String.class}, tree="[0]")
    private Output type;

    /**
     * @return The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
     * 
     */
    public Output type() {
        return this.type;
    }

    /**
     *
     * @param name The _unique_ name of the resulting resource.
     */
    public FirewallRule(java.lang.String name) {
        this(name, FirewallRuleArgs.Empty);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     */
    public FirewallRule(java.lang.String name, FirewallRuleArgs 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 FirewallRule(java.lang.String name, FirewallRuleArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("azure-native:cache:FirewallRule", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
    }

    private FirewallRule(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("azure-native:cache:FirewallRule", name, null, makeResourceOptions(options, id), false);
    }

    private static FirewallRuleArgs makeArgs(FirewallRuleArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        if (options != null && options.getUrn().isPresent()) {
            return null;
        }
        return args == null ? FirewallRuleArgs.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:cache/v20160401:FirewallRule").build()),
                Output.of(Alias.builder().type("azure-native:cache/v20170201:FirewallRule").build()),
                Output.of(Alias.builder().type("azure-native:cache/v20171001:FirewallRule").build()),
                Output.of(Alias.builder().type("azure-native:cache/v20180301:FirewallRule").build()),
                Output.of(Alias.builder().type("azure-native:cache/v20190701:FirewallRule").build()),
                Output.of(Alias.builder().type("azure-native:cache/v20200601:FirewallRule").build()),
                Output.of(Alias.builder().type("azure-native:cache/v20201201:FirewallRule").build()),
                Output.of(Alias.builder().type("azure-native:cache/v20210601:FirewallRule").build()),
                Output.of(Alias.builder().type("azure-native:cache/v20220501:FirewallRule").build()),
                Output.of(Alias.builder().type("azure-native:cache/v20220601:FirewallRule").build()),
                Output.of(Alias.builder().type("azure-native:cache/v20230401:FirewallRule").build()),
                Output.of(Alias.builder().type("azure-native:cache/v20230501preview:FirewallRule").build()),
                Output.of(Alias.builder().type("azure-native:cache/v20230801:FirewallRule").build()),
                Output.of(Alias.builder().type("azure-native:cache/v20240301:FirewallRule").build()),
                Output.of(Alias.builder().type("azure-native:cache/v20240401preview:FirewallRule").build()),
                Output.of(Alias.builder().type("azure-native:cache/v20241101:FirewallRule").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 FirewallRule get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        return new FirewallRule(name, id, options);
    }
}