This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

glacier¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.glacier.Vault(resource_name, opts=None, access_policy=None, name=None, notifications=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Glacier Vault Resource. You can refer to the Glacier Developer Guide for a full explanation of the Glacier Vault functionality

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

import pulumi
import pulumi_aws as aws

aws_sns_topic = aws.sns.Topic("awsSnsTopic")
my_archive = aws.glacier.Vault("myArchive",
    access_policy="""{
    "Version":"2012-10-17",
    "Statement":[
       {
          "Sid": "add-read-only-perm",
          "Principal": "*",
          "Effect": "Allow",
          "Action": [
             "glacier:InitiateJob",
             "glacier:GetJobOutput"
          ],
          "Resource": "arn:aws:glacier:eu-west-1:432981146916:vaults/MyArchive"
       }
    ]
}

""",
    notifications=[{
        "events": [
            "ArchiveRetrievalCompleted",
            "InventoryRetrievalCompleted",
        ],
        "sns_topic": aws_sns_topic.arn,
    }],
    tags={
        "Test": "MyArchive",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
access*policy (pulumi.Input[str]) –
The policy document. This is a JSON formatted string. The heredoc syntax or file function is helpful here. Use the Glacier Developer Guide for more information on Glacier Vault Policy
name (pulumi.Input[str]) – 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).
notifications (pulumi.Input[list]) – The notifications for the Vault. Fields documented below.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

The notifications object supports the following:

events (pulumi.Input[list]) - You can configure a vault to publish a notification for ArchiveRetrievalCompleted and InventoryRetrievalCompleted events.
sns_topic (pulumi.Input[str]) - The SNS Topic ARN.

access_policy: pulumi.Output[str] = None¶: The policy document. This is a JSON formatted string. The heredoc syntax or file function is helpful here. Use the Glacier Developer Guide for more information on Glacier Vault Policy

arn: pulumi.Output[str] = None¶: The ARN of the vault.

location: pulumi.Output[str] = None¶: The URI of the vault that was created.

name: pulumi.Output[str] = None¶: 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).

notifications: pulumi.Output[list] = None¶

The notifications for the Vault. Fields documented below.

events (list) - You can configure a vault to publish a notification for ArchiveRetrievalCompleted and InventoryRetrievalCompleted events.
sns_topic (str) - The SNS Topic ARN.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource.

static get(resource_name, id, opts=None, access_policy=None, arn=None, location=None, name=None, notifications=None, tags=None)¶

Get an existing Vault resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
access*policy (pulumi.Input[str]) –
The policy document. This is a JSON formatted string. The heredoc syntax or file function is helpful here. Use the Glacier Developer Guide for more information on Glacier Vault Policy
arn (pulumi.Input[str]) – The ARN of the vault.
location (pulumi.Input[str]) – The URI of the vault that was created.
name (pulumi.Input[str]) – 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).
notifications (pulumi.Input[list]) – The notifications for the Vault. Fields documented below.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

The notifications object supports the following:

events (pulumi.Input[list]) - You can configure a vault to publish a notification for ArchiveRetrievalCompleted and InventoryRetrievalCompleted events.
sns_topic (pulumi.Input[str]) - The SNS Topic ARN.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.glacier.VaultLock(resource_name, opts=None, complete_lock=None, ignore_deletion_error=None, policy=None, vault_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Glacier Vault Lock. You can refer to the Glacier Developer Guide for a full explanation of the Glacier Vault Lock functionality.

NOTE: This resource allows you to test Glacier Vault Lock policies by setting the complete_lock 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 complete_lock argument to true. When changing complete_lock 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 ignore_deletion_error 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.

import pulumi
import pulumi_aws as aws

example_vault = aws.glacier.Vault("exampleVault")
example_policy_document = example_vault.arn.apply(lambda arn: aws.iam.get_policy_document(statements=[{
    "actions": ["glacier:DeleteArchive"],
    "condition": [{
        "test": "NumericLessThanEquals",
        "values": ["365"],
        "variable": "glacier:ArchiveAgeinDays",
    }],
    "effect": "Deny",
    "resources": [arn],
}]))
example_vault_lock = aws.glacier.VaultLock("exampleVaultLock",
    complete_lock=False,
    policy=example_policy_document.json,
    vault_name=example_vault.name)

import pulumi
import pulumi_aws as aws

example = aws.glacier.VaultLock("example",
    complete_lock=True,
    policy=data["aws_iam_policy_document"]["example"]["json"],
    vault_name=aws_glacier_vault["example"]["name"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
complete_lock (pulumi.Input[bool]) – 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.
ignore_deletion_error (pulumi.Input[bool]) – 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 complete_lock being set to true.
policy (pulumi.Input[str]) – JSON string containing the IAM policy to apply as the Glacier Vault Lock policy.
vault_name (pulumi.Input[str]) – The name of the Glacier Vault.

complete_lock: pulumi.Output[bool] = None¶: 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.

ignore_deletion_error: pulumi.Output[bool] = None¶: 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 complete_lock being set to true.

policy: pulumi.Output[str] = None¶: JSON string containing the IAM policy to apply as the Glacier Vault Lock policy.

vault_name: pulumi.Output[str] = None¶: The name of the Glacier Vault.

static get(resource_name, id, opts=None, complete_lock=None, ignore_deletion_error=None, policy=None, vault_name=None)¶

Get an existing VaultLock resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
complete_lock (pulumi.Input[bool]) – 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.
ignore_deletion_error (pulumi.Input[bool]) – 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 complete_lock being set to true.
policy (pulumi.Input[str]) – JSON string containing the IAM policy to apply as the Glacier Vault Lock policy.
vault_name (pulumi.Input[str]) – The name of the Glacier Vault.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

glacier¶

On This Page