1. Packages
  2. AWS Native
  3. API Docs
  4. iot
  5. getCaCertificate

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

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.iot.getCaCertificate

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    Registers a CA Certificate in IoT.

    Using getCaCertificate

    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 getCaCertificate(args: GetCaCertificateArgs, opts?: InvokeOptions): Promise<GetCaCertificateResult>
    function getCaCertificateOutput(args: GetCaCertificateOutputArgs, opts?: InvokeOptions): Output<GetCaCertificateResult>
    def get_ca_certificate(id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetCaCertificateResult
    def get_ca_certificate_output(id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetCaCertificateResult]
    func LookupCaCertificate(ctx *Context, args *LookupCaCertificateArgs, opts ...InvokeOption) (*LookupCaCertificateResult, error)
    func LookupCaCertificateOutput(ctx *Context, args *LookupCaCertificateOutputArgs, opts ...InvokeOption) LookupCaCertificateResultOutput

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

    public static class GetCaCertificate 
    {
        public static Task<GetCaCertificateResult> InvokeAsync(GetCaCertificateArgs args, InvokeOptions? opts = null)
        public static Output<GetCaCertificateResult> Invoke(GetCaCertificateInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCaCertificateResult> getCaCertificate(GetCaCertificateArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:iot:getCaCertificate
      arguments:
        # arguments dictionary

    The following arguments are supported:

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

    getCaCertificate Result

    The following output properties are available:

    Arn string

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

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

    A value similar to the following is returned:

    arn:aws:iot:us-east-1:123456789012:cacert/a6be6b84559801927e35a8f901fae08b5971d78d1562e29504ff9663b276a5f5

    AutoRegistrationStatus Pulumi.AwsNative.IoT.CaCertificateAutoRegistrationStatus
    Whether the CA certificate is configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE".
    Id string
    The CA certificate ID.
    RegistrationConfig Pulumi.AwsNative.IoT.Outputs.CaCertificateRegistrationConfig
    Information about the registration configuration.
    Status Pulumi.AwsNative.IoT.CaCertificateStatus

    The status of the CA certificate.

    Valid values are "ACTIVE" and "INACTIVE".

    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    Arn string

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

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

    A value similar to the following is returned:

    arn:aws:iot:us-east-1:123456789012:cacert/a6be6b84559801927e35a8f901fae08b5971d78d1562e29504ff9663b276a5f5

    AutoRegistrationStatus CaCertificateAutoRegistrationStatus
    Whether the CA certificate is configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE".
    Id string
    The CA certificate ID.
    RegistrationConfig CaCertificateRegistrationConfig
    Information about the registration configuration.
    Status CaCertificateStatus

    The status of the CA certificate.

    Valid values are "ACTIVE" and "INACTIVE".

    Tags Tag
    An array of key-value pairs to apply to this resource.
    arn String

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

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

    A value similar to the following is returned:

    arn:aws:iot:us-east-1:123456789012:cacert/a6be6b84559801927e35a8f901fae08b5971d78d1562e29504ff9663b276a5f5

    autoRegistrationStatus CaCertificateAutoRegistrationStatus
    Whether the CA certificate is configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE".
    id String
    The CA certificate ID.
    registrationConfig CaCertificateRegistrationConfig
    Information about the registration configuration.
    status CaCertificateStatus

    The status of the CA certificate.

    Valid values are "ACTIVE" and "INACTIVE".

    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    arn string

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

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

    A value similar to the following is returned:

    arn:aws:iot:us-east-1:123456789012:cacert/a6be6b84559801927e35a8f901fae08b5971d78d1562e29504ff9663b276a5f5

    autoRegistrationStatus CaCertificateAutoRegistrationStatus
    Whether the CA certificate is configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE".
    id string
    The CA certificate ID.
    registrationConfig CaCertificateRegistrationConfig
    Information about the registration configuration.
    status CaCertificateStatus

    The status of the CA certificate.

    Valid values are "ACTIVE" and "INACTIVE".

    tags Tag[]
    An array of key-value pairs to apply to this resource.
    arn str

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

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

    A value similar to the following is returned:

    arn:aws:iot:us-east-1:123456789012:cacert/a6be6b84559801927e35a8f901fae08b5971d78d1562e29504ff9663b276a5f5

    auto_registration_status CaCertificateAutoRegistrationStatus
    Whether the CA certificate is configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE".
    id str
    The CA certificate ID.
    registration_config CaCertificateRegistrationConfig
    Information about the registration configuration.
    status CaCertificateStatus

    The status of the CA certificate.

    Valid values are "ACTIVE" and "INACTIVE".

    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    arn String

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

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

    A value similar to the following is returned:

    arn:aws:iot:us-east-1:123456789012:cacert/a6be6b84559801927e35a8f901fae08b5971d78d1562e29504ff9663b276a5f5

    autoRegistrationStatus "ENABLE" | "DISABLE"
    Whether the CA certificate is configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE".
    id String
    The CA certificate ID.
    registrationConfig Property Map
    Information about the registration configuration.
    status "ACTIVE" | "INACTIVE"

    The status of the CA certificate.

    Valid values are "ACTIVE" and "INACTIVE".

    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Supporting Types

    CaCertificateAutoRegistrationStatus

    CaCertificateRegistrationConfig

    RoleArn string
    The ARN of the role.
    TemplateBody string
    The template body.
    TemplateName string
    The name of the provisioning template.
    RoleArn string
    The ARN of the role.
    TemplateBody string
    The template body.
    TemplateName string
    The name of the provisioning template.
    roleArn String
    The ARN of the role.
    templateBody String
    The template body.
    templateName String
    The name of the provisioning template.
    roleArn string
    The ARN of the role.
    templateBody string
    The template body.
    templateName string
    The name of the provisioning template.
    role_arn str
    The ARN of the role.
    template_body str
    The template body.
    template_name str
    The name of the provisioning template.
    roleArn String
    The ARN of the role.
    templateBody String
    The template body.
    templateName String
    The name of the provisioning template.

    CaCertificateStatus

    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 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.3 published on Wednesday, Jun 12, 2024 by Pulumi