glacier

package
v3.11.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 5, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Vault 

type Vault struct {
	pulumi.CustomResourceState

	// The policy document. This is a JSON formatted string.
	// The heredoc syntax or `file` function is helpful here. Use the [Glacier Developer Guide](https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html) for more information on Glacier Vault Policy
	AccessPolicy pulumi.StringPtrOutput `pulumi:"accessPolicy"`
	// The ARN of the vault.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The URI of the vault that was created.
	Location pulumi.StringOutput `pulumi:"location"`
	// The name of the Vault. Names can be between 1 and 255 characters long and the valid characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).
	Name pulumi.StringOutput `pulumi:"name"`
	// The notifications for the Vault. Fields documented below.
	Notifications VaultNotificationArrayOutput `pulumi:"notifications"`
	// A map of tags to assign to the resource.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

Provides a Glacier Vault Resource. You can refer to the [Glacier Developer Guide](https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-vaults.html) for a full explanation of the Glacier Vault functionality

> **NOTE:** When removing a Glacier Vault, the Vault must be empty.

## Example Usage

```go package main

import ( 

"fmt"

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/glacier"
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/sns"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		awsSnsTopic, err := sns.NewTopic(ctx, "awsSnsTopic", nil)
		if err != nil {
			return err
		}
		_, err = glacier.NewVault(ctx, "myArchive", &glacier.VaultArgs{
			Notifications: glacier.VaultNotificationArray{
				&glacier.VaultNotificationArgs{
					SnsTopic: awsSnsTopic.Arn,
					Events: pulumi.StringArray{
						pulumi.String("ArchiveRetrievalCompleted"),
						pulumi.String("InventoryRetrievalCompleted"),
					},
				},
			},
			AccessPolicy: pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", "    \"Version\":\"2012-10-17\",\n", "    \"Statement\":[\n", "       {\n", "          \"Sid\": \"add-read-only-perm\",\n", "          \"Principal\": \"*\",\n", "          \"Effect\": \"Allow\",\n", "          \"Action\": [\n", "             \"glacier:InitiateJob\",\n", "             \"glacier:GetJobOutput\"\n", "          ],\n", "          \"Resource\": \"arn:aws:glacier:eu-west-1:432981146916:vaults/MyArchive\"\n", "       }\n", "    ]\n", "}\n")),
			Tags: pulumi.StringMap{
				"Test": pulumi.String("MyArchive"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetVault 

func GetVault(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *VaultState, opts ...pulumi.ResourceOption) (*Vault, error)

GetVault gets an existing Vault resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewVault 

func NewVault(ctx *pulumi.Context,
	name string, args *VaultArgs, opts ...pulumi.ResourceOption) (*Vault, error)

NewVault registers a new resource with the given unique name, arguments, and options.

type VaultArgs 

type VaultArgs struct {
	// The policy document. This is a JSON formatted string.
	// The heredoc syntax or `file` function is helpful here. Use the [Glacier Developer Guide](https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html) for more information on Glacier Vault Policy
	AccessPolicy pulumi.StringPtrInput
	// The name of the Vault. Names can be between 1 and 255 characters long and the valid characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).
	Name pulumi.StringPtrInput
	// The notifications for the Vault. Fields documented below.
	Notifications VaultNotificationArrayInput
	// A map of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Vault resource.

func (VaultArgs) ElementType 

func (VaultArgs) ElementType() reflect.Type

type VaultLock 

type VaultLock struct {
	pulumi.CustomResourceState

	// Boolean whether to permanently apply this Glacier Lock Policy. Once completed, this cannot be undone. If set to `false`, the Glacier Lock Policy remains in a testing mode for 24 hours. After that time, the Glacier Lock Policy is automatically removed by Glacier and the this provider resource will show as needing recreation. Changing this from `false` to `true` will show as resource recreation, which is expected. Changing this from `true` to `false` is not possible unless the Glacier Vault is recreated at the same time.
	CompleteLock pulumi.BoolOutput `pulumi:"completeLock"`
	// Allow this provider to ignore the error returned when attempting to delete the Glacier Lock Policy. This can be used to delete or recreate the Glacier Vault via this provider, for example, if the Glacier Vault Lock policy permits that action. This should only be used in conjunction with `completeLock` being set to `true`.
	IgnoreDeletionError pulumi.BoolPtrOutput `pulumi:"ignoreDeletionError"`
	// JSON string containing the IAM policy to apply as the Glacier Vault Lock policy.
	Policy pulumi.StringOutput `pulumi:"policy"`
	// The name of the Glacier Vault.
	VaultName pulumi.StringOutput `pulumi:"vaultName"`
}

Manages a Glacier Vault Lock. You can refer to the [Glacier Developer Guide](https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html) for a full explanation of the Glacier Vault Lock functionality.

> **NOTE:** This resource allows you to test Glacier Vault Lock policies by setting the `completeLock` argument to `false`. When testing policies in this manner, the Glacier Vault Lock automatically expires after 24 hours and this provider will show this resource as needing recreation after that time. To permanently apply the policy, set the `completeLock` argument to `true`. When changing `completeLock` to `true`, it is expected the resource will show as recreating.

!> **WARNING:** Once a Glacier Vault Lock is completed, it is immutable. The deletion of the Glacier Vault Lock is not be possible and attempting to remove it from this provider will return an error. Set the `ignoreDeletionError` argument to `true` and apply this configuration before attempting to delete this resource via this provider or remove this resource from this provider's management.

## Example Usage ### Testing Glacier Vault Lock Policy

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/glacier"
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/iam"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleVault, err := glacier.NewVault(ctx, "exampleVault", nil)
		if err != nil {
			return err
		}
		_, err = glacier.NewVaultLock(ctx, "exampleVaultLock", &glacier.VaultLockArgs{
			CompleteLock: pulumi.Bool(false),
			Policy: examplePolicyDocument.ApplyT(func(examplePolicyDocument iam.GetPolicyDocumentResult) (string, error) {
				return examplePolicyDocument.Json, nil
			}).(pulumi.StringOutput),
			VaultName: exampleVault.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Permanently Applying Glacier Vault Lock Policy

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/glacier"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := glacier.NewVaultLock(ctx, "example", &glacier.VaultLockArgs{
			CompleteLock: pulumi.Bool(true),
			Policy:       pulumi.Any(data.Aws_iam_policy_document.Example.Json),
			VaultName:    pulumi.Any(aws_glacier_vault.Example.Name),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetVaultLock 

func GetVaultLock(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *VaultLockState, opts ...pulumi.ResourceOption) (*VaultLock, error)

GetVaultLock gets an existing VaultLock resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewVaultLock 

func NewVaultLock(ctx *pulumi.Context,
	name string, args *VaultLockArgs, opts ...pulumi.ResourceOption) (*VaultLock, error)

NewVaultLock registers a new resource with the given unique name, arguments, and options.

type VaultLockArgs 

type VaultLockArgs struct {
	// Boolean whether to permanently apply this Glacier Lock Policy. Once completed, this cannot be undone. If set to `false`, the Glacier Lock Policy remains in a testing mode for 24 hours. After that time, the Glacier Lock Policy is automatically removed by Glacier and the this provider resource will show as needing recreation. Changing this from `false` to `true` will show as resource recreation, which is expected. Changing this from `true` to `false` is not possible unless the Glacier Vault is recreated at the same time.
	CompleteLock pulumi.BoolInput
	// Allow this provider to ignore the error returned when attempting to delete the Glacier Lock Policy. This can be used to delete or recreate the Glacier Vault via this provider, for example, if the Glacier Vault Lock policy permits that action. This should only be used in conjunction with `completeLock` being set to `true`.
	IgnoreDeletionError pulumi.BoolPtrInput
	// JSON string containing the IAM policy to apply as the Glacier Vault Lock policy.
	Policy pulumi.StringInput
	// The name of the Glacier Vault.
	VaultName pulumi.StringInput
}

The set of arguments for constructing a VaultLock resource.

func (VaultLockArgs) ElementType 

func (VaultLockArgs) ElementType() reflect.Type

type VaultLockState 

type VaultLockState struct {
	// Boolean whether to permanently apply this Glacier Lock Policy. Once completed, this cannot be undone. If set to `false`, the Glacier Lock Policy remains in a testing mode for 24 hours. After that time, the Glacier Lock Policy is automatically removed by Glacier and the this provider resource will show as needing recreation. Changing this from `false` to `true` will show as resource recreation, which is expected. Changing this from `true` to `false` is not possible unless the Glacier Vault is recreated at the same time.
	CompleteLock pulumi.BoolPtrInput
	// Allow this provider to ignore the error returned when attempting to delete the Glacier Lock Policy. This can be used to delete or recreate the Glacier Vault via this provider, for example, if the Glacier Vault Lock policy permits that action. This should only be used in conjunction with `completeLock` being set to `true`.
	IgnoreDeletionError pulumi.BoolPtrInput
	// JSON string containing the IAM policy to apply as the Glacier Vault Lock policy.
	Policy pulumi.StringPtrInput
	// The name of the Glacier Vault.
	VaultName pulumi.StringPtrInput
}

func (VaultLockState) ElementType 

func (VaultLockState) ElementType() reflect.Type

type VaultNotification 

type VaultNotification struct {
	// You can configure a vault to publish a notification for `ArchiveRetrievalCompleted` and `InventoryRetrievalCompleted` events.
	Events []string `pulumi:"events"`
	// The SNS Topic ARN.
	SnsTopic string `pulumi:"snsTopic"`
}

type VaultNotificationArgs 

type VaultNotificationArgs struct {
	// You can configure a vault to publish a notification for `ArchiveRetrievalCompleted` and `InventoryRetrievalCompleted` events.
	Events pulumi.StringArrayInput `pulumi:"events"`
	// The SNS Topic ARN.
	SnsTopic pulumi.StringInput `pulumi:"snsTopic"`
}

func (VaultNotificationArgs) ElementType 

func (VaultNotificationArgs) ElementType() reflect.Type

func (VaultNotificationArgs) ToVaultNotificationOutput 

func (i VaultNotificationArgs) ToVaultNotificationOutput() VaultNotificationOutput

func (VaultNotificationArgs) ToVaultNotificationOutputWithContext 

func (i VaultNotificationArgs) ToVaultNotificationOutputWithContext(ctx context.Context) VaultNotificationOutput

type VaultNotificationArray 

type VaultNotificationArray []VaultNotificationInput

func (VaultNotificationArray) ElementType 

func (VaultNotificationArray) ElementType() reflect.Type

func (VaultNotificationArray) ToVaultNotificationArrayOutput 

func (i VaultNotificationArray) ToVaultNotificationArrayOutput() VaultNotificationArrayOutput

func (VaultNotificationArray) ToVaultNotificationArrayOutputWithContext 

func (i VaultNotificationArray) ToVaultNotificationArrayOutputWithContext(ctx context.Context) VaultNotificationArrayOutput

type VaultNotificationArrayInput 

type VaultNotificationArrayInput interface {
	pulumi.Input

	ToVaultNotificationArrayOutput() VaultNotificationArrayOutput
	ToVaultNotificationArrayOutputWithContext(context.Context) VaultNotificationArrayOutput
}

VaultNotificationArrayInput is an input type that accepts VaultNotificationArray and VaultNotificationArrayOutput values. You can construct a concrete instance of `VaultNotificationArrayInput` via: 

VaultNotificationArray{ VaultNotificationArgs{...} }

type VaultNotificationArrayOutput 

type VaultNotificationArrayOutput struct{ *pulumi.OutputState }

func (VaultNotificationArrayOutput) ElementType 

func (VaultNotificationArrayOutput) ElementType() reflect.Type

func (VaultNotificationArrayOutput) Index 

func (o VaultNotificationArrayOutput) Index(i pulumi.IntInput) VaultNotificationOutput

func (VaultNotificationArrayOutput) ToVaultNotificationArrayOutput 

func (o VaultNotificationArrayOutput) ToVaultNotificationArrayOutput() VaultNotificationArrayOutput

func (VaultNotificationArrayOutput) ToVaultNotificationArrayOutputWithContext 

func (o VaultNotificationArrayOutput) ToVaultNotificationArrayOutputWithContext(ctx context.Context) VaultNotificationArrayOutput

type VaultNotificationInput 

type VaultNotificationInput interface {
	pulumi.Input

	ToVaultNotificationOutput() VaultNotificationOutput
	ToVaultNotificationOutputWithContext(context.Context) VaultNotificationOutput
}

VaultNotificationInput is an input type that accepts VaultNotificationArgs and VaultNotificationOutput values. You can construct a concrete instance of `VaultNotificationInput` via: 

VaultNotificationArgs{...}

type VaultNotificationOutput 

type VaultNotificationOutput struct{ *pulumi.OutputState }

func (VaultNotificationOutput) ElementType 

func (VaultNotificationOutput) ElementType() reflect.Type

func (VaultNotificationOutput) Events 

func (o VaultNotificationOutput) Events() pulumi.StringArrayOutput

You can configure a vault to publish a notification for `ArchiveRetrievalCompleted` and `InventoryRetrievalCompleted` events.

func (VaultNotificationOutput) SnsTopic 

func (o VaultNotificationOutput) SnsTopic() pulumi.StringOutput

The SNS Topic ARN.

func (VaultNotificationOutput) ToVaultNotificationOutput 

func (o VaultNotificationOutput) ToVaultNotificationOutput() VaultNotificationOutput

func (VaultNotificationOutput) ToVaultNotificationOutputWithContext 

func (o VaultNotificationOutput) ToVaultNotificationOutputWithContext(ctx context.Context) VaultNotificationOutput

type VaultState 

type VaultState struct {
	// The policy document. This is a JSON formatted string.
	// The heredoc syntax or `file` function is helpful here. Use the [Glacier Developer Guide](https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html) for more information on Glacier Vault Policy
	AccessPolicy pulumi.StringPtrInput
	// The ARN of the vault.
	Arn pulumi.StringPtrInput
	// The URI of the vault that was created.
	Location pulumi.StringPtrInput
	// The name of the Vault. Names can be between 1 and 255 characters long and the valid characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).
	Name pulumi.StringPtrInput
	// The notifications for the Vault. Fields documented below.
	Notifications VaultNotificationArrayInput
	// A map of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

func (VaultState) ElementType 

func (VaultState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.