1. Packages
  2. AWS
  3. API Docs
  4. lightsail
  5. LbCertificateAttachment
AWS v6.77.1 published on Friday, Apr 18, 2025 by Pulumi

aws.lightsail.LbCertificateAttachment

Explore with Pulumi AI

Attaches a Lightsail Load Balancer Certificate to a Lightsail Load Balancer.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.lightsail.Lb("test", {
    name: "test-load-balancer",
    healthCheckPath: "/",
    instancePort: 80,
    tags: {
        foo: "bar",
    },
});
const testLbCertificate = new aws.lightsail.LbCertificate("test", {
    name: "test-load-balancer-certificate",
    lbName: test.id,
    domainName: "test.com",
});
const testLbCertificateAttachment = new aws.lightsail.LbCertificateAttachment("test", {
    lbName: test.name,
    certificateName: testLbCertificate.name,
});
Copy
import pulumi
import pulumi_aws as aws

test = aws.lightsail.Lb("test",
    name="test-load-balancer",
    health_check_path="/",
    instance_port=80,
    tags={
        "foo": "bar",
    })
test_lb_certificate = aws.lightsail.LbCertificate("test",
    name="test-load-balancer-certificate",
    lb_name=test.id,
    domain_name="test.com")
test_lb_certificate_attachment = aws.lightsail.LbCertificateAttachment("test",
    lb_name=test.name,
    certificate_name=test_lb_certificate.name)
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lightsail"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := lightsail.NewLb(ctx, "test", &lightsail.LbArgs{
			Name:            pulumi.String("test-load-balancer"),
			HealthCheckPath: pulumi.String("/"),
			InstancePort:    pulumi.Int(80),
			Tags: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
		})
		if err != nil {
			return err
		}
		testLbCertificate, err := lightsail.NewLbCertificate(ctx, "test", &lightsail.LbCertificateArgs{
			Name:       pulumi.String("test-load-balancer-certificate"),
			LbName:     test.ID(),
			DomainName: pulumi.String("test.com"),
		})
		if err != nil {
			return err
		}
		_, err = lightsail.NewLbCertificateAttachment(ctx, "test", &lightsail.LbCertificateAttachmentArgs{
			LbName:          test.Name,
			CertificateName: testLbCertificate.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.LightSail.Lb("test", new()
    {
        Name = "test-load-balancer",
        HealthCheckPath = "/",
        InstancePort = 80,
        Tags = 
        {
            { "foo", "bar" },
        },
    });

    var testLbCertificate = new Aws.LightSail.LbCertificate("test", new()
    {
        Name = "test-load-balancer-certificate",
        LbName = test.Id,
        DomainName = "test.com",
    });

    var testLbCertificateAttachment = new Aws.LightSail.LbCertificateAttachment("test", new()
    {
        LbName = test.Name,
        CertificateName = testLbCertificate.Name,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lightsail.Lb;
import com.pulumi.aws.lightsail.LbArgs;
import com.pulumi.aws.lightsail.LbCertificate;
import com.pulumi.aws.lightsail.LbCertificateArgs;
import com.pulumi.aws.lightsail.LbCertificateAttachment;
import com.pulumi.aws.lightsail.LbCertificateAttachmentArgs;
import java.util.List;
import java.util.ArrayList;
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 test = new Lb("test", LbArgs.builder()
            .name("test-load-balancer")
            .healthCheckPath("/")
            .instancePort(80)
            .tags(Map.of("foo", "bar"))
            .build());

        var testLbCertificate = new LbCertificate("testLbCertificate", LbCertificateArgs.builder()
            .name("test-load-balancer-certificate")
            .lbName(test.id())
            .domainName("test.com")
            .build());

        var testLbCertificateAttachment = new LbCertificateAttachment("testLbCertificateAttachment", LbCertificateAttachmentArgs.builder()
            .lbName(test.name())
            .certificateName(testLbCertificate.name())
            .build());

    }
}
Copy
resources:
  test:
    type: aws:lightsail:Lb
    properties:
      name: test-load-balancer
      healthCheckPath: /
      instancePort: '80'
      tags:
        foo: bar
  testLbCertificate:
    type: aws:lightsail:LbCertificate
    name: test
    properties:
      name: test-load-balancer-certificate
      lbName: ${test.id}
      domainName: test.com
  testLbCertificateAttachment:
    type: aws:lightsail:LbCertificateAttachment
    name: test
    properties:
      lbName: ${test.name}
      certificateName: ${testLbCertificate.name}
Copy

Create LbCertificateAttachment Resource

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

Constructor syntax

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

@overload
def LbCertificateAttachment(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            certificate_name: Optional[str] = None,
                            lb_name: Optional[str] = None)
func NewLbCertificateAttachment(ctx *Context, name string, args LbCertificateAttachmentArgs, opts ...ResourceOption) (*LbCertificateAttachment, error)
public LbCertificateAttachment(string name, LbCertificateAttachmentArgs args, CustomResourceOptions? opts = null)
public LbCertificateAttachment(String name, LbCertificateAttachmentArgs args)
public LbCertificateAttachment(String name, LbCertificateAttachmentArgs args, CustomResourceOptions options)
type: aws:lightsail:LbCertificateAttachment
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. LbCertificateAttachmentArgs
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. LbCertificateAttachmentArgs
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. LbCertificateAttachmentArgs
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. LbCertificateAttachmentArgs
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. LbCertificateAttachmentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var lbCertificateAttachmentResource = new Aws.LightSail.LbCertificateAttachment("lbCertificateAttachmentResource", new()
{
    CertificateName = "string",
    LbName = "string",
});
Copy
example, err := lightsail.NewLbCertificateAttachment(ctx, "lbCertificateAttachmentResource", &lightsail.LbCertificateAttachmentArgs{
	CertificateName: pulumi.String("string"),
	LbName:          pulumi.String("string"),
})
Copy
var lbCertificateAttachmentResource = new LbCertificateAttachment("lbCertificateAttachmentResource", LbCertificateAttachmentArgs.builder()
    .certificateName("string")
    .lbName("string")
    .build());
Copy
lb_certificate_attachment_resource = aws.lightsail.LbCertificateAttachment("lbCertificateAttachmentResource",
    certificate_name="string",
    lb_name="string")
Copy
const lbCertificateAttachmentResource = new aws.lightsail.LbCertificateAttachment("lbCertificateAttachmentResource", {
    certificateName: "string",
    lbName: "string",
});
Copy
type: aws:lightsail:LbCertificateAttachment
properties:
    certificateName: string
    lbName: string
Copy

LbCertificateAttachment 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 LbCertificateAttachment resource accepts the following input properties:

CertificateName
This property is required.
Changes to this property will trigger replacement.
string
The name of your SSL/TLS certificate.
LbName
This property is required.
Changes to this property will trigger replacement.
string
The name of the load balancer to which you want to associate the SSL/TLS certificate.
CertificateName
This property is required.
Changes to this property will trigger replacement.
string
The name of your SSL/TLS certificate.
LbName
This property is required.
Changes to this property will trigger replacement.
string
The name of the load balancer to which you want to associate the SSL/TLS certificate.
certificateName
This property is required.
Changes to this property will trigger replacement.
String
The name of your SSL/TLS certificate.
lbName
This property is required.
Changes to this property will trigger replacement.
String
The name of the load balancer to which you want to associate the SSL/TLS certificate.
certificateName
This property is required.
Changes to this property will trigger replacement.
string
The name of your SSL/TLS certificate.
lbName
This property is required.
Changes to this property will trigger replacement.
string
The name of the load balancer to which you want to associate the SSL/TLS certificate.
certificate_name
This property is required.
Changes to this property will trigger replacement.
str
The name of your SSL/TLS certificate.
lb_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the load balancer to which you want to associate the SSL/TLS certificate.
certificateName
This property is required.
Changes to this property will trigger replacement.
String
The name of your SSL/TLS certificate.
lbName
This property is required.
Changes to this property will trigger replacement.
String
The name of the load balancer to which you want to associate the SSL/TLS certificate.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing LbCertificateAttachment Resource

Get an existing LbCertificateAttachment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: LbCertificateAttachmentState, opts?: CustomResourceOptions): LbCertificateAttachment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        certificate_name: Optional[str] = None,
        lb_name: Optional[str] = None) -> LbCertificateAttachment
func GetLbCertificateAttachment(ctx *Context, name string, id IDInput, state *LbCertificateAttachmentState, opts ...ResourceOption) (*LbCertificateAttachment, error)
public static LbCertificateAttachment Get(string name, Input<string> id, LbCertificateAttachmentState? state, CustomResourceOptions? opts = null)
public static LbCertificateAttachment get(String name, Output<String> id, LbCertificateAttachmentState state, CustomResourceOptions options)
resources:  _:    type: aws:lightsail:LbCertificateAttachment    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CertificateName Changes to this property will trigger replacement. string
The name of your SSL/TLS certificate.
LbName Changes to this property will trigger replacement. string
The name of the load balancer to which you want to associate the SSL/TLS certificate.
CertificateName Changes to this property will trigger replacement. string
The name of your SSL/TLS certificate.
LbName Changes to this property will trigger replacement. string
The name of the load balancer to which you want to associate the SSL/TLS certificate.
certificateName Changes to this property will trigger replacement. String
The name of your SSL/TLS certificate.
lbName Changes to this property will trigger replacement. String
The name of the load balancer to which you want to associate the SSL/TLS certificate.
certificateName Changes to this property will trigger replacement. string
The name of your SSL/TLS certificate.
lbName Changes to this property will trigger replacement. string
The name of the load balancer to which you want to associate the SSL/TLS certificate.
certificate_name Changes to this property will trigger replacement. str
The name of your SSL/TLS certificate.
lb_name Changes to this property will trigger replacement. str
The name of the load balancer to which you want to associate the SSL/TLS certificate.
certificateName Changes to this property will trigger replacement. String
The name of your SSL/TLS certificate.
lbName Changes to this property will trigger replacement. String
The name of the load balancer to which you want to associate the SSL/TLS certificate.

Import

Using pulumi import, import aws_lightsail_lb_certificate_attachment using the name attribute. For example:

$ pulumi import aws:lightsail/lbCertificateAttachment:LbCertificateAttachment test example-load-balancer,example-certificate
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.