1. Packages
  2. AWS Classic
  3. API Docs
  4. dms
  5. Certificate

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

aws.dms.Certificate

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

    Provides a DMS (Data Migration Service) certificate resource. DMS certificates can be created, deleted, and imported.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    // Create a new certificate
    const test = new aws.dms.Certificate("test", {
        certificateId: "test-dms-certificate-tf",
        certificatePem: "...",
        tags: {
            Name: "test",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    # Create a new certificate
    test = aws.dms.Certificate("test",
        certificate_id="test-dms-certificate-tf",
        certificate_pem="...",
        tags={
            "Name": "test",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/dms"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Create a new certificate
    		_, err := dms.NewCertificate(ctx, "test", &dms.CertificateArgs{
    			CertificateId:  pulumi.String("test-dms-certificate-tf"),
    			CertificatePem: pulumi.String("..."),
    			Tags: pulumi.StringMap{
    				"Name": pulumi.String("test"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        // Create a new certificate
        var test = new Aws.Dms.Certificate("test", new()
        {
            CertificateId = "test-dms-certificate-tf",
            CertificatePem = "...",
            Tags = 
            {
                { "Name", "test" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.dms.Certificate;
    import com.pulumi.aws.dms.CertificateArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            // Create a new certificate
            var test = new Certificate("test", CertificateArgs.builder()
                .certificateId("test-dms-certificate-tf")
                .certificatePem("...")
                .tags(Map.of("Name", "test"))
                .build());
    
        }
    }
    
    resources:
      # Create a new certificate
      test:
        type: aws:dms:Certificate
        properties:
          certificateId: test-dms-certificate-tf
          certificatePem: '...'
          tags:
            Name: test
    

    Create Certificate Resource

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

    Constructor syntax

    new Certificate(name: string, args: CertificateArgs, opts?: CustomResourceOptions);
    @overload
    def Certificate(resource_name: str,
                    args: CertificateArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def Certificate(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    certificate_id: Optional[str] = None,
                    certificate_pem: Optional[str] = None,
                    certificate_wallet: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None)
    func NewCertificate(ctx *Context, name string, args CertificateArgs, opts ...ResourceOption) (*Certificate, error)
    public Certificate(string name, CertificateArgs args, CustomResourceOptions? opts = null)
    public Certificate(String name, CertificateArgs args)
    public Certificate(String name, CertificateArgs args, CustomResourceOptions options)
    
    type: aws:dms:Certificate
    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 CertificateArgs
    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 CertificateArgs
    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 CertificateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CertificateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CertificateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var examplecertificateResourceResourceFromDmscertificate = new Aws.Dms.Certificate("examplecertificateResourceResourceFromDmscertificate", new()
    {
        CertificateId = "string",
        CertificatePem = "string",
        CertificateWallet = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := dms.NewCertificate(ctx, "examplecertificateResourceResourceFromDmscertificate", &dms.CertificateArgs{
    	CertificateId:     pulumi.String("string"),
    	CertificatePem:    pulumi.String("string"),
    	CertificateWallet: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var examplecertificateResourceResourceFromDmscertificate = new Certificate("examplecertificateResourceResourceFromDmscertificate", CertificateArgs.builder()
        .certificateId("string")
        .certificatePem("string")
        .certificateWallet("string")
        .tags(Map.of("string", "string"))
        .build());
    
    examplecertificate_resource_resource_from_dmscertificate = aws.dms.Certificate("examplecertificateResourceResourceFromDmscertificate",
        certificate_id="string",
        certificate_pem="string",
        certificate_wallet="string",
        tags={
            "string": "string",
        })
    
    const examplecertificateResourceResourceFromDmscertificate = new aws.dms.Certificate("examplecertificateResourceResourceFromDmscertificate", {
        certificateId: "string",
        certificatePem: "string",
        certificateWallet: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:dms:Certificate
    properties:
        certificateId: string
        certificatePem: string
        certificateWallet: string
        tags:
            string: string
    

    Certificate 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 Certificate resource accepts the following input properties:

    CertificateId string
    The certificate identifier.

    • Must contain from 1 to 255 alphanumeric characters and hyphens.
    CertificatePem string
    The contents of the .pem X.509 certificate file for the certificate. Either certificate_pem or certificate_wallet must be set.
    CertificateWallet string
    The contents of the Oracle Wallet certificate for use with SSL, provided as a base64-encoded String. Either certificate_pem or certificate_wallet must be set.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    CertificateId string
    The certificate identifier.

    • Must contain from 1 to 255 alphanumeric characters and hyphens.
    CertificatePem string
    The contents of the .pem X.509 certificate file for the certificate. Either certificate_pem or certificate_wallet must be set.
    CertificateWallet string
    The contents of the Oracle Wallet certificate for use with SSL, provided as a base64-encoded String. Either certificate_pem or certificate_wallet must be set.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    certificateId String
    The certificate identifier.

    • Must contain from 1 to 255 alphanumeric characters and hyphens.
    certificatePem String
    The contents of the .pem X.509 certificate file for the certificate. Either certificate_pem or certificate_wallet must be set.
    certificateWallet String
    The contents of the Oracle Wallet certificate for use with SSL, provided as a base64-encoded String. Either certificate_pem or certificate_wallet must be set.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    certificateId string
    The certificate identifier.

    • Must contain from 1 to 255 alphanumeric characters and hyphens.
    certificatePem string
    The contents of the .pem X.509 certificate file for the certificate. Either certificate_pem or certificate_wallet must be set.
    certificateWallet string
    The contents of the Oracle Wallet certificate for use with SSL, provided as a base64-encoded String. Either certificate_pem or certificate_wallet must be set.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    certificate_id str
    The certificate identifier.

    • Must contain from 1 to 255 alphanumeric characters and hyphens.
    certificate_pem str
    The contents of the .pem X.509 certificate file for the certificate. Either certificate_pem or certificate_wallet must be set.
    certificate_wallet str
    The contents of the Oracle Wallet certificate for use with SSL, provided as a base64-encoded String. Either certificate_pem or certificate_wallet must be set.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    certificateId String
    The certificate identifier.

    • Must contain from 1 to 255 alphanumeric characters and hyphens.
    certificatePem String
    The contents of the .pem X.509 certificate file for the certificate. Either certificate_pem or certificate_wallet must be set.
    certificateWallet String
    The contents of the Oracle Wallet certificate for use with SSL, provided as a base64-encoded String. Either certificate_pem or certificate_wallet must be set.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    CertificateArn string
    The Amazon Resource Name (ARN) for the certificate.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    CertificateArn string
    The Amazon Resource Name (ARN) for the certificate.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    certificateArn String
    The Amazon Resource Name (ARN) for the certificate.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    certificateArn string
    The Amazon Resource Name (ARN) for the certificate.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    certificate_arn str
    The Amazon Resource Name (ARN) for the certificate.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    certificateArn String
    The Amazon Resource Name (ARN) for the certificate.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Certificate Resource

    Get an existing Certificate 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?: CertificateState, opts?: CustomResourceOptions): Certificate
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            certificate_arn: Optional[str] = None,
            certificate_id: Optional[str] = None,
            certificate_pem: Optional[str] = None,
            certificate_wallet: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> Certificate
    func GetCertificate(ctx *Context, name string, id IDInput, state *CertificateState, opts ...ResourceOption) (*Certificate, error)
    public static Certificate Get(string name, Input<string> id, CertificateState? state, CustomResourceOptions? opts = null)
    public static Certificate get(String name, Output<String> id, CertificateState 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:
    CertificateArn string
    The Amazon Resource Name (ARN) for the certificate.
    CertificateId string
    The certificate identifier.

    • Must contain from 1 to 255 alphanumeric characters and hyphens.
    CertificatePem string
    The contents of the .pem X.509 certificate file for the certificate. Either certificate_pem or certificate_wallet must be set.
    CertificateWallet string
    The contents of the Oracle Wallet certificate for use with SSL, provided as a base64-encoded String. Either certificate_pem or certificate_wallet must be set.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    CertificateArn string
    The Amazon Resource Name (ARN) for the certificate.
    CertificateId string
    The certificate identifier.

    • Must contain from 1 to 255 alphanumeric characters and hyphens.
    CertificatePem string
    The contents of the .pem X.509 certificate file for the certificate. Either certificate_pem or certificate_wallet must be set.
    CertificateWallet string
    The contents of the Oracle Wallet certificate for use with SSL, provided as a base64-encoded String. Either certificate_pem or certificate_wallet must be set.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    certificateArn String
    The Amazon Resource Name (ARN) for the certificate.
    certificateId String
    The certificate identifier.

    • Must contain from 1 to 255 alphanumeric characters and hyphens.
    certificatePem String
    The contents of the .pem X.509 certificate file for the certificate. Either certificate_pem or certificate_wallet must be set.
    certificateWallet String
    The contents of the Oracle Wallet certificate for use with SSL, provided as a base64-encoded String. Either certificate_pem or certificate_wallet must be set.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    certificateArn string
    The Amazon Resource Name (ARN) for the certificate.
    certificateId string
    The certificate identifier.

    • Must contain from 1 to 255 alphanumeric characters and hyphens.
    certificatePem string
    The contents of the .pem X.509 certificate file for the certificate. Either certificate_pem or certificate_wallet must be set.
    certificateWallet string
    The contents of the Oracle Wallet certificate for use with SSL, provided as a base64-encoded String. Either certificate_pem or certificate_wallet must be set.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    certificate_arn str
    The Amazon Resource Name (ARN) for the certificate.
    certificate_id str
    The certificate identifier.

    • Must contain from 1 to 255 alphanumeric characters and hyphens.
    certificate_pem str
    The contents of the .pem X.509 certificate file for the certificate. Either certificate_pem or certificate_wallet must be set.
    certificate_wallet str
    The contents of the Oracle Wallet certificate for use with SSL, provided as a base64-encoded String. Either certificate_pem or certificate_wallet must be set.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    certificateArn String
    The Amazon Resource Name (ARN) for the certificate.
    certificateId String
    The certificate identifier.

    • Must contain from 1 to 255 alphanumeric characters and hyphens.
    certificatePem String
    The contents of the .pem X.509 certificate file for the certificate. Either certificate_pem or certificate_wallet must be set.
    certificateWallet String
    The contents of the Oracle Wallet certificate for use with SSL, provided as a base64-encoded String. Either certificate_pem or certificate_wallet must be set.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import certificates using the certificate_id. For example:

    $ pulumi import aws:dms/certificate:Certificate test test-dms-certificate-tf
    

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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi