@pulumi/scm
Version:
A Pulumi package for managing resources on Strata Cloud Manager.. Based on terraform-provider-scm: version v0.2.1
213 lines (212 loc) • 5.71 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* AuthenticationRule data source
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scm from "@pulumi/scm";
*
* const ruleData = scm.getAuthenticationRule({
* id: "1f1e08af-fe7b-4c36-882a-411101ad36d7",
* });
* export const fetchedRuleId = ruleData.then(ruleData => ruleData.id);
* export const fetchedRuleData = ruleData;
* ```
*/
export declare function getAuthenticationRule(args: GetAuthenticationRuleArgs, opts?: pulumi.InvokeOptions): Promise<GetAuthenticationRuleResult>;
/**
* A collection of arguments for invoking getAuthenticationRule.
*/
export interface GetAuthenticationRuleArgs {
/**
* Device
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
device?: string;
/**
* Folder
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
folder?: string;
/**
* The UUID of the authentication rule
*/
id: string;
/**
* The name of the authentication rule
*/
name?: string;
/**
* Snippet
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
snippet?: string;
}
/**
* A collection of values returned by getAuthenticationRule.
*/
export interface GetAuthenticationRuleResult {
/**
* The authentication profile name
*/
readonly authenticationEnforcement: string;
/**
* The destination URL categories
*/
readonly categories: string[];
/**
* The description of the authentication rule
*/
readonly description: string;
/**
* The destination Host Integrity Profile (HIP)
*/
readonly destinationHips: string[];
/**
* The destination addresses
*/
readonly destinations: string[];
/**
* Device
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
readonly device: string;
/**
* Is the authentication rule disabled?
*/
readonly disabled: boolean;
/**
* Folder
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
readonly folder: string;
/**
* The source security zones
*/
readonly froms: string[];
/**
* Group tag
*/
readonly groupTag: string;
/**
* The source Host Integrity Profile (HIP)
*/
readonly hipProfiles: string[];
/**
* The UUID of the authentication rule
*/
readonly id: string;
/**
* Log authentication timeouts?
*/
readonly logAuthenticationTimeout: boolean;
/**
* The log forwarding profile name
*/
readonly logSetting: string;
/**
* The name of the authentication rule
*/
readonly name: string;
/**
* Are the destination addresses negated?
*/
readonly negateDestination: boolean;
/**
* Are the source addresses negated?
*/
readonly negateSource: boolean;
/**
* The relative position of the rule
*/
readonly position: string;
/**
* Relative positioning rule. String must be one of these: `"before"`, `"after"`, `"top"`, `"bottom"`. If not specified, rule is created at the bottom of the ruleset.
*/
readonly relativePosition: string;
/**
* The destination ports
*/
readonly services: string[];
/**
* Snippet
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
readonly snippet: string;
/**
* The source Host Integrity Profile (HIP)
*/
readonly sourceHips: string[];
/**
* The source users
*/
readonly sourceUsers: string[];
/**
* The source addresses
*/
readonly sources: string[];
/**
* The authentication rule tags
*/
readonly tags: string[];
/**
* The name or UUID of the rule to position this rule relative to. Required when `relativePosition` is `"before"` or `"after"`.
*/
readonly targetRule: string;
readonly tfid: string;
/**
* The authentication session timeout (seconds)
*/
readonly timeout: number;
/**
* The destination security zones
*/
readonly tos: string[];
}
/**
* AuthenticationRule data source
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scm from "@pulumi/scm";
*
* const ruleData = scm.getAuthenticationRule({
* id: "1f1e08af-fe7b-4c36-882a-411101ad36d7",
* });
* export const fetchedRuleId = ruleData.then(ruleData => ruleData.id);
* export const fetchedRuleData = ruleData;
* ```
*/
export declare function getAuthenticationRuleOutput(args: GetAuthenticationRuleOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAuthenticationRuleResult>;
/**
* A collection of arguments for invoking getAuthenticationRule.
*/
export interface GetAuthenticationRuleOutputArgs {
/**
* Device
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
device?: pulumi.Input<string>;
/**
* Folder
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
folder?: pulumi.Input<string>;
/**
* The UUID of the authentication rule
*/
id: pulumi.Input<string>;
/**
* The name of the authentication rule
*/
name?: pulumi.Input<string>;
/**
* Snippet
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
snippet?: pulumi.Input<string>;
}