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.
- 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 Policyname (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 mapping 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 forArchiveRetrievalCompleted
andInventoryRetrievalCompleted
events.snsTopic
(pulumi.Input[str]
) - The SNS Topic ARN.
This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/glacier_vault.html.markdown.
-
access_policy
= 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
= None¶ The ARN of the vault.
-
location
= None¶ The URI of the vault that was created.
-
name
= 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
= None¶ The notifications for the Vault. Fields documented below.
events
(list
) - You can configure a vault to publish a notification forArchiveRetrievalCompleted
andInventoryRetrievalCompleted
events.snsTopic
(str
) - The SNS Topic ARN.
A mapping 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 Policyarn (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 mapping 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 forArchiveRetrievalCompleted
andInventoryRetrievalCompleted
events.snsTopic
(pulumi.Input[str]
) - The SNS Topic ARN.
This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/glacier_vault.html.markdown.
-
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 tofalse
. 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 thecomplete_lock
argument totrue
. When changingcomplete_lock
totrue
, 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 totrue
and apply this configuration before attempting to delete this resource via this provider or remove this resource from this provider’s management.- 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 fromfalse
totrue
will show as resource recreation, which is expected. Changing this fromtrue
tofalse
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 totrue
.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
= 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 fromfalse
totrue
will show as resource recreation, which is expected. Changing this fromtrue
tofalse
is not possible unless the Glacier Vault is recreated at the same time.
-
ignore_deletion_error
= 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 totrue
.
-
policy
= None¶ JSON string containing the IAM policy to apply as the Glacier Vault Lock policy.
-
vault_name
= 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 fromfalse
totrue
will show as resource recreation, which is expected. Changing this fromtrue
tofalse
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 totrue
.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