projetAnsible/myenv/lib/python3.12/site-packages/pulumi_docker/secret.py
2024-12-09 06:16:28 +01:00

258 lines
9.6 KiB
Python

# 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 sys
import pulumi
import pulumi.runtime
from typing import Any, Mapping, Optional, Sequence, Union, overload
if sys.version_info >= (3, 11):
from typing import NotRequired, TypedDict, TypeAlias
else:
from typing_extensions import NotRequired, TypedDict, TypeAlias
from . import _utilities
from . import outputs
from ._inputs import *
__all__ = ['SecretArgs', 'Secret']
@pulumi.input_type
class SecretArgs:
def __init__(__self__, *,
data: pulumi.Input[str],
labels: Optional[pulumi.Input[Sequence[pulumi.Input['SecretLabelArgs']]]] = None,
name: Optional[pulumi.Input[str]] = None):
"""
The set of arguments for constructing a Secret resource.
:param pulumi.Input[str] data: Base64-url-safe-encoded secret data
:param pulumi.Input[Sequence[pulumi.Input['SecretLabelArgs']]] labels: User-defined key/value metadata
:param pulumi.Input[str] name: User-defined name of the secret
"""
pulumi.set(__self__, "data", data)
if labels is not None:
pulumi.set(__self__, "labels", labels)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def data(self) -> pulumi.Input[str]:
"""
Base64-url-safe-encoded secret data
"""
return pulumi.get(self, "data")
@data.setter
def data(self, value: pulumi.Input[str]):
pulumi.set(self, "data", value)
@property
@pulumi.getter
def labels(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['SecretLabelArgs']]]]:
"""
User-defined key/value metadata
"""
return pulumi.get(self, "labels")
@labels.setter
def labels(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['SecretLabelArgs']]]]):
pulumi.set(self, "labels", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
User-defined name of the secret
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
@pulumi.input_type
class _SecretState:
def __init__(__self__, *,
data: Optional[pulumi.Input[str]] = None,
labels: Optional[pulumi.Input[Sequence[pulumi.Input['SecretLabelArgs']]]] = None,
name: Optional[pulumi.Input[str]] = None):
"""
Input properties used for looking up and filtering Secret resources.
:param pulumi.Input[str] data: Base64-url-safe-encoded secret data
:param pulumi.Input[Sequence[pulumi.Input['SecretLabelArgs']]] labels: User-defined key/value metadata
:param pulumi.Input[str] name: User-defined name of the secret
"""
if data is not None:
pulumi.set(__self__, "data", data)
if labels is not None:
pulumi.set(__self__, "labels", labels)
if name is not None:
pulumi.set(__self__, "name", name)
@property
@pulumi.getter
def data(self) -> Optional[pulumi.Input[str]]:
"""
Base64-url-safe-encoded secret data
"""
return pulumi.get(self, "data")
@data.setter
def data(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "data", value)
@property
@pulumi.getter
def labels(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['SecretLabelArgs']]]]:
"""
User-defined key/value metadata
"""
return pulumi.get(self, "labels")
@labels.setter
def labels(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['SecretLabelArgs']]]]):
pulumi.set(self, "labels", value)
@property
@pulumi.getter
def name(self) -> Optional[pulumi.Input[str]]:
"""
User-defined name of the secret
"""
return pulumi.get(self, "name")
@name.setter
def name(self, value: Optional[pulumi.Input[str]]):
pulumi.set(self, "name", value)
class Secret(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
data: Optional[pulumi.Input[str]] = None,
labels: Optional[pulumi.Input[Sequence[pulumi.Input[Union['SecretLabelArgs', 'SecretLabelArgsDict']]]]] = None,
name: Optional[pulumi.Input[str]] = None,
__props__=None):
"""
## Import
#!/bin/bash
Docker secret cannot be imported as the secret data, once set, is never exposed again.
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[str] data: Base64-url-safe-encoded secret data
:param pulumi.Input[Sequence[pulumi.Input[Union['SecretLabelArgs', 'SecretLabelArgsDict']]]] labels: User-defined key/value metadata
:param pulumi.Input[str] name: User-defined name of the secret
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: SecretArgs,
opts: Optional[pulumi.ResourceOptions] = None):
"""
## Import
#!/bin/bash
Docker secret cannot be imported as the secret data, once set, is never exposed again.
:param str resource_name: The name of the resource.
:param SecretArgs 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(SecretArgs, 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,
data: Optional[pulumi.Input[str]] = None,
labels: Optional[pulumi.Input[Sequence[pulumi.Input[Union['SecretLabelArgs', 'SecretLabelArgsDict']]]]] = None,
name: 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__ = SecretArgs.__new__(SecretArgs)
if data is None and not opts.urn:
raise TypeError("Missing required property 'data'")
__props__.__dict__["data"] = None if data is None else pulumi.Output.secret(data)
__props__.__dict__["labels"] = labels
__props__.__dict__["name"] = name
secret_opts = pulumi.ResourceOptions(additional_secret_outputs=["data"])
opts = pulumi.ResourceOptions.merge(opts, secret_opts)
super(Secret, __self__).__init__(
'docker:index/secret:Secret',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None,
data: Optional[pulumi.Input[str]] = None,
labels: Optional[pulumi.Input[Sequence[pulumi.Input[Union['SecretLabelArgs', 'SecretLabelArgsDict']]]]] = None,
name: Optional[pulumi.Input[str]] = None) -> 'Secret':
"""
Get an existing Secret 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] data: Base64-url-safe-encoded secret data
:param pulumi.Input[Sequence[pulumi.Input[Union['SecretLabelArgs', 'SecretLabelArgsDict']]]] labels: User-defined key/value metadata
:param pulumi.Input[str] name: User-defined name of the secret
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = _SecretState.__new__(_SecretState)
__props__.__dict__["data"] = data
__props__.__dict__["labels"] = labels
__props__.__dict__["name"] = name
return Secret(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter
def data(self) -> pulumi.Output[str]:
"""
Base64-url-safe-encoded secret data
"""
return pulumi.get(self, "data")
@property
@pulumi.getter
def labels(self) -> pulumi.Output[Optional[Sequence['outputs.SecretLabel']]]:
"""
User-defined key/value metadata
"""
return pulumi.get(self, "labels")
@property
@pulumi.getter
def name(self) -> pulumi.Output[str]:
"""
User-defined name of the secret
"""
return pulumi.get(self, "name")