@mapped/pulumi-astra
Version:
A Pulumi package for creating and managing astra cloud resources.
103 lines (102 loc) • 3.55 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import { input as inputs, output as outputs } from "./types";
/**
* `astra.AccessList` resource represents a database access list, used to limit the ip's / CIDR groups that have access to a database.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as astra from "@pulumi/astra";
*
* const example = new astra.AccessList("example", {
* addresses: [{
* requests: [{
* address: "0.0.0.0/0",
* enabled: true,
* }],
* }],
* databaseId: "a6bc9c26-e7ce-424f-84c7-0a00afb12588",
* enabled: true,
* });
* ```
*
* ## Import
*
* # the import id includes the database_id and the keyspace name.
*
* ```sh
* $ pulumi import astra:index/accessList:AccessList example 48bfc13b-c1a5-48db-b70f-b6ef9709872b/keyspace/example
* ```
*/
export declare class AccessList extends pulumi.CustomResource {
/**
* Get an existing AccessList 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?: AccessListState, opts?: pulumi.CustomResourceOptions): AccessList;
/**
* Returns true if the given object is an instance of AccessList. 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 AccessList;
/**
* List of address requests that should have access to database endpoints.
*/
readonly addresses: pulumi.Output<outputs.AccessListAddress[]>;
/**
* The ID of the Astra database.
*/
readonly databaseId: pulumi.Output<string>;
/**
* Public access restrictions enabled or disabled
*/
readonly enabled: pulumi.Output<boolean | undefined>;
/**
* Create a AccessList 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: AccessListArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AccessList resources.
*/
export interface AccessListState {
/**
* List of address requests that should have access to database endpoints.
*/
addresses?: pulumi.Input<pulumi.Input<inputs.AccessListAddress>[]>;
/**
* The ID of the Astra database.
*/
databaseId?: pulumi.Input<string>;
/**
* Public access restrictions enabled or disabled
*/
enabled?: pulumi.Input<boolean>;
}
/**
* The set of arguments for constructing a AccessList resource.
*/
export interface AccessListArgs {
/**
* List of address requests that should have access to database endpoints.
*/
addresses: pulumi.Input<pulumi.Input<inputs.AccessListAddress>[]>;
/**
* The ID of the Astra database.
*/
databaseId: pulumi.Input<string>;
/**
* Public access restrictions enabled or disabled
*/
enabled?: pulumi.Input<boolean>;
}