@pulumi/openstack
Version:
A Pulumi package for creating and managing OpenStack cloud resources.
165 lines (164 loc) • 5.05 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a V3 Endpoint resource within OpenStack Keystone.
*
* > **Note:** This usually requires admin privileges.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as openstack from "@pulumi/openstack";
*
* const service1 = new openstack.identity.ServiceV3("service_1", {
* name: "my-service",
* type: "my-service-type",
* });
* const endpoint1 = new openstack.identity.EndpointV3("endpoint_1", {
* name: "my-endpoint",
* serviceId: service1.id,
* endpointRegion: service1.region,
* url: "http://my-endpoint",
* });
* ```
*
* ## Import
*
* Endpoints can be imported using the `id`, e.g.
*
* ```sh
* $ pulumi import openstack:identity/endpointV3:EndpointV3 endpoint_1 5392472b-106a-4845-90c6-7c8445f18770
* ```
*/
export declare class EndpointV3 extends pulumi.CustomResource {
/**
* Get an existing EndpointV3 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?: EndpointV3State, opts?: pulumi.CustomResourceOptions): EndpointV3;
/**
* Returns true if the given object is an instance of EndpointV3. 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 EndpointV3;
/**
* The endpoint region. The `region` and
* `endpointRegion` can be different.
*/
readonly endpointRegion: pulumi.Output<string>;
/**
* The endpoint interface. Valid values are `public`,
* `internal` and `admin`. Default value is `public`
*/
readonly interface: pulumi.Output<string | undefined>;
/**
* The endpoint name.
*/
readonly name: pulumi.Output<string>;
/**
* The region in which to obtain the V3 Keystone client.
* If omitted, the `region` argument of the provider is used.
*/
readonly region: pulumi.Output<string>;
/**
* The endpoint service ID.
*/
readonly serviceId: pulumi.Output<string>;
/**
* The service name of the endpoint.
*/
readonly serviceName: pulumi.Output<string>;
/**
* The service type of the endpoint.
*/
readonly serviceType: pulumi.Output<string>;
/**
* The endpoint url.
*/
readonly url: pulumi.Output<string>;
/**
* Create a EndpointV3 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: EndpointV3Args, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering EndpointV3 resources.
*/
export interface EndpointV3State {
/**
* The endpoint region. The `region` and
* `endpointRegion` can be different.
*/
endpointRegion?: pulumi.Input<string>;
/**
* The endpoint interface. Valid values are `public`,
* `internal` and `admin`. Default value is `public`
*/
interface?: pulumi.Input<string>;
/**
* The endpoint name.
*/
name?: pulumi.Input<string>;
/**
* The region in which to obtain the V3 Keystone client.
* If omitted, the `region` argument of the provider is used.
*/
region?: pulumi.Input<string>;
/**
* The endpoint service ID.
*/
serviceId?: pulumi.Input<string>;
/**
* The service name of the endpoint.
*/
serviceName?: pulumi.Input<string>;
/**
* The service type of the endpoint.
*/
serviceType?: pulumi.Input<string>;
/**
* The endpoint url.
*/
url?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a EndpointV3 resource.
*/
export interface EndpointV3Args {
/**
* The endpoint region. The `region` and
* `endpointRegion` can be different.
*/
endpointRegion: pulumi.Input<string>;
/**
* The endpoint interface. Valid values are `public`,
* `internal` and `admin`. Default value is `public`
*/
interface?: pulumi.Input<string>;
/**
* The endpoint name.
*/
name?: pulumi.Input<string>;
/**
* The region in which to obtain the V3 Keystone client.
* If omitted, the `region` argument of the provider is used.
*/
region?: pulumi.Input<string>;
/**
* The endpoint service ID.
*/
serviceId: pulumi.Input<string>;
/**
* The endpoint url.
*/
url: pulumi.Input<string>;
}