Certificate class
Creates and manages an AWS IoT certificate.
Example Usage
With CSR
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as std from "@pulumi/std";
const cert = new aws.iot.Certificate("cert", {
csr: std.file({
input: "/my/csr.pem",
}).then(invoke => invoke.result),
active: true,
});
import pulumi
import pulumi_aws as aws
import pulumi_std as std
cert = aws.iot.Certificate("cert",
csr=std.file(input="/my/csr.pem").result,
active=True)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var cert = new Aws.Iot.Certificate("cert", new()
{
Csr = Std.File.Invoke(new()
{
Input = "/my/csr.pem",
}).Apply(invoke => invoke.Result),
Active = true,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iot"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
invokeFile, err := std.File(ctx, &std.FileArgs{
Input: "/my/csr.pem",
}, nil)
if err != nil {
return err
}
_, err = iot.NewCertificate(ctx, "cert", &iot.CertificateArgs{
Csr: pulumi.String(invokeFile.Result),
Active: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
std = {
source = "pulumi/std"
}
}
}
resource "aws_iot_certificate" "cert" {
csr = file("/my/csr.pem")
active = true
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iot.Certificate;
import com.pulumi.aws.iot.CertificateArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.FileArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var cert = new Certificate("cert", CertificateArgs.builder()
.csr(StdFunctions.file(FileArgs.builder()
.input("/my/csr.pem")
.build()).result())
.active(true)
.build());
}
}
resources:
cert:
type: aws:iot:Certificate
properties:
csr:
fn::invoke:
function: std:file
arguments:
input: /my/csr.pem
return: result
active: true
Without CSR
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const cert = new aws.iot.Certificate("cert", {active: true});
import pulumi
import pulumi_aws as aws
cert = aws.iot.Certificate("cert", active=True)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var cert = new Aws.Iot.Certificate("cert", new()
{
Active = true,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iot"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := iot.NewCertificate(ctx, "cert", &iot.CertificateArgs{
Active: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_iot_certificate" "cert" {
active = true
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iot.Certificate;
import com.pulumi.aws.iot.CertificateArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var cert = new Certificate("cert", CertificateArgs.builder()
.active(true)
.build());
}
}
resources:
cert:
type: aws:iot:Certificate
properties:
active: true
From existing certificate without a CA
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as std from "@pulumi/std";
const cert = new aws.iot.Certificate("cert", {
certificatePem: std.file({
input: "/my/cert.pem",
}).then(invoke => invoke.result),
active: true,
});
import pulumi
import pulumi_aws as aws
import pulumi_std as std
cert = aws.iot.Certificate("cert",
certificate_pem=std.file(input="/my/cert.pem").result,
active=True)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var cert = new Aws.Iot.Certificate("cert", new()
{
CertificatePem = Std.File.Invoke(new()
{
Input = "/my/cert.pem",
}).Apply(invoke => invoke.Result),
Active = true,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iot"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
invokeFile, err := std.File(ctx, &std.FileArgs{
Input: "/my/cert.pem",
}, nil)
if err != nil {
return err
}
_, err = iot.NewCertificate(ctx, "cert", &iot.CertificateArgs{
CertificatePem: pulumi.String(invokeFile.Result),
Active: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
std = {
source = "pulumi/std"
}
}
}
resource "aws_iot_certificate" "cert" {
certificate_pem = file("/my/cert.pem")
active = true
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iot.Certificate;
import com.pulumi.aws.iot.CertificateArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.FileArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var cert = new Certificate("cert", CertificateArgs.builder()
.certificatePem(StdFunctions.file(FileArgs.builder()
.input("/my/cert.pem")
.build()).result())
.active(true)
.build());
}
}
resources:
cert:
type: aws:iot:Certificate
properties:
certificatePem:
fn::invoke:
function: std:file
arguments:
input: /my/cert.pem
return: result
active: true
Constructors
- Certificate(String name, {CertificateArgs? args, CustomResourceOptions? options})
-
Creates a new Certificate.
nameThe Pulumi resource name.argsArguments used to configure this Certificate. The set of arguments for Certificate.optionsResource options controlling this resource's behavior. - Certificate.reference(String urn)
- Creates a typed reference to an existing Certificate resource.
Properties
-
active
↔ Output<
bool> -
Boolean flag to indicate if the certificate should be active
latefinal
-
arn
↔ Output<
String> -
The ARN of the created certificate.
latefinal
-
caCertificateId
↔ Output<
String> -
The certificate ID of the CA certificate used to sign the certificate.
latefinal
-
caPem
↔ Output<
String?> -
The CA certificate for the certificate to be registered. If this is set, the CA needs to be registered with AWS IoT beforehand.
latefinal
-
certificatePem
↔ Output<
String> -
The certificate to be registered. If
caPemis unspecified, review RegisterCertificateWithoutCA. IfcaPemis specified, review RegisterCertificate for more information on registering a certificate.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
csr
↔ Output<
String?> -
The certificate signing request. Review
CreateCertificateFromCsr
for more information on generating a certificate from a certificate signing request (CSR).
If none is specified both the certificate and keys will be generated, review CreateKeysAndCertificate
for more information on generating keys and a certificate.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
privateKey
↔ Output<
String> -
When neither CSR nor certificate is provided, the private key.
latefinal
-
publicKey
↔ Output<
String> -
When neither CSR nor certificate is provided, the public key.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {CertificateState? state, CustomResourceOptions? options}) → Certificate -
Gets an existing Certificate resource's state with the given
nameandid.