com.pulumi.okta.RateLimiting Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of okta Show documentation
A Pulumi package for creating and managing okta resources.
There is a newer version: 4.13.0-alpha.1732774005
// *** 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.okta;

import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import com.pulumi.okta.RateLimitingArgs;
import com.pulumi.okta.Utilities;
import com.pulumi.okta.inputs.RateLimitingState;
import java.lang.Boolean;
import java.lang.String;
import java.util.Optional;
import javax.annotation.Nullable;

/**
 * Manages rate limiting.
 * This resource allows you to configure the client-based rate limit and rate limiting communications settings.
 * > **WARNING:** This resource is available only when using a SSWS API token in the provider config, it is incompatible with OAuth 2.0 authentication.
 * **WARNING:** This resource makes use of an internal/private Okta API endpoint that could change without notice rendering this resource inoperable.
 * 
 * ## Example Usage
 * 
 * <!--Start PulumiCodeChooser -->
 *  * {@code
 * package generated_program;
 * 
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.okta.RateLimiting;
 * import com.pulumi.okta.RateLimitingArgs;
 * 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 example = new RateLimiting("example", RateLimitingArgs.builder()
 *             .login("ENFORCE")
 *             .authorize("ENFORCE")
 *             .communicationsEnabled(true)
 *             .build());
 * 
 *     }
 * }
 * }
 * 
 * <!--End PulumiCodeChooser -->
 * 
 * ## Import
 * 
 * ```sh
 * $ pulumi import okta:index/rateLimiting:RateLimiting example .
 * ```
 * 
 */
@ResourceType(type="okta:index/rateLimiting:RateLimiting")
public class RateLimiting extends com.pulumi.resources.CustomResource {
    /**
     * Called during authentication. Valid values: `ENFORCE` *(Enforce limit and log per client (recommended))*, `DISABLE` *(Do nothing (not recommended))*, `PREVIEW` *(Log per client)*.
     * 
     */
    @Export(name="authorize", refs={String.class}, tree="[0]")
    private Output authorize;

    /**
     * @return Called during authentication. Valid values: `ENFORCE` *(Enforce limit and log per client (recommended))*, `DISABLE` *(Do nothing (not recommended))*, `PREVIEW` *(Log per client)*.
     * 
     */
    public Output authorize() {
        return this.authorize;
    }
    /**
     * Enable or disable rate limiting communications. By default, it is `true`.
     * 
     */
    @Export(name="communicationsEnabled", refs={Boolean.class}, tree="[0]")
    private Output communicationsEnabled;

    /**
     * @return Enable or disable rate limiting communications. By default, it is `true`.
     * 
     */
    public Output> communicationsEnabled() {
        return Codegen.optional(this.communicationsEnabled);
    }
    /**
     * Called when accessing the Okta hosted login page. Valid values: `ENFORCE` *(Enforce limit and log per client (recommended))*, `DISABLE` *(Do nothing (not recommended))*, `PREVIEW` *(Log per client)*.
     * 
     */
    @Export(name="login", refs={String.class}, tree="[0]")
    private Output login;

    /**
     * @return Called when accessing the Okta hosted login page. Valid values: `ENFORCE` *(Enforce limit and log per client (recommended))*, `DISABLE` *(Do nothing (not recommended))*, `PREVIEW` *(Log per client)*.
     * 
     */
    public Output login() {
        return this.login;
    }

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

    private RateLimiting(java.lang.String name, Output id, @Nullable RateLimitingState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("okta:index/rateLimiting:RateLimiting", name, state, makeResourceOptions(options, id), false);
    }

    private static RateLimitingArgs makeArgs(RateLimitingArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        if (options != null && options.getUrn().isPresent()) {
            return null;
        }
        return args == null ? RateLimitingArgs.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())
            .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 state
     * @param options Optional settings to control the behavior of the CustomResource.
     */
    public static RateLimiting get(java.lang.String name, Output id, @Nullable RateLimitingState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        return new RateLimiting(name, id, state, options);
    }
}