@pulumi/openstack
Version:
A Pulumi package for creating and managing OpenStack cloud resources.
233 lines (232 loc) • 8.26 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Use this resource to configure a security service.
*
* > **Note:** All arguments including the security service password will be
* stored in the raw state as plain-text. [Read more about sensitive data in
* state](https://www.terraform.io/docs/state/sensitive-data.html).
*
* A security service stores configuration information for clients for
* authentication and authorization (AuthN/AuthZ). For example, a share server
* will be the client for an existing service such as LDAP, Kerberos, or
* Microsoft Active Directory.
*
* Minimum supported Manila microversion is 2.7.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as openstack from "@pulumi/openstack";
*
* const securityservice1 = new openstack.sharedfilesystem.SecurityService("securityservice_1", {
* name: "security",
* description: "created by terraform",
* type: "active_directory",
* server: "192.168.199.10",
* dnsIp: "192.168.199.10",
* domain: "example.com",
* ou: "CN=Computers,DC=example,DC=com",
* user: "joinDomainUser",
* password: "s8cret",
* });
* ```
*
* ## Import
*
* This resource can be imported by specifying the ID of the security service:
*
* ```sh
* $ pulumi import openstack:sharedfilesystem/securityService:SecurityService securityservice_1 id
* ```
*/
export declare class SecurityService extends pulumi.CustomResource {
/**
* Get an existing SecurityService 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?: SecurityServiceState, opts?: pulumi.CustomResourceOptions): SecurityService;
/**
* Returns true if the given object is an instance of SecurityService. 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 SecurityService;
/**
* The human-readable description for the security service.
* Changing this updates the description of the existing security service.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The security service DNS IP address that is used inside the
* tenant network.
*/
readonly dnsIp: pulumi.Output<string | undefined>;
/**
* The security service domain.
*/
readonly domain: pulumi.Output<string | undefined>;
/**
* The name of the security service. Changing this updates the name
* of the existing security service.
*/
readonly name: pulumi.Output<string>;
/**
* The security service ou. An organizational unit can be added to
* specify where the share ends up. New in Manila microversion 2.44.
*/
readonly ou: pulumi.Output<string | undefined>;
/**
* The user password, if you specify a user.
*/
readonly password: pulumi.Output<string | undefined>;
/**
* The owner of the Security Service.
*/
readonly projectId: pulumi.Output<string>;
/**
* The region in which to obtain the V2 Shared File System client.
* A Shared File System client is needed to create a security service. If omitted, the
* `region` argument of the provider is used. Changing this creates a new
* security service.
*/
readonly region: pulumi.Output<string>;
/**
* The security service host name or IP address.
*/
readonly server: pulumi.Output<string | undefined>;
/**
* The security service type - can either be active\_directory,
* kerberos or ldap. Changing this updates the existing security service.
*/
readonly type: pulumi.Output<string>;
/**
* The security service user or group name that is used by the
* tenant.
*/
readonly user: pulumi.Output<string | undefined>;
/**
* Create a SecurityService 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: SecurityServiceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SecurityService resources.
*/
export interface SecurityServiceState {
/**
* The human-readable description for the security service.
* Changing this updates the description of the existing security service.
*/
description?: pulumi.Input<string>;
/**
* The security service DNS IP address that is used inside the
* tenant network.
*/
dnsIp?: pulumi.Input<string>;
/**
* The security service domain.
*/
domain?: pulumi.Input<string>;
/**
* The name of the security service. Changing this updates the name
* of the existing security service.
*/
name?: pulumi.Input<string>;
/**
* The security service ou. An organizational unit can be added to
* specify where the share ends up. New in Manila microversion 2.44.
*/
ou?: pulumi.Input<string>;
/**
* The user password, if you specify a user.
*/
password?: pulumi.Input<string>;
/**
* The owner of the Security Service.
*/
projectId?: pulumi.Input<string>;
/**
* The region in which to obtain the V2 Shared File System client.
* A Shared File System client is needed to create a security service. If omitted, the
* `region` argument of the provider is used. Changing this creates a new
* security service.
*/
region?: pulumi.Input<string>;
/**
* The security service host name or IP address.
*/
server?: pulumi.Input<string>;
/**
* The security service type - can either be active\_directory,
* kerberos or ldap. Changing this updates the existing security service.
*/
type?: pulumi.Input<string>;
/**
* The security service user or group name that is used by the
* tenant.
*/
user?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SecurityService resource.
*/
export interface SecurityServiceArgs {
/**
* The human-readable description for the security service.
* Changing this updates the description of the existing security service.
*/
description?: pulumi.Input<string>;
/**
* The security service DNS IP address that is used inside the
* tenant network.
*/
dnsIp?: pulumi.Input<string>;
/**
* The security service domain.
*/
domain?: pulumi.Input<string>;
/**
* The name of the security service. Changing this updates the name
* of the existing security service.
*/
name?: pulumi.Input<string>;
/**
* The security service ou. An organizational unit can be added to
* specify where the share ends up. New in Manila microversion 2.44.
*/
ou?: pulumi.Input<string>;
/**
* The user password, if you specify a user.
*/
password?: pulumi.Input<string>;
/**
* The region in which to obtain the V2 Shared File System client.
* A Shared File System client is needed to create a security service. If omitted, the
* `region` argument of the provider is used. Changing this creates a new
* security service.
*/
region?: pulumi.Input<string>;
/**
* The security service host name or IP address.
*/
server?: pulumi.Input<string>;
/**
* The security service type - can either be active\_directory,
* kerberos or ldap. Changing this updates the existing security service.
*/
type: pulumi.Input<string>;
/**
* The security service user or group name that is used by the
* tenant.
*/
user?: pulumi.Input<string>;
}