UNPKG

@pulumi/meraki

Version:

A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0

288 lines (287 loc) 10.7 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * ## Example Usage * * ## Import * * ```sh * $ pulumi import meraki:networks/wirelessSsidsSplashSettings:WirelessSsidsSplashSettings example "network_id,number" * ``` */ export declare class WirelessSsidsSplashSettings extends pulumi.CustomResource { /** * Get an existing WirelessSsidsSplashSettings 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 Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, state?: WirelessSsidsSplashSettingsState, opts?: pulumi.CustomResourceOptions): WirelessSsidsSplashSettings; /** * Returns true if the given object is an instance of WirelessSsidsSplashSettings. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is WirelessSsidsSplashSettings; /** * Whether or not to allow simultaneous logins from different devices. */ readonly allowSimultaneousLogins: pulumi.Output<boolean>; /** * Details associated with billing splash */ readonly billing: pulumi.Output<outputs.networks.WirelessSsidsSplashSettingsBilling>; /** * How restricted allowing traffic should be. If true, all traffic types are blocked until the splash page is acknowledged. If false, all non-HTTP traffic is allowed before the splash page is acknowledged. */ readonly blockAllTrafficBeforeSignOn: pulumi.Output<boolean>; /** * How login attempts should be handled when the controller is unreachable. */ readonly controllerDisconnectionBehavior: pulumi.Output<string>; /** * Details associated with guest sponsored splash */ readonly guestSponsorship: pulumi.Output<outputs.networks.WirelessSsidsSplashSettingsGuestSponsorship>; /** * networkId path parameter. Network ID */ readonly networkId: pulumi.Output<string>; /** * number path parameter. */ readonly number: pulumi.Output<string>; /** * The custom redirect URL where the users will go after the splash page. */ readonly redirectUrl: pulumi.Output<string>; /** * Self-registration for splash with Meraki authentication. */ readonly selfRegistration: pulumi.Output<outputs.networks.WirelessSsidsSplashSettingsSelfRegistration>; /** * Systems Manager sentry enrollment splash settings. */ readonly sentryEnrollment: pulumi.Output<outputs.networks.WirelessSsidsSplashSettingsSentryEnrollment>; /** * The image used in the splash page. */ readonly splashImage: pulumi.Output<outputs.networks.WirelessSsidsSplashSettingsSplashImage>; /** * The logo used in the splash page. */ readonly splashLogo: pulumi.Output<outputs.networks.WirelessSsidsSplashSettingsSplashLogo>; /** * The type of splash page for this SSID */ readonly splashPage: pulumi.Output<string>; /** * The prepaid front image used in the splash page. */ readonly splashPrepaidFront: pulumi.Output<outputs.networks.WirelessSsidsSplashSettingsSplashPrepaidFront>; /** * Splash timeout in minutes. */ readonly splashTimeout: pulumi.Output<number>; /** * The custom splash URL of the click-through splash page. */ readonly splashUrl: pulumi.Output<string>; /** * SSID number */ readonly ssidNumber: pulumi.Output<number>; /** * The id of the selected splash theme. */ readonly themeId: pulumi.Output<string>; /** * The Boolean indicating whether the the user will be redirected to the custom redirect URL after the splash page. */ readonly useRedirectUrl: pulumi.Output<boolean>; /** * Boolean indicating whether the users will be redirected to the custom splash url */ readonly useSplashUrl: pulumi.Output<boolean>; /** * The welcome message for the users on the splash page. */ readonly welcomeMessage: pulumi.Output<string>; /** * Create a WirelessSsidsSplashSettings resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: WirelessSsidsSplashSettingsArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering WirelessSsidsSplashSettings resources. */ export interface WirelessSsidsSplashSettingsState { /** * Whether or not to allow simultaneous logins from different devices. */ allowSimultaneousLogins?: pulumi.Input<boolean>; /** * Details associated with billing splash */ billing?: pulumi.Input<inputs.networks.WirelessSsidsSplashSettingsBilling>; /** * How restricted allowing traffic should be. If true, all traffic types are blocked until the splash page is acknowledged. If false, all non-HTTP traffic is allowed before the splash page is acknowledged. */ blockAllTrafficBeforeSignOn?: pulumi.Input<boolean>; /** * How login attempts should be handled when the controller is unreachable. */ controllerDisconnectionBehavior?: pulumi.Input<string>; /** * Details associated with guest sponsored splash */ guestSponsorship?: pulumi.Input<inputs.networks.WirelessSsidsSplashSettingsGuestSponsorship>; /** * networkId path parameter. Network ID */ networkId?: pulumi.Input<string>; /** * number path parameter. */ number?: pulumi.Input<string>; /** * The custom redirect URL where the users will go after the splash page. */ redirectUrl?: pulumi.Input<string>; /** * Self-registration for splash with Meraki authentication. */ selfRegistration?: pulumi.Input<inputs.networks.WirelessSsidsSplashSettingsSelfRegistration>; /** * Systems Manager sentry enrollment splash settings. */ sentryEnrollment?: pulumi.Input<inputs.networks.WirelessSsidsSplashSettingsSentryEnrollment>; /** * The image used in the splash page. */ splashImage?: pulumi.Input<inputs.networks.WirelessSsidsSplashSettingsSplashImage>; /** * The logo used in the splash page. */ splashLogo?: pulumi.Input<inputs.networks.WirelessSsidsSplashSettingsSplashLogo>; /** * The type of splash page for this SSID */ splashPage?: pulumi.Input<string>; /** * The prepaid front image used in the splash page. */ splashPrepaidFront?: pulumi.Input<inputs.networks.WirelessSsidsSplashSettingsSplashPrepaidFront>; /** * Splash timeout in minutes. */ splashTimeout?: pulumi.Input<number>; /** * The custom splash URL of the click-through splash page. */ splashUrl?: pulumi.Input<string>; /** * SSID number */ ssidNumber?: pulumi.Input<number>; /** * The id of the selected splash theme. */ themeId?: pulumi.Input<string>; /** * The Boolean indicating whether the the user will be redirected to the custom redirect URL after the splash page. */ useRedirectUrl?: pulumi.Input<boolean>; /** * Boolean indicating whether the users will be redirected to the custom splash url */ useSplashUrl?: pulumi.Input<boolean>; /** * The welcome message for the users on the splash page. */ welcomeMessage?: pulumi.Input<string>; } /** * The set of arguments for constructing a WirelessSsidsSplashSettings resource. */ export interface WirelessSsidsSplashSettingsArgs { /** * Whether or not to allow simultaneous logins from different devices. */ allowSimultaneousLogins?: pulumi.Input<boolean>; /** * Details associated with billing splash */ billing?: pulumi.Input<inputs.networks.WirelessSsidsSplashSettingsBilling>; /** * How restricted allowing traffic should be. If true, all traffic types are blocked until the splash page is acknowledged. If false, all non-HTTP traffic is allowed before the splash page is acknowledged. */ blockAllTrafficBeforeSignOn?: pulumi.Input<boolean>; /** * How login attempts should be handled when the controller is unreachable. */ controllerDisconnectionBehavior?: pulumi.Input<string>; /** * Details associated with guest sponsored splash */ guestSponsorship?: pulumi.Input<inputs.networks.WirelessSsidsSplashSettingsGuestSponsorship>; /** * networkId path parameter. Network ID */ networkId: pulumi.Input<string>; /** * number path parameter. */ number: pulumi.Input<string>; /** * The custom redirect URL where the users will go after the splash page. */ redirectUrl?: pulumi.Input<string>; /** * Systems Manager sentry enrollment splash settings. */ sentryEnrollment?: pulumi.Input<inputs.networks.WirelessSsidsSplashSettingsSentryEnrollment>; /** * The image used in the splash page. */ splashImage?: pulumi.Input<inputs.networks.WirelessSsidsSplashSettingsSplashImage>; /** * The logo used in the splash page. */ splashLogo?: pulumi.Input<inputs.networks.WirelessSsidsSplashSettingsSplashLogo>; /** * The prepaid front image used in the splash page. */ splashPrepaidFront?: pulumi.Input<inputs.networks.WirelessSsidsSplashSettingsSplashPrepaidFront>; /** * Splash timeout in minutes. */ splashTimeout?: pulumi.Input<number>; /** * The custom splash URL of the click-through splash page. */ splashUrl?: pulumi.Input<string>; /** * The id of the selected splash theme. */ themeId?: pulumi.Input<string>; /** * The Boolean indicating whether the the user will be redirected to the custom redirect URL after the splash page. */ useRedirectUrl?: pulumi.Input<boolean>; /** * Boolean indicating whether the users will be redirected to the custom splash url */ useSplashUrl?: pulumi.Input<boolean>; /** * The welcome message for the users on the splash page. */ welcomeMessage?: pulumi.Input<string>; }