1. Packages
  2. AWS Native
  3. API Docs
  4. transfer
  5. Certificate

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.transfer.Certificate

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    Resource Type definition for AWS::Transfer::Certificate

    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: Optional[str] = None,
                    usage: Optional[CertificateUsage] = None,
                    active_date: Optional[str] = None,
                    certificate_chain: Optional[str] = None,
                    description: Optional[str] = None,
                    inactive_date: Optional[str] = None,
                    private_key: Optional[str] = None,
                    tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native:transfer: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.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const examplecertificateResourceResourceFromTransfer = new aws_native.transfer.Certificate("examplecertificateResourceResourceFromTransfer", {
        certificate: "string",
        usage: aws_native.transfer.CertificateUsage.Signing,
        activeDate: "string",
        certificateChain: "string",
        description: "string",
        inactiveDate: "string",
        privateKey: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    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:

    CertificateValue string
    Specifies the certificate body to be imported.
    Usage Pulumi.AwsNative.Transfer.CertificateUsage
    Specifies the usage type for the certificate.
    ActiveDate string
    Specifies the active date for the certificate.
    CertificateChain string
    Specifies the certificate chain to be imported.
    Description string
    A textual description for the certificate.
    InactiveDate string
    Specifies the inactive date for the certificate.
    PrivateKey string
    Specifies the private key for the certificate.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose.
    Certificate string
    Specifies the certificate body to be imported.
    Usage CertificateUsage
    Specifies the usage type for the certificate.
    ActiveDate string
    Specifies the active date for the certificate.
    CertificateChain string
    Specifies the certificate chain to be imported.
    Description string
    A textual description for the certificate.
    InactiveDate string
    Specifies the inactive date for the certificate.
    PrivateKey string
    Specifies the private key for the certificate.
    Tags TagArgs
    Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose.
    certificate String
    Specifies the certificate body to be imported.
    usage CertificateUsage
    Specifies the usage type for the certificate.
    activeDate String
    Specifies the active date for the certificate.
    certificateChain String
    Specifies the certificate chain to be imported.
    description String
    A textual description for the certificate.
    inactiveDate String
    Specifies the inactive date for the certificate.
    privateKey String
    Specifies the private key for the certificate.
    tags List<Tag>
    Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose.
    certificate string
    Specifies the certificate body to be imported.
    usage CertificateUsage
    Specifies the usage type for the certificate.
    activeDate string
    Specifies the active date for the certificate.
    certificateChain string
    Specifies the certificate chain to be imported.
    description string
    A textual description for the certificate.
    inactiveDate string
    Specifies the inactive date for the certificate.
    privateKey string
    Specifies the private key for the certificate.
    tags Tag[]
    Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose.
    certificate str
    Specifies the certificate body to be imported.
    usage CertificateUsage
    Specifies the usage type for the certificate.
    active_date str
    Specifies the active date for the certificate.
    certificate_chain str
    Specifies the certificate chain to be imported.
    description str
    A textual description for the certificate.
    inactive_date str
    Specifies the inactive date for the certificate.
    private_key str
    Specifies the private key for the certificate.
    tags Sequence[TagArgs]
    Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose.
    certificate String
    Specifies the certificate body to be imported.
    usage "SIGNING" | "ENCRYPTION" | "TLS"
    Specifies the usage type for the certificate.
    activeDate String
    Specifies the active date for the certificate.
    certificateChain String
    Specifies the certificate chain to be imported.
    description String
    A textual description for the certificate.
    inactiveDate String
    Specifies the inactive date for the certificate.
    privateKey String
    Specifies the private key for the certificate.
    tags List<Property Map>
    Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose.

    Outputs

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

    Arn string
    Specifies the unique Amazon Resource Name (ARN) for the agreement.
    CertificateId string
    A unique identifier for the certificate.
    Id string
    The provider-assigned unique ID for this managed resource.
    NotAfterDate string
    Specifies the not after date for the certificate.
    NotBeforeDate string
    Specifies the not before date for the certificate.
    Serial string
    Specifies Certificate's serial.
    Status Pulumi.AwsNative.Transfer.CertificateStatus
    A status description for the certificate.
    Type Pulumi.AwsNative.Transfer.CertificateType
    Describing the type of certificate. With or without a private key.
    Arn string
    Specifies the unique Amazon Resource Name (ARN) for the agreement.
    CertificateId string
    A unique identifier for the certificate.
    Id string
    The provider-assigned unique ID for this managed resource.
    NotAfterDate string
    Specifies the not after date for the certificate.
    NotBeforeDate string
    Specifies the not before date for the certificate.
    Serial string
    Specifies Certificate's serial.
    Status CertificateStatus
    A status description for the certificate.
    Type CertificateType
    Describing the type of certificate. With or without a private key.
    arn String
    Specifies the unique Amazon Resource Name (ARN) for the agreement.
    certificateId String
    A unique identifier for the certificate.
    id String
    The provider-assigned unique ID for this managed resource.
    notAfterDate String
    Specifies the not after date for the certificate.
    notBeforeDate String
    Specifies the not before date for the certificate.
    serial String
    Specifies Certificate's serial.
    status CertificateStatus
    A status description for the certificate.
    type CertificateType
    Describing the type of certificate. With or without a private key.
    arn string
    Specifies the unique Amazon Resource Name (ARN) for the agreement.
    certificateId string
    A unique identifier for the certificate.
    id string
    The provider-assigned unique ID for this managed resource.
    notAfterDate string
    Specifies the not after date for the certificate.
    notBeforeDate string
    Specifies the not before date for the certificate.
    serial string
    Specifies Certificate's serial.
    status CertificateStatus
    A status description for the certificate.
    type CertificateType
    Describing the type of certificate. With or without a private key.
    arn str
    Specifies the unique Amazon Resource Name (ARN) for the agreement.
    certificate_id str
    A unique identifier for the certificate.
    id str
    The provider-assigned unique ID for this managed resource.
    not_after_date str
    Specifies the not after date for the certificate.
    not_before_date str
    Specifies the not before date for the certificate.
    serial str
    Specifies Certificate's serial.
    status CertificateStatus
    A status description for the certificate.
    type CertificateType
    Describing the type of certificate. With or without a private key.
    arn String
    Specifies the unique Amazon Resource Name (ARN) for the agreement.
    certificateId String
    A unique identifier for the certificate.
    id String
    The provider-assigned unique ID for this managed resource.
    notAfterDate String
    Specifies the not after date for the certificate.
    notBeforeDate String
    Specifies the not before date for the certificate.
    serial String
    Specifies Certificate's serial.
    status "ACTIVE" | "PENDING" | "INACTIVE"
    A status description for the certificate.
    type "CERTIFICATE" | "CERTIFICATE_WITH_PRIVATE_KEY"
    Describing the type of certificate. With or without a private key.

    Supporting Types

    CertificateStatus, CertificateStatusArgs

    Active
    ACTIVE
    Pending
    PENDING
    Inactive
    INACTIVE
    CertificateStatusActive
    ACTIVE
    CertificateStatusPending
    PENDING
    CertificateStatusInactive
    INACTIVE
    Active
    ACTIVE
    Pending
    PENDING
    Inactive
    INACTIVE
    Active
    ACTIVE
    Pending
    PENDING
    Inactive
    INACTIVE
    ACTIVE
    ACTIVE
    PENDING
    PENDING
    INACTIVE
    INACTIVE
    "ACTIVE"
    ACTIVE
    "PENDING"
    PENDING
    "INACTIVE"
    INACTIVE

    CertificateType, CertificateTypeArgs

    Certificate
    CERTIFICATE
    CertificateWithPrivateKey
    CERTIFICATE_WITH_PRIVATE_KEY
    CertificateTypeCertificate
    CERTIFICATE
    CertificateTypeCertificateWithPrivateKey
    CERTIFICATE_WITH_PRIVATE_KEY
    Certificate
    CERTIFICATE
    CertificateWithPrivateKey
    CERTIFICATE_WITH_PRIVATE_KEY
    Certificate
    CERTIFICATE
    CertificateWithPrivateKey
    CERTIFICATE_WITH_PRIVATE_KEY
    CERTIFICATE
    CERTIFICATE
    CERTIFICATE_WITH_PRIVATE_KEY
    CERTIFICATE_WITH_PRIVATE_KEY
    "CERTIFICATE"
    CERTIFICATE
    "CERTIFICATE_WITH_PRIVATE_KEY"
    CERTIFICATE_WITH_PRIVATE_KEY

    CertificateUsage, CertificateUsageArgs

    Signing
    SIGNING
    Encryption
    ENCRYPTION
    Tls
    TLS
    CertificateUsageSigning
    SIGNING
    CertificateUsageEncryption
    ENCRYPTION
    CertificateUsageTls
    TLS
    Signing
    SIGNING
    Encryption
    ENCRYPTION
    Tls
    TLS
    Signing
    SIGNING
    Encryption
    ENCRYPTION
    Tls
    TLS
    SIGNING
    SIGNING
    ENCRYPTION
    ENCRYPTION
    TLS
    TLS
    "SIGNING"
    SIGNING
    "ENCRYPTION"
    ENCRYPTION
    "TLS"
    TLS

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi