@pulumi/digitalocean
Version:
A Pulumi package for creating and managing DigitalOcean cloud resources.
120 lines (119 loc) • 4.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ### Limiting access to specific IP addresses
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const foobar = new digitalocean.SpacesBucket("foobar", {
* name: "foobar",
* region: digitalocean.Region.NYC3,
* });
* const foobarSpacesBucketPolicy = new digitalocean.SpacesBucketPolicy("foobar", {
* region: foobar.region,
* bucket: foobar.name,
* policy: pulumi.jsonStringify({
* Version: "2012-10-17",
* Statement: [{
* Sid: "IPAllow",
* Effect: "Deny",
* Principal: "*",
* Action: "s3:*",
* Resource: [
* pulumi.interpolate`arn:aws:s3:::${foobar.name}`,
* pulumi.interpolate`arn:aws:s3:::${foobar.name}/*`,
* ],
* Condition: {
* NotIpAddress: {
* "aws:SourceIp": "54.240.143.0/24",
* },
* },
* }],
* }),
* });
* ```
*
* !> **Warning:** Before using this policy, replace the 54.240.143.0/24 IP address range in this example with an appropriate value for your use case. Otherwise, you will lose the ability to access your bucket.
*
* ## Import
*
* Bucket policies can be imported using the `region` and `bucket` attributes (delimited by a comma):
*
* ```sh
* $ pulumi import digitalocean:index/spacesBucketPolicy:SpacesBucketPolicy foobar `region`,`bucket`
* ```
*/
export declare class SpacesBucketPolicy extends pulumi.CustomResource {
/**
* Get an existing SpacesBucketPolicy 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?: SpacesBucketPolicyState, opts?: pulumi.CustomResourceOptions): SpacesBucketPolicy;
/**
* Returns true if the given object is an instance of SpacesBucketPolicy. 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 SpacesBucketPolicy;
/**
* The name of the bucket to which to apply the policy.
*/
readonly bucket: pulumi.Output<string>;
/**
* The text of the policy.
*/
readonly policy: pulumi.Output<string>;
/**
* The region where the bucket resides.
*/
readonly region: pulumi.Output<string>;
/**
* Create a SpacesBucketPolicy 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: SpacesBucketPolicyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SpacesBucketPolicy resources.
*/
export interface SpacesBucketPolicyState {
/**
* The name of the bucket to which to apply the policy.
*/
bucket?: pulumi.Input<string>;
/**
* The text of the policy.
*/
policy?: pulumi.Input<string>;
/**
* The region where the bucket resides.
*/
region?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SpacesBucketPolicy resource.
*/
export interface SpacesBucketPolicyArgs {
/**
* The name of the bucket to which to apply the policy.
*/
bucket: pulumi.Input<string>;
/**
* The text of the policy.
*/
policy: pulumi.Input<string>;
/**
* The region where the bucket resides.
*/
region: pulumi.Input<string>;
}