AWS Native v0.54.0, Mar 21 23

aws-native.transfer.getCertificate

Resource Type definition for AWS::Transfer::Certificate

Using getCertificate

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCertificate(args: GetCertificateArgs, opts?: InvokeOptions): Promise<GetCertificateResult>
function getCertificateOutput(args: GetCertificateOutputArgs, opts?: InvokeOptions): Output<GetCertificateResult>

def get_certificate(certificate_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetCertificateResult
def get_certificate_output(certificate_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetCertificateResult]

func LookupCertificate(ctx *Context, args *LookupCertificateArgs, opts ...InvokeOption) (*LookupCertificateResult, error)
func LookupCertificateOutput(ctx *Context, args *LookupCertificateOutputArgs, opts ...InvokeOption) LookupCertificateResultOutput

> Note: This function is named LookupCertificate in the Go SDK.

public static class GetCertificate 
{
    public static Task<GetCertificateResult> InvokeAsync(GetCertificateArgs args, InvokeOptions? opts = null)
    public static Output<GetCertificateResult> Invoke(GetCertificateInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCertificateResult> getCertificate(GetCertificateArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:transfer:getCertificate
  arguments:
    # arguments dictionary

The following arguments are supported:

CertificateId string: A unique identifier for the certificate.

CertificateId string: A unique identifier for the certificate.

certificateId String: A unique identifier for the certificate.

certificateId string: A unique identifier for the certificate.

certificate_id str: A unique identifier for the certificate.

certificateId String: A unique identifier for the certificate.

getCertificate Result

The following output properties are available:

ActiveDate string: Specifies the active date for the certificate.
Arn string: Specifies the unique Amazon Resource Name (ARN) for the agreement.
CertificateId string: A unique identifier for the certificate.
Description string: A textual description for the certificate.
InactiveDate string: Specifies the inactive date for the certificate.
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.
Tags List<Pulumi.AwsNative.Transfer.Outputs.CertificateTag>: Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose.
Type Pulumi.AwsNative.Transfer.CertificateType: Describing the type of certificate. With or without a private key.
Usage Pulumi.AwsNative.Transfer.CertificateUsage: Specifies the usage type for the certificate.

ActiveDate string: Specifies the active date for the certificate.
Arn string: Specifies the unique Amazon Resource Name (ARN) for the agreement.
CertificateId string: A unique identifier for the certificate.
Description string: A textual description for the certificate.
InactiveDate string: Specifies the inactive date for the certificate.
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.
Tags []CertificateTag: Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose.
Type CertificateType: Describing the type of certificate. With or without a private key.
Usage CertificateUsage: Specifies the usage type for the certificate.

activeDate String: Specifies the active date for the certificate.
arn String: Specifies the unique Amazon Resource Name (ARN) for the agreement.
certificateId String: A unique identifier for the certificate.
description String: A textual description for the certificate.
inactiveDate String: Specifies the inactive date for the certificate.
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.
tags List<CertificateTag>: Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose.
type CertificateType: Describing the type of certificate. With or without a private key.
usage CertificateUsage: Specifies the usage type for the certificate.

activeDate string: Specifies the active date for the certificate.
arn string: Specifies the unique Amazon Resource Name (ARN) for the agreement.
certificateId string: A unique identifier for the certificate.
description string: A textual description for the certificate.
inactiveDate string: Specifies the inactive date for the certificate.
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.
tags CertificateTag[]: Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose.
type CertificateType: Describing the type of certificate. With or without a private key.
usage CertificateUsage: Specifies the usage type for the certificate.

active_date str: Specifies the active date for the certificate.
arn str: Specifies the unique Amazon Resource Name (ARN) for the agreement.
certificate_id str: A unique identifier for the certificate.
description str: A textual description for the certificate.
inactive_date str: Specifies the inactive date for the certificate.
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.
tags Sequence[CertificateTag]: Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose.
type CertificateType: Describing the type of certificate. With or without a private key.
usage CertificateUsage: Specifies the usage type for the certificate.

activeDate String: Specifies the active date for the certificate.
arn String: Specifies the unique Amazon Resource Name (ARN) for the agreement.
certificateId String: A unique identifier for the certificate.
description String: A textual description for the certificate.
inactiveDate String: Specifies the inactive date for the certificate.
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.
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.
type "CERTIFICATE" | "CERTIFICATE_WITH_PRIVATE_KEY": Describing the type of certificate. With or without a private key.
usage "SIGNING" | "ENCRYPTION": Specifies the usage type for the certificate.

Supporting Types

CertificateStatus

CertificateTag

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value str: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

CertificateType

CertificateUsage

Package Details

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