Docs Packages
  1. Packages
  2. HashiCorp Vault
  3. API Docs
  4. aws
  5. AuthBackendCert
HashiCorp Vault v6.2.0 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-vault

vault.aws.AuthBackendCert

Explore with Pulumi AI

vault logo
HashiCorp Vault v6.2.0 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-vault

    Example Usage

    Create AuthBackendCert Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AuthBackendCert(name: string, args: AuthBackendCertArgs, opts?: CustomResourceOptions);
    @overload
def AuthBackendCert(resource_name: str,
                    args: AuthBackendCertArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def AuthBackendCert(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    aws_public_cert: Optional[str] = None,
                    cert_name: Optional[str] = None,
                    backend: Optional[str] = None,
                    namespace: Optional[str] = None,
                    type: Optional[str] = None)
    func NewAuthBackendCert(ctx *Context, name string, args AuthBackendCertArgs, opts ...ResourceOption) (*AuthBackendCert, error)
    public AuthBackendCert(string name, AuthBackendCertArgs args, CustomResourceOptions? opts = null)
    public AuthBackendCert(String name, AuthBackendCertArgs args)
public AuthBackendCert(String name, AuthBackendCertArgs args, CustomResourceOptions options)

    type: vault:aws:AuthBackendCert
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AuthBackendCertArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AuthBackendCertArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AuthBackendCertArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthBackendCertArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthBackendCertArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var authBackendCertResource = new Vault.Aws.AuthBackendCert("authBackendCertResource", new()
{
    AwsPublicCert = "string",
    CertName = "string",
    Backend = "string",
    Namespace = "string",
    Type = "string",
});

    example, err := aws.NewAuthBackendCert(ctx, "authBackendCertResource", &aws.AuthBackendCertArgs{
	AwsPublicCert: pulumi.String("string"),
	CertName:      pulumi.String("string"),
	Backend:       pulumi.String("string"),
	Namespace:     pulumi.String("string"),
	Type:          pulumi.String("string"),
})

    var authBackendCertResource = new AuthBackendCert("authBackendCertResource", AuthBackendCertArgs.builder()
    .awsPublicCert("string")
    .certName("string")
    .backend("string")
    .namespace("string")
    .type("string")
    .build());

    auth_backend_cert_resource = vault.aws.AuthBackendCert("authBackendCertResource",
    aws_public_cert="string",
    cert_name="string",
    backend="string",
    namespace="string",
    type="string")

    const authBackendCertResource = new vault.aws.AuthBackendCert("authBackendCertResource", {
    awsPublicCert: "string",
    certName: "string",
    backend: "string",
    namespace: "string",
    type: "string",
});

    type: vault:aws:AuthBackendCert
properties:
    awsPublicCert: string
    backend: string
    certName: string
    namespace: string
    type: string

    AuthBackendCert Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AuthBackendCert resource accepts the following input properties:

    AwsPublicCert string
    The Base64 encoded AWS Public key required to verify PKCS7 signature of the EC2 instance metadata. You can find this key in the AWS documentation.
    CertName string
    The name of the certificate.
    Backend string
    The path the AWS auth backend being configured was mounted at. Defaults to aws.
    Namespace string
    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. Available only for Vault Enterprise.
    Type string
    Either "pkcs7" or "identity", indicating the type of document which can be verified using the given certificate. Defaults to "pkcs7".
    AwsPublicCert string
    The Base64 encoded AWS Public key required to verify PKCS7 signature of the EC2 instance metadata. You can find this key in the AWS documentation.
    CertName string
    The name of the certificate.
    Backend string
    The path the AWS auth backend being configured was mounted at. Defaults to aws.
    Namespace string
    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. Available only for Vault Enterprise.
    Type string
    Either "pkcs7" or "identity", indicating the type of document which can be verified using the given certificate. Defaults to "pkcs7".
    awsPublicCert String
    The Base64 encoded AWS Public key required to verify PKCS7 signature of the EC2 instance metadata. You can find this key in the AWS documentation.
    certName String
    The name of the certificate.
    backend String
    The path the AWS auth backend being configured was mounted at. Defaults to aws.
    namespace String
    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. Available only for Vault Enterprise.
    type String
    Either "pkcs7" or "identity", indicating the type of document which can be verified using the given certificate. Defaults to "pkcs7".
    awsPublicCert string
    The Base64 encoded AWS Public key required to verify PKCS7 signature of the EC2 instance metadata. You can find this key in the AWS documentation.
    certName string
    The name of the certificate.
    backend string
    The path the AWS auth backend being configured was mounted at. Defaults to aws.
    namespace string
    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. Available only for Vault Enterprise.
    type string
    Either "pkcs7" or "identity", indicating the type of document which can be verified using the given certificate. Defaults to "pkcs7".
    aws_public_cert str
    The Base64 encoded AWS Public key required to verify PKCS7 signature of the EC2 instance metadata. You can find this key in the AWS documentation.
    cert_name str
    The name of the certificate.
    backend str
    The path the AWS auth backend being configured was mounted at. Defaults to aws.
    namespace 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. Available only for Vault Enterprise.
    type str
    Either "pkcs7" or "identity", indicating the type of document which can be verified using the given certificate. Defaults to "pkcs7".
    awsPublicCert String
    The Base64 encoded AWS Public key required to verify PKCS7 signature of the EC2 instance metadata. You can find this key in the AWS documentation.
    certName String
    The name of the certificate.
    backend String
    The path the AWS auth backend being configured was mounted at. Defaults to aws.
    namespace String
    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. Available only for Vault Enterprise.
    type String
    Either "pkcs7" or "identity", indicating the type of document which can be verified using the given certificate. Defaults to "pkcs7".

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AuthBackendCert resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AuthBackendCert Resource

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

    public static get(name: string, id: Input<ID>, state?: AuthBackendCertState, opts?: CustomResourceOptions): AuthBackendCert
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws_public_cert: Optional[str] = None,
        backend: Optional[str] = None,
        cert_name: Optional[str] = None,
        namespace: Optional[str] = None,
        type: Optional[str] = None) -> AuthBackendCert
    func GetAuthBackendCert(ctx *Context, name string, id IDInput, state *AuthBackendCertState, opts ...ResourceOption) (*AuthBackendCert, error)
    public static AuthBackendCert Get(string name, Input<string> id, AuthBackendCertState? state, CustomResourceOptions? opts = null)
    public static AuthBackendCert get(String name, Output<String> id, AuthBackendCertState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AwsPublicCert string
    The Base64 encoded AWS Public key required to verify PKCS7 signature of the EC2 instance metadata. You can find this key in the AWS documentation.
    Backend string
    The path the AWS auth backend being configured was mounted at. Defaults to aws.
    CertName string
    The name of the certificate.
    Namespace string
    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. Available only for Vault Enterprise.
    Type string
    Either "pkcs7" or "identity", indicating the type of document which can be verified using the given certificate. Defaults to "pkcs7".
    AwsPublicCert string
    The Base64 encoded AWS Public key required to verify PKCS7 signature of the EC2 instance metadata. You can find this key in the AWS documentation.
    Backend string
    The path the AWS auth backend being configured was mounted at. Defaults to aws.
    CertName string
    The name of the certificate.
    Namespace string
    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. Available only for Vault Enterprise.
    Type string
    Either "pkcs7" or "identity", indicating the type of document which can be verified using the given certificate. Defaults to "pkcs7".
    awsPublicCert String
    The Base64 encoded AWS Public key required to verify PKCS7 signature of the EC2 instance metadata. You can find this key in the AWS documentation.
    backend String
    The path the AWS auth backend being configured was mounted at. Defaults to aws.
    certName String
    The name of the certificate.
    namespace String
    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. Available only for Vault Enterprise.
    type String
    Either "pkcs7" or "identity", indicating the type of document which can be verified using the given certificate. Defaults to "pkcs7".
    awsPublicCert string
    The Base64 encoded AWS Public key required to verify PKCS7 signature of the EC2 instance metadata. You can find this key in the AWS documentation.
    backend string
    The path the AWS auth backend being configured was mounted at. Defaults to aws.
    certName string
    The name of the certificate.
    namespace string
    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. Available only for Vault Enterprise.
    type string
    Either "pkcs7" or "identity", indicating the type of document which can be verified using the given certificate. Defaults to "pkcs7".
    aws_public_cert str
    The Base64 encoded AWS Public key required to verify PKCS7 signature of the EC2 instance metadata. You can find this key in the AWS documentation.
    backend str
    The path the AWS auth backend being configured was mounted at. Defaults to aws.
    cert_name str
    The name of the certificate.
    namespace 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. Available only for Vault Enterprise.
    type str
    Either "pkcs7" or "identity", indicating the type of document which can be verified using the given certificate. Defaults to "pkcs7".
    awsPublicCert String
    The Base64 encoded AWS Public key required to verify PKCS7 signature of the EC2 instance metadata. You can find this key in the AWS documentation.
    backend String
    The path the AWS auth backend being configured was mounted at. Defaults to aws.
    certName String
    The name of the certificate.
    namespace String
    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. Available only for Vault Enterprise.
    type String
    Either "pkcs7" or "identity", indicating the type of document which can be verified using the given certificate. Defaults to "pkcs7".

    Import

    AWS auth backend certificates can be imported using auth/, the backend path, /config/certificate/, and the cert_name e.g.

    $ pulumi import vault:aws/authBackendCert:AuthBackendCert example auth/aws/config/certificate/my-cert

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Vault pulumi/pulumi-vault
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vault Terraform Provider.
    vault logo
    HashiCorp Vault v6.2.0 published on Friday, Jun 21, 2024 by Pulumi
    pulumi/pulumi-vault