Certificate class
Manages a Lightsail certificate. Use this resource to create and manage SSL/TLS certificates for securing custom domains with your Lightsail resources.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.lightsail.Certificate("example", {
name: "example-certificate",
domainName: "example.com",
subjectAlternativeNames: ["www.example.com"],
});
import pulumi
import pulumi_aws as aws
example = aws.lightsail.Certificate("example",
name="example-certificate",
domain_name="example.com",
subject_alternative_names=["www.example.com"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.LightSail.Certificate("example", new()
{
Name = "example-certificate",
DomainName = "example.com",
SubjectAlternativeNames = new[]
{
"www.example.com",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/lightsail"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := lightsail.NewCertificate(ctx, "example", &lightsail.CertificateArgs{
Name: pulumi.String("example-certificate"),
DomainName: pulumi.String("example.com"),
SubjectAlternativeNames: pulumi.StringArray{
pulumi.String("www.example.com"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_lightsail_certificate" "example" {
name = "example-certificate"
domain_name = "example.com"
subject_alternative_names = ["www.example.com"]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lightsail.Certificate;
import com.pulumi.aws.lightsail.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 example = new Certificate("example", CertificateArgs.builder()
.name("example-certificate")
.domainName("example.com")
.subjectAlternativeNames("www.example.com")
.build());
}
}
resources:
example:
type: aws:lightsail:Certificate
properties:
name: example-certificate
domainName: example.com
subjectAlternativeNames:
- www.example.com
Import
Using pulumi import, import aws.lightsail.Certificate using the certificate name. For example:
$ pulumi import aws:lightsail/certificate:Certificate example example-certificate
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
-
arn
↔ Output<
String> -
ARN of the certificate.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
createdAt
↔ Output<
String> -
Date and time when the certificate was created.
latefinal
-
domainName
↔ Output<
String> -
Domain name for which the certificate should be issued.
latefinal
-
domainValidationOptions
↔ Output<
List< CertificateDomainValidationOption> > -
Set of domain validation objects which can be used to complete certificate validation. Can have more than one element, e.g., if SANs are defined. Each element contains the following attributes:
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
-
name
↔ Output<
String> -
Name of the certificate.
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
-
subjectAlternativeNames
↔ Output<
List< String> > -
Set of domains that should be SANs in the issued certificate.
domainNameattribute is automatically added as a Subject Alternative Name.latefinal -
Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
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.