Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. iot
  5. getCertificate

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.iot.getCertificate

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Use the AWS::IoT::Certificate resource to declare an AWS IoT X.509 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(id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetCertificateResult
def get_certificate_output(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:iot:getCertificate
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The certificate ID.
    Id string
    The certificate ID.
    id String
    The certificate ID.
    id string
    The certificate ID.
    id str
    The certificate ID.
    id String
    The certificate ID.

    getCertificate Result

    The following output properties are available:

    Arn string

    Returns the Amazon Resource Name (ARN) for the certificate. For example:

    { "Fn::GetAtt": ["MyCertificate", "Arn"] }

    A value similar to the following is returned:

    arn:aws:iot:ap-southeast-2:123456789012:cert/a1234567b89c012d3e4fg567hij8k9l01mno1p23q45678901rs234567890t1u2

    Id string
    The certificate ID.
    Status Pulumi.AwsNative.IoT.CertificateStatus

    The status of the certificate.

    Valid values are ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, and PENDING_ACTIVATION.

    The status value REGISTER_INACTIVE is deprecated and should not be used.

    Arn string

    Returns the Amazon Resource Name (ARN) for the certificate. For example:

    { "Fn::GetAtt": ["MyCertificate", "Arn"] }

    A value similar to the following is returned:

    arn:aws:iot:ap-southeast-2:123456789012:cert/a1234567b89c012d3e4fg567hij8k9l01mno1p23q45678901rs234567890t1u2

    Id string
    The certificate ID.
    Status CertificateStatus

    The status of the certificate.

    Valid values are ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, and PENDING_ACTIVATION.

    The status value REGISTER_INACTIVE is deprecated and should not be used.

    arn String

    Returns the Amazon Resource Name (ARN) for the certificate. For example:

    { "Fn::GetAtt": ["MyCertificate", "Arn"] }

    A value similar to the following is returned:

    arn:aws:iot:ap-southeast-2:123456789012:cert/a1234567b89c012d3e4fg567hij8k9l01mno1p23q45678901rs234567890t1u2

    id String
    The certificate ID.
    status CertificateStatus

    The status of the certificate.

    Valid values are ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, and PENDING_ACTIVATION.

    The status value REGISTER_INACTIVE is deprecated and should not be used.

    arn string

    Returns the Amazon Resource Name (ARN) for the certificate. For example:

    { "Fn::GetAtt": ["MyCertificate", "Arn"] }

    A value similar to the following is returned:

    arn:aws:iot:ap-southeast-2:123456789012:cert/a1234567b89c012d3e4fg567hij8k9l01mno1p23q45678901rs234567890t1u2

    id string
    The certificate ID.
    status CertificateStatus

    The status of the certificate.

    Valid values are ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, and PENDING_ACTIVATION.

    The status value REGISTER_INACTIVE is deprecated and should not be used.

    arn str

    Returns the Amazon Resource Name (ARN) for the certificate. For example:

    { "Fn::GetAtt": ["MyCertificate", "Arn"] }

    A value similar to the following is returned:

    arn:aws:iot:ap-southeast-2:123456789012:cert/a1234567b89c012d3e4fg567hij8k9l01mno1p23q45678901rs234567890t1u2

    id str
    The certificate ID.
    status CertificateStatus

    The status of the certificate.

    Valid values are ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, and PENDING_ACTIVATION.

    The status value REGISTER_INACTIVE is deprecated and should not be used.

    arn String

    Returns the Amazon Resource Name (ARN) for the certificate. For example:

    { "Fn::GetAtt": ["MyCertificate", "Arn"] }

    A value similar to the following is returned:

    arn:aws:iot:ap-southeast-2:123456789012:cert/a1234567b89c012d3e4fg567hij8k9l01mno1p23q45678901rs234567890t1u2

    id String
    The certificate ID.
    status "ACTIVE" | "INACTIVE" | "REVOKED" | "PENDING_TRANSFER" | "PENDING_ACTIVATION"

    The status of the certificate.

    Valid values are ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, and PENDING_ACTIVATION.

    The status value REGISTER_INACTIVE is deprecated and should not be used.

    Supporting Types

    CertificateStatus

    Package Details

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

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native