Package software.amazon.awscdk.services.iot

Class CfnCertificateProvider

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iot.CfnCertificateProvider
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ICertificateProviderRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:38.135Z") @Stability(Stable) public class CfnCertificateProvider extends CfnResource implements IInspectable, ICertificateProviderRef, ITaggableV2
Creates a certificate provider.

AWS IoT Core certificate provider lets you customize how to sign a certificate signing request (CSR) in fleet provisioning. For more information, see Self-managed certificate signing using AWS IoT Core certificate provider from the AWS IoT Core Developer Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 CfnCertificateProvider cfnCertificateProvider = CfnCertificateProvider.Builder.create(this, "MyCfnCertificateProvider")
         .accountDefaultForOperations(List.of("accountDefaultForOperations"))
         .lambdaFunctionArn("lambdaFunctionArn")
         // the properties below are optional
         .certificateProviderName("certificateProviderName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCertificateProvider

      protected CfnCertificateProvider(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCertificateProvider

      protected CfnCertificateProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCertificateProvider

      @Stability(Stable) public CfnCertificateProvider(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCertificateProviderProps props)
      Create a new AWS::IoT::CertificateProvider.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForCertificateProvider

      @Stability(Stable) @NotNull public static String arnForCertificateProvider(@NotNull ICertificateProviderRef resource)
      Parameters:
      resource - This parameter is required.

    • fromCertificateProviderArn

      @Stability(Stable) @NotNull public static ICertificateProviderRef fromCertificateProviderArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new ICertificateProviderRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromCertificateProviderName

      @Stability(Stable) @NotNull public static ICertificateProviderRef fromCertificateProviderName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String certificateProviderName)
      Creates a new ICertificateProviderRef from a certificateProviderName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      certificateProviderName - This parameter is required.

    • isCfnCertificateProvider

      @Stability(Stable) @NotNull public static Boolean isCfnCertificateProvider(@NotNull Object x)
      Checks whether the given object is a CfnCertificateProvider.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Returns the Amazon Resource Name (ARN) for the certificate. For example:.

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

      A value similar to the following is returned:

      arn:aws:iot:ap-southeast-2:123456789012:certprovider/my-certificate-provider

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCertificateProviderRef

      @Stability(Stable) @NotNull public CertificateProviderReference getCertificateProviderRef()
      A reference to a CertificateProvider resource.
      Specified by:
      getCertificateProviderRef in interface ICertificateProviderRef

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAccountDefaultForOperations

      @Stability(Stable) @NotNull public List<String> getAccountDefaultForOperations()
      A list of the operations that the certificate provider will use to generate certificates.

    • setAccountDefaultForOperations

      @Stability(Stable) public void setAccountDefaultForOperations(@NotNull List<String> value)
      A list of the operations that the certificate provider will use to generate certificates.

    • getLambdaFunctionArn

      @Stability(Stable) @NotNull public String getLambdaFunctionArn()
      The ARN of the Lambda function.

    • setLambdaFunctionArn

      @Stability(Stable) public void setLambdaFunctionArn(@NotNull String value)
      The ARN of the Lambda function.

    • getCertificateProviderName

      @Stability(Stable) @Nullable public String getCertificateProviderName()
      The name of the certificate provider.

    • setCertificateProviderName

      @Stability(Stable) public void setCertificateProviderName(@Nullable String value)
      The name of the certificate provider.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Metadata that can be used to manage the certificate provider.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Metadata that can be used to manage the certificate provider.