pulumi-vault 5.19.0a1705621752__py3-none-any.whl → 5.20.0__py3-none-any.whl

pulumi_vault/secrets/sync_aws_destination.py

@@ -0,0 +1,564 @@
+# coding=utf-8
+# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+import warnings
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+from .. import _utilities
+
+__all__ = ['SyncAwsDestinationArgs', 'SyncAwsDestination']
+
+@pulumi.input_type
+class SyncAwsDestinationArgs:
+    def __init__(__self__, *,
+                 access_key_id: Optional[pulumi.Input[str]] = None,
+                 custom_tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
+                 name: Optional[pulumi.Input[str]] = None,
+                 namespace: Optional[pulumi.Input[str]] = None,
+                 region: Optional[pulumi.Input[str]] = None,
+                 secret_access_key: Optional[pulumi.Input[str]] = None,
+                 secret_name_template: Optional[pulumi.Input[str]] = None):
+        """
+        The set of arguments for constructing a SyncAwsDestination resource.
+        :param pulumi.Input[str] access_key_id: Access key id to authenticate against the AWS secrets manager.
+               Can be omitted and directly provided to Vault using the `AWS_ACCESS_KEY_ID` environment
+               variable.
+        :param pulumi.Input[Mapping[str, Any]] custom_tags: Custom tags to set on the secret managed at the destination.
+        :param pulumi.Input[str] name: Unique name of the AWS destination.
+        :param pulumi.Input[str] namespace: The namespace to provision the resource in.
+               The value should not contain leading or trailing forward slashes.
+               The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
+        :param pulumi.Input[str] region: Region where to manage the secrets manager entries.
+               Can be omitted and directly provided to Vault using the `AWS_REGION` environment
+               variable.
+        :param pulumi.Input[str] secret_access_key: Secret access key to authenticate against the AWS secrets manager.
+               Can be omitted and directly provided to Vault using the `AWS_SECRET_ACCESS_KEY` environment
+               variable.
+        :param pulumi.Input[str] secret_name_template: Template describing how to generate external secret names.
+               Supports a subset of the Go Template syntax.
+        """
+        if access_key_id is not None:
+            pulumi.set(__self__, "access_key_id", access_key_id)
+        if custom_tags is not None:
+            pulumi.set(__self__, "custom_tags", custom_tags)
+        if name is not None:
+            pulumi.set(__self__, "name", name)
+        if namespace is not None:
+            pulumi.set(__self__, "namespace", namespace)
+        if region is not None:
+            pulumi.set(__self__, "region", region)
+        if secret_access_key is not None:
+            pulumi.set(__self__, "secret_access_key", secret_access_key)
+        if secret_name_template is not None:
+            pulumi.set(__self__, "secret_name_template", secret_name_template)
+
+    @property
+    @pulumi.getter(name="accessKeyId")
+    def access_key_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        Access key id to authenticate against the AWS secrets manager.
+        Can be omitted and directly provided to Vault using the `AWS_ACCESS_KEY_ID` environment
+        variable.
+        """
+        return pulumi.get(self, "access_key_id")
+
+    @access_key_id.setter
+    def access_key_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "access_key_id", value)
+
+    @property
+    @pulumi.getter(name="customTags")
+    def custom_tags(self) -> Optional[pulumi.Input[Mapping[str, Any]]]:
+        """
+        Custom tags to set on the secret managed at the destination.
+        """
+        return pulumi.get(self, "custom_tags")
+
+    @custom_tags.setter
+    def custom_tags(self, value: Optional[pulumi.Input[Mapping[str, Any]]]):
+        pulumi.set(self, "custom_tags", value)
+
+    @property
+    @pulumi.getter
+    def name(self) -> Optional[pulumi.Input[str]]:
+        """
+        Unique name of the AWS destination.
+        """
+        return pulumi.get(self, "name")
+
+    @name.setter
+    def name(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "name", value)
+
+    @property
+    @pulumi.getter
+    def namespace(self) -> Optional[pulumi.Input[str]]:
+        """
+        The namespace to provision the resource in.
+        The value should not contain leading or trailing forward slashes.
+        The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
+        """
+        return pulumi.get(self, "namespace")
+
+    @namespace.setter
+    def namespace(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "namespace", value)
+
+    @property
+    @pulumi.getter
+    def region(self) -> Optional[pulumi.Input[str]]:
+        """
+        Region where to manage the secrets manager entries.
+        Can be omitted and directly provided to Vault using the `AWS_REGION` environment
+        variable.
+        """
+        return pulumi.get(self, "region")
+
+    @region.setter
+    def region(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "region", value)
+
+    @property
+    @pulumi.getter(name="secretAccessKey")
+    def secret_access_key(self) -> Optional[pulumi.Input[str]]:
+        """
+        Secret access key to authenticate against the AWS secrets manager.
+        Can be omitted and directly provided to Vault using the `AWS_SECRET_ACCESS_KEY` environment
+        variable.
+        """
+        return pulumi.get(self, "secret_access_key")
+
+    @secret_access_key.setter
+    def secret_access_key(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "secret_access_key", value)
+
+    @property
+    @pulumi.getter(name="secretNameTemplate")
+    def secret_name_template(self) -> Optional[pulumi.Input[str]]:
+        """
+        Template describing how to generate external secret names.
+        Supports a subset of the Go Template syntax.
+        """
+        return pulumi.get(self, "secret_name_template")
+
+    @secret_name_template.setter
+    def secret_name_template(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "secret_name_template", value)
+
+
+@pulumi.input_type
+class _SyncAwsDestinationState:
+    def __init__(__self__, *,
+                 access_key_id: Optional[pulumi.Input[str]] = None,
+                 custom_tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
+                 name: Optional[pulumi.Input[str]] = None,
+                 namespace: Optional[pulumi.Input[str]] = None,
+                 region: Optional[pulumi.Input[str]] = None,
+                 secret_access_key: Optional[pulumi.Input[str]] = None,
+                 secret_name_template: Optional[pulumi.Input[str]] = None,
+                 type: Optional[pulumi.Input[str]] = None):
+        """
+        Input properties used for looking up and filtering SyncAwsDestination resources.
+        :param pulumi.Input[str] access_key_id: Access key id to authenticate against the AWS secrets manager.
+               Can be omitted and directly provided to Vault using the `AWS_ACCESS_KEY_ID` environment
+               variable.
+        :param pulumi.Input[Mapping[str, Any]] custom_tags: Custom tags to set on the secret managed at the destination.
+        :param pulumi.Input[str] name: Unique name of the AWS destination.
+        :param pulumi.Input[str] namespace: The namespace to provision the resource in.
+               The value should not contain leading or trailing forward slashes.
+               The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
+        :param pulumi.Input[str] region: Region where to manage the secrets manager entries.
+               Can be omitted and directly provided to Vault using the `AWS_REGION` environment
+               variable.
+        :param pulumi.Input[str] secret_access_key: Secret access key to authenticate against the AWS secrets manager.
+               Can be omitted and directly provided to Vault using the `AWS_SECRET_ACCESS_KEY` environment
+               variable.
+        :param pulumi.Input[str] secret_name_template: Template describing how to generate external secret names.
+               Supports a subset of the Go Template syntax.
+        :param pulumi.Input[str] type: The type of the secrets destination (`aws-sm`).
+        """
+        if access_key_id is not None:
+            pulumi.set(__self__, "access_key_id", access_key_id)
+        if custom_tags is not None:
+            pulumi.set(__self__, "custom_tags", custom_tags)
+        if name is not None:
+            pulumi.set(__self__, "name", name)
+        if namespace is not None:
+            pulumi.set(__self__, "namespace", namespace)
+        if region is not None:
+            pulumi.set(__self__, "region", region)
+        if secret_access_key is not None:
+            pulumi.set(__self__, "secret_access_key", secret_access_key)
+        if secret_name_template is not None:
+            pulumi.set(__self__, "secret_name_template", secret_name_template)
+        if type is not None:
+            pulumi.set(__self__, "type", type)
+
+    @property
+    @pulumi.getter(name="accessKeyId")
+    def access_key_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        Access key id to authenticate against the AWS secrets manager.
+        Can be omitted and directly provided to Vault using the `AWS_ACCESS_KEY_ID` environment
+        variable.
+        """
+        return pulumi.get(self, "access_key_id")
+
+    @access_key_id.setter
+    def access_key_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "access_key_id", value)
+
+    @property
+    @pulumi.getter(name="customTags")
+    def custom_tags(self) -> Optional[pulumi.Input[Mapping[str, Any]]]:
+        """
+        Custom tags to set on the secret managed at the destination.
+        """
+        return pulumi.get(self, "custom_tags")
+
+    @custom_tags.setter
+    def custom_tags(self, value: Optional[pulumi.Input[Mapping[str, Any]]]):
+        pulumi.set(self, "custom_tags", value)
+
+    @property
+    @pulumi.getter
+    def name(self) -> Optional[pulumi.Input[str]]:
+        """
+        Unique name of the AWS destination.
+        """
+        return pulumi.get(self, "name")
+
+    @name.setter
+    def name(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "name", value)
+
+    @property
+    @pulumi.getter
+    def namespace(self) -> Optional[pulumi.Input[str]]:
+        """
+        The namespace to provision the resource in.
+        The value should not contain leading or trailing forward slashes.
+        The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
+        """
+        return pulumi.get(self, "namespace")
+
+    @namespace.setter
+    def namespace(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "namespace", value)
+
+    @property
+    @pulumi.getter
+    def region(self) -> Optional[pulumi.Input[str]]:
+        """
+        Region where to manage the secrets manager entries.
+        Can be omitted and directly provided to Vault using the `AWS_REGION` environment
+        variable.
+        """
+        return pulumi.get(self, "region")
+
+    @region.setter
+    def region(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "region", value)
+
+    @property
+    @pulumi.getter(name="secretAccessKey")
+    def secret_access_key(self) -> Optional[pulumi.Input[str]]:
+        """
+        Secret access key to authenticate against the AWS secrets manager.
+        Can be omitted and directly provided to Vault using the `AWS_SECRET_ACCESS_KEY` environment
+        variable.
+        """
+        return pulumi.get(self, "secret_access_key")
+
+    @secret_access_key.setter
+    def secret_access_key(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "secret_access_key", value)
+
+    @property
+    @pulumi.getter(name="secretNameTemplate")
+    def secret_name_template(self) -> Optional[pulumi.Input[str]]:
+        """
+        Template describing how to generate external secret names.
+        Supports a subset of the Go Template syntax.
+        """
+        return pulumi.get(self, "secret_name_template")
+
+    @secret_name_template.setter
+    def secret_name_template(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "secret_name_template", value)
+
+    @property
+    @pulumi.getter
+    def type(self) -> Optional[pulumi.Input[str]]:
+        """
+        The type of the secrets destination (`aws-sm`).
+        """
+        return pulumi.get(self, "type")
+
+    @type.setter
+    def type(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "type", value)
+
+
+class SyncAwsDestination(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 access_key_id: Optional[pulumi.Input[str]] = None,
+                 custom_tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
+                 name: Optional[pulumi.Input[str]] = None,
+                 namespace: Optional[pulumi.Input[str]] = None,
+                 region: Optional[pulumi.Input[str]] = None,
+                 secret_access_key: Optional[pulumi.Input[str]] = None,
+                 secret_name_template: Optional[pulumi.Input[str]] = None,
+                 __props__=None):
+        """
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_vault as vault
+
+        aws = vault.secrets.SyncAwsDestination("aws",
+            access_key_id=var["access_key_id"],
+            secret_access_key=var["secret_access_key"],
+            region="us-east-1",
+            secret_name_template="vault_{{ .MountAccessor | lowercase }}_{{ .SecretPath | lowercase }}",
+            custom_tags={
+                "foo": "bar",
+            })
+        ```
+
+        ## Import
+
+        AWS Secrets sync destinations can be imported using the `name`, e.g.
+
+        ```sh
+         $ pulumi import vault:secrets/syncAwsDestination:SyncAwsDestination aws aws-dest
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[str] access_key_id: Access key id to authenticate against the AWS secrets manager.
+               Can be omitted and directly provided to Vault using the `AWS_ACCESS_KEY_ID` environment
+               variable.
+        :param pulumi.Input[Mapping[str, Any]] custom_tags: Custom tags to set on the secret managed at the destination.
+        :param pulumi.Input[str] name: Unique name of the AWS destination.
+        :param pulumi.Input[str] namespace: The namespace to provision the resource in.
+               The value should not contain leading or trailing forward slashes.
+               The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
+        :param pulumi.Input[str] region: Region where to manage the secrets manager entries.
+               Can be omitted and directly provided to Vault using the `AWS_REGION` environment
+               variable.
+        :param pulumi.Input[str] secret_access_key: Secret access key to authenticate against the AWS secrets manager.
+               Can be omitted and directly provided to Vault using the `AWS_SECRET_ACCESS_KEY` environment
+               variable.
+        :param pulumi.Input[str] secret_name_template: Template describing how to generate external secret names.
+               Supports a subset of the Go Template syntax.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: Optional[SyncAwsDestinationArgs] = None,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_vault as vault
+
+        aws = vault.secrets.SyncAwsDestination("aws",
+            access_key_id=var["access_key_id"],
+            secret_access_key=var["secret_access_key"],
+            region="us-east-1",
+            secret_name_template="vault_{{ .MountAccessor | lowercase }}_{{ .SecretPath | lowercase }}",
+            custom_tags={
+                "foo": "bar",
+            })
+        ```
+
+        ## Import
+
+        AWS Secrets sync destinations can be imported using the `name`, e.g.
+
+        ```sh
+         $ pulumi import vault:secrets/syncAwsDestination:SyncAwsDestination aws aws-dest
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param SyncAwsDestinationArgs args: The arguments to use to populate this resource's properties.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        ...
+    def __init__(__self__, resource_name: str, *args, **kwargs):
+        resource_args, opts = _utilities.get_resource_args_opts(SyncAwsDestinationArgs, pulumi.ResourceOptions, *args, **kwargs)
+        if resource_args is not None:
+            __self__._internal_init(resource_name, opts, **resource_args.__dict__)
+        else:
+            __self__._internal_init(resource_name, *args, **kwargs)
+
+    def _internal_init(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 access_key_id: Optional[pulumi.Input[str]] = None,
+                 custom_tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
+                 name: Optional[pulumi.Input[str]] = None,
+                 namespace: Optional[pulumi.Input[str]] = None,
+                 region: Optional[pulumi.Input[str]] = None,
+                 secret_access_key: Optional[pulumi.Input[str]] = None,
+                 secret_name_template: Optional[pulumi.Input[str]] = None,
+                 __props__=None):
+        opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
+        if not isinstance(opts, pulumi.ResourceOptions):
+            raise TypeError('Expected resource options to be a ResourceOptions instance')
+        if opts.id is None:
+            if __props__ is not None:
+                raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
+            __props__ = SyncAwsDestinationArgs.__new__(SyncAwsDestinationArgs)
+
+            __props__.__dict__["access_key_id"] = access_key_id
+            __props__.__dict__["custom_tags"] = custom_tags
+            __props__.__dict__["name"] = name
+            __props__.__dict__["namespace"] = namespace
+            __props__.__dict__["region"] = region
+            __props__.__dict__["secret_access_key"] = None if secret_access_key is None else pulumi.Output.secret(secret_access_key)
+            __props__.__dict__["secret_name_template"] = secret_name_template
+            __props__.__dict__["type"] = None
+        secret_opts = pulumi.ResourceOptions(additional_secret_outputs=["secretAccessKey"])
+        opts = pulumi.ResourceOptions.merge(opts, secret_opts)
+        super(SyncAwsDestination, __self__).__init__(
+            'vault:secrets/syncAwsDestination:SyncAwsDestination',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            access_key_id: Optional[pulumi.Input[str]] = None,
+            custom_tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
+            name: Optional[pulumi.Input[str]] = None,
+            namespace: Optional[pulumi.Input[str]] = None,
+            region: Optional[pulumi.Input[str]] = None,
+            secret_access_key: Optional[pulumi.Input[str]] = None,
+            secret_name_template: Optional[pulumi.Input[str]] = None,
+            type: Optional[pulumi.Input[str]] = None) -> 'SyncAwsDestination':
+        """
+        Get an existing SyncAwsDestination resource's state with the given name, id, and optional extra
+        properties used to qualify the lookup.
+
+        :param str resource_name: The unique name of the resulting resource.
+        :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[str] access_key_id: Access key id to authenticate against the AWS secrets manager.
+               Can be omitted and directly provided to Vault using the `AWS_ACCESS_KEY_ID` environment
+               variable.
+        :param pulumi.Input[Mapping[str, Any]] custom_tags: Custom tags to set on the secret managed at the destination.
+        :param pulumi.Input[str] name: Unique name of the AWS destination.
+        :param pulumi.Input[str] namespace: The namespace to provision the resource in.
+               The value should not contain leading or trailing forward slashes.
+               The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
+        :param pulumi.Input[str] region: Region where to manage the secrets manager entries.
+               Can be omitted and directly provided to Vault using the `AWS_REGION` environment
+               variable.
+        :param pulumi.Input[str] secret_access_key: Secret access key to authenticate against the AWS secrets manager.
+               Can be omitted and directly provided to Vault using the `AWS_SECRET_ACCESS_KEY` environment
+               variable.
+        :param pulumi.Input[str] secret_name_template: Template describing how to generate external secret names.
+               Supports a subset of the Go Template syntax.
+        :param pulumi.Input[str] type: The type of the secrets destination (`aws-sm`).
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _SyncAwsDestinationState.__new__(_SyncAwsDestinationState)
+
+        __props__.__dict__["access_key_id"] = access_key_id
+        __props__.__dict__["custom_tags"] = custom_tags
+        __props__.__dict__["name"] = name
+        __props__.__dict__["namespace"] = namespace
+        __props__.__dict__["region"] = region
+        __props__.__dict__["secret_access_key"] = secret_access_key
+        __props__.__dict__["secret_name_template"] = secret_name_template
+        __props__.__dict__["type"] = type
+        return SyncAwsDestination(resource_name, opts=opts, __props__=__props__)
+
+    @property
+    @pulumi.getter(name="accessKeyId")
+    def access_key_id(self) -> pulumi.Output[Optional[str]]:
+        """
+        Access key id to authenticate against the AWS secrets manager.
+        Can be omitted and directly provided to Vault using the `AWS_ACCESS_KEY_ID` environment
+        variable.
+        """
+        return pulumi.get(self, "access_key_id")
+
+    @property
+    @pulumi.getter(name="customTags")
+    def custom_tags(self) -> pulumi.Output[Optional[Mapping[str, Any]]]:
+        """
+        Custom tags to set on the secret managed at the destination.
+        """
+        return pulumi.get(self, "custom_tags")
+
+    @property
+    @pulumi.getter
+    def name(self) -> pulumi.Output[str]:
+        """
+        Unique name of the AWS destination.
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter
+    def namespace(self) -> pulumi.Output[Optional[str]]:
+        """
+        The namespace to provision the resource in.
+        The value should not contain leading or trailing forward slashes.
+        The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault#namespace).
+        """
+        return pulumi.get(self, "namespace")
+
+    @property
+    @pulumi.getter
+    def region(self) -> pulumi.Output[Optional[str]]:
+        """
+        Region where to manage the secrets manager entries.
+        Can be omitted and directly provided to Vault using the `AWS_REGION` environment
+        variable.
+        """
+        return pulumi.get(self, "region")
+
+    @property
+    @pulumi.getter(name="secretAccessKey")
+    def secret_access_key(self) -> pulumi.Output[Optional[str]]:
+        """
+        Secret access key to authenticate against the AWS secrets manager.
+        Can be omitted and directly provided to Vault using the `AWS_SECRET_ACCESS_KEY` environment
+        variable.
+        """
+        return pulumi.get(self, "secret_access_key")
+
+    @property
+    @pulumi.getter(name="secretNameTemplate")
+    def secret_name_template(self) -> pulumi.Output[str]:
+        """
+        Template describing how to generate external secret names.
+        Supports a subset of the Go Template syntax.
+        """
+        return pulumi.get(self, "secret_name_template")
+
+    @property
+    @pulumi.getter
+    def type(self) -> pulumi.Output[str]:
+        """
+        The type of the secrets destination (`aws-sm`).
+        """
+        return pulumi.get(self, "type")
+