Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iot
  5. CaCertificate

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.iot.CaCertificate

Explore with Pulumi AI

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Registers a CA Certificate in IoT.

Create CaCertificate Resource

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

Constructor syntax

new CaCertificate(name: string, args: CaCertificateArgs, opts?: CustomResourceOptions);
@overload
def CaCertificate(resource_name: str,
                  args: CaCertificateArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def CaCertificate(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  ca_certificate_pem: Optional[str] = None,
                  status: Optional[CaCertificateStatus] = None,
                  auto_registration_status: Optional[CaCertificateAutoRegistrationStatus] = None,
                  certificate_mode: Optional[CaCertificateCertificateMode] = None,
                  registration_config: Optional[CaCertificateRegistrationConfigArgs] = None,
                  remove_auto_registration: Optional[bool] = None,
                  tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                  verification_certificate_pem: Optional[str] = None)
func NewCaCertificate(ctx *Context, name string, args CaCertificateArgs, opts ...ResourceOption) (*CaCertificate, error)
public CaCertificate(string name, CaCertificateArgs args, CustomResourceOptions? opts = null)
public CaCertificate(String name, CaCertificateArgs args)
public CaCertificate(String name, CaCertificateArgs args, CustomResourceOptions options)

type: aws-native:iot:CaCertificate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CaCertificateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CaCertificateArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CaCertificateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CaCertificateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CaCertificateArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

CaCertificate Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The CaCertificate resource accepts the following input properties:

CaCertificatePem This property is required. string
The certificate data in PEM format.
Status This property is required. Pulumi.AwsNative.IoT.CaCertificateStatus

The status of the CA certificate.

Valid values are "ACTIVE" and "INACTIVE".

AutoRegistrationStatus Pulumi.AwsNative.IoT.CaCertificateAutoRegistrationStatus
Whether the CA certificate is configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE".
CertificateMode Pulumi.AwsNative.IoT.CaCertificateCertificateMode

The mode of the CA.

All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode .

Valid values are "DEFAULT" and "SNI_ONLY".

RegistrationConfig Pulumi.AwsNative.IoT.Inputs.CaCertificateRegistrationConfig
Information about the registration configuration.
RemoveAutoRegistration bool
If true, removes auto registration.
Tags List<Pulumi.AwsNative.Inputs.Tag>
An array of key-value pairs to apply to this resource.
VerificationCertificatePem string
The private key verification certificate.
CaCertificatePem This property is required. string
The certificate data in PEM format.
Status This property is required. CaCertificateStatus

The status of the CA certificate.

Valid values are "ACTIVE" and "INACTIVE".

AutoRegistrationStatus CaCertificateAutoRegistrationStatus
Whether the CA certificate is configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE".
CertificateMode CaCertificateCertificateMode

The mode of the CA.

All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode .

Valid values are "DEFAULT" and "SNI_ONLY".

RegistrationConfig CaCertificateRegistrationConfigArgs
Information about the registration configuration.
RemoveAutoRegistration bool
If true, removes auto registration.
Tags TagArgs
An array of key-value pairs to apply to this resource.
VerificationCertificatePem string
The private key verification certificate.
caCertificatePem This property is required. String
The certificate data in PEM format.
status This property is required. CaCertificateStatus

The status of the CA certificate.

Valid values are "ACTIVE" and "INACTIVE".

autoRegistrationStatus CaCertificateAutoRegistrationStatus
Whether the CA certificate is configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE".
certificateMode CaCertificateCertificateMode

The mode of the CA.

All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode .

Valid values are "DEFAULT" and "SNI_ONLY".

registrationConfig CaCertificateRegistrationConfig
Information about the registration configuration.
removeAutoRegistration Boolean
If true, removes auto registration.
tags List<Tag>
An array of key-value pairs to apply to this resource.
verificationCertificatePem String
The private key verification certificate.
caCertificatePem This property is required. string
The certificate data in PEM format.
status This property is required. CaCertificateStatus

The status of the CA certificate.

Valid values are "ACTIVE" and "INACTIVE".

autoRegistrationStatus CaCertificateAutoRegistrationStatus
Whether the CA certificate is configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE".
certificateMode CaCertificateCertificateMode

The mode of the CA.

All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode .

Valid values are "DEFAULT" and "SNI_ONLY".

registrationConfig CaCertificateRegistrationConfig
Information about the registration configuration.
removeAutoRegistration boolean
If true, removes auto registration.
tags Tag[]
An array of key-value pairs to apply to this resource.
verificationCertificatePem string
The private key verification certificate.
ca_certificate_pem This property is required. str
The certificate data in PEM format.
status This property is required. CaCertificateStatus

The status of the CA certificate.

Valid values are "ACTIVE" and "INACTIVE".

auto_registration_status CaCertificateAutoRegistrationStatus
Whether the CA certificate is configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE".
certificate_mode CaCertificateCertificateMode

The mode of the CA.

All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode .

Valid values are "DEFAULT" and "SNI_ONLY".

registration_config CaCertificateRegistrationConfigArgs
Information about the registration configuration.
remove_auto_registration bool
If true, removes auto registration.
tags Sequence[TagArgs]
An array of key-value pairs to apply to this resource.
verification_certificate_pem str
The private key verification certificate.
caCertificatePem This property is required. String
The certificate data in PEM format.
status This property is required. "ACTIVE" | "INACTIVE"

The status of the CA certificate.

Valid values are "ACTIVE" and "INACTIVE".

autoRegistrationStatus "ENABLE" | "DISABLE"
Whether the CA certificate is configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE".
certificateMode "DEFAULT" | "SNI_ONLY"

The mode of the CA.

All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode .

Valid values are "DEFAULT" and "SNI_ONLY".

registrationConfig Property Map
Information about the registration configuration.
removeAutoRegistration Boolean
If true, removes auto registration.
tags List<Property Map>
An array of key-value pairs to apply to this resource.
verificationCertificatePem String
The private key verification certificate.

Outputs

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

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

AwsId string
The CA certificate ID.
Id string
The provider-assigned unique ID for this managed 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

AwsId string
The CA certificate ID.
Id string
The provider-assigned unique ID for this managed 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

awsId String
The CA certificate ID.
id String
The provider-assigned unique ID for this managed 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

awsId string
The CA certificate ID.
id string
The provider-assigned unique ID for this managed 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

aws_id str
The CA certificate ID.
id str
The provider-assigned unique ID for this managed 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

awsId String
The CA certificate ID.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

CaCertificateAutoRegistrationStatus
, CaCertificateAutoRegistrationStatusArgs

Enable
ENABLE
Disable
DISABLE
CaCertificateAutoRegistrationStatusEnable
ENABLE
CaCertificateAutoRegistrationStatusDisable
DISABLE
Enable
ENABLE
Disable
DISABLE
Enable
ENABLE
Disable
DISABLE
ENABLE
ENABLE
DISABLE
DISABLE
"ENABLE"
ENABLE
"DISABLE"
DISABLE

CaCertificateCertificateMode
, CaCertificateCertificateModeArgs

Default
DEFAULT
SniOnly
SNI_ONLY
CaCertificateCertificateModeDefault
DEFAULT
CaCertificateCertificateModeSniOnly
SNI_ONLY
Default
DEFAULT
SniOnly
SNI_ONLY
Default
DEFAULT
SniOnly
SNI_ONLY
DEFAULT
DEFAULT
SNI_ONLY
SNI_ONLY
"DEFAULT"
DEFAULT
"SNI_ONLY"
SNI_ONLY

CaCertificateRegistrationConfig
, CaCertificateRegistrationConfigArgs

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
, CaCertificateStatusArgs

Active
ACTIVE
Inactive
INACTIVE
CaCertificateStatusActive
ACTIVE
CaCertificateStatusInactive
INACTIVE
Active
ACTIVE
Inactive
INACTIVE
Active
ACTIVE
Inactive
INACTIVE
ACTIVE
ACTIVE
INACTIVE
INACTIVE
"ACTIVE"
ACTIVE
"INACTIVE"
INACTIVE

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

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

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native