LbHttpsRedirectionPolicy class

Manages HTTPS redirection for a Lightsail Load Balancer.

Use this resource to configure automatic redirection of HTTP traffic to HTTPS on a Lightsail Load Balancer. A valid certificate must be attached to the load balancer before enabling HTTPS redirection.

Example Usage

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

const example = new aws.lightsail.Lb("example", {
    name: "example-load-balancer",
    healthCheckPath: "/",
    instancePort: 80,
    tags: {
        foo: "bar",
    },
});
const exampleLbCertificate = new aws.lightsail.LbCertificate("example", {
    name: "example-load-balancer-certificate",
    lbName: example.id,
    domainName: "example.com",
});
const exampleLbCertificateAttachment = new aws.lightsail.LbCertificateAttachment("example", {
    lbName: example.name,
    certificateName: exampleLbCertificate.name,
});
const exampleLbHttpsRedirectionPolicy = new aws.lightsail.LbHttpsRedirectionPolicy("example", {
    lbName: example.name,
    enabled: true,
});
import pulumi
import pulumi_aws as aws

example = aws.lightsail.Lb("example",
    name="example-load-balancer",
    health_check_path="/",
    instance_port=80,
    tags={
        "foo": "bar",
    })
example_lb_certificate = aws.lightsail.LbCertificate("example",
    name="example-load-balancer-certificate",
    lb_name=example.id,
    domain_name="example.com")
example_lb_certificate_attachment = aws.lightsail.LbCertificateAttachment("example",
    lb_name=example.name,
    certificate_name=example_lb_certificate.name)
example_lb_https_redirection_policy = aws.lightsail.LbHttpsRedirectionPolicy("example",
    lb_name=example.name,
    enabled=True)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

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

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

    var exampleLbCertificateAttachment = new Aws.LightSail.LbCertificateAttachment("example", new()
    {
        LbName = example.Name,
        CertificateName = exampleLbCertificate.Name,
    });

    var exampleLbHttpsRedirectionPolicy = new Aws.LightSail.LbHttpsRedirectionPolicy("example", new()
    {
        LbName = example.Name,
        Enabled = true,
    });

});
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 {
		example, err := lightsail.NewLb(ctx, "example", &lightsail.LbArgs{
			Name:            pulumi.String("example-load-balancer"),
			HealthCheckPath: pulumi.String("/"),
			InstancePort:    pulumi.Int(80),
			Tags: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
		})
		if err != nil {
			return err
		}
		exampleLbCertificate, err := lightsail.NewLbCertificate(ctx, "example", &lightsail.LbCertificateArgs{
			Name:       pulumi.String("example-load-balancer-certificate"),
			LbName:     example.ID().ToIDOutput().ToStringOutput(),
			DomainName: pulumi.String("example.com"),
		})
		if err != nil {
			return err
		}
		_, err = lightsail.NewLbCertificateAttachment(ctx, "example", &lightsail.LbCertificateAttachmentArgs{
			LbName:          example.Name,
			CertificateName: exampleLbCertificate.Name,
		})
		if err != nil {
			return err
		}
		_, err = lightsail.NewLbHttpsRedirectionPolicy(ctx, "example", &lightsail.LbHttpsRedirectionPolicyArgs{
			LbName:  example.Name,
			Enabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_lightsail_lb" "example" {
  name              = "example-load-balancer"
  health_check_path = "/"
  instance_port     = "80"
  tags = {
    "foo" = "bar"
  }
}
resource "aws_lightsail_lbcertificate" "example" {
  name        = "example-load-balancer-certificate"
  lb_name     = aws_lightsail_lb.example.id
  domain_name = "example.com"
}
resource "aws_lightsail_lbcertificateattachment" "example" {
  lb_name          = aws_lightsail_lb.example.name
  certificate_name = aws_lightsail_lbcertificate.example.name
}
resource "aws_lightsail_lbhttpsredirectionpolicy" "example" {
  lb_name = aws_lightsail_lb.example.name
  enabled = true
}
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 com.pulumi.aws.lightsail.LbHttpsRedirectionPolicy;
import com.pulumi.aws.lightsail.LbHttpsRedirectionPolicyArgs;
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 Lb("example", LbArgs.builder()
            .name("example-load-balancer")
            .healthCheckPath("/")
            .instancePort(80)
            .tags(Map.of("foo", "bar"))
            .build());

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

        var exampleLbCertificateAttachment = new LbCertificateAttachment("exampleLbCertificateAttachment", LbCertificateAttachmentArgs.builder()
            .lbName(example.name())
            .certificateName(exampleLbCertificate.name())
            .build());

        var exampleLbHttpsRedirectionPolicy = new LbHttpsRedirectionPolicy("exampleLbHttpsRedirectionPolicy", LbHttpsRedirectionPolicyArgs.builder()
            .lbName(example.name())
            .enabled(true)
            .build());

    }
}
resources:
  example:
    type: aws:lightsail:Lb
    properties:
      name: example-load-balancer
      healthCheckPath: /
      instancePort: '80'
      tags:
        foo: bar
  exampleLbCertificate:
    type: aws:lightsail:LbCertificate
    name: example
    properties:
      name: example-load-balancer-certificate
      lbName: ${example.id}
      domainName: example.com
  exampleLbCertificateAttachment:
    type: aws:lightsail:LbCertificateAttachment
    name: example
    properties:
      lbName: ${example.name}
      certificateName: ${exampleLbCertificate.name}
  exampleLbHttpsRedirectionPolicy:
    type: aws:lightsail:LbHttpsRedirectionPolicy
    name: example
    properties:
      lbName: ${example.name}
      enabled: true

Import

Using pulumi import, import aws.lightsail.LbHttpsRedirectionPolicy using the lbName attribute. For example:

$ pulumi import aws:lightsail/lbHttpsRedirectionPolicy:LbHttpsRedirectionPolicy example example-load-balancer

Constructors

LbHttpsRedirectionPolicy(String name, {LbHttpsRedirectionPolicyArgs? args, CustomResourceOptions? options})
Creates a new LbHttpsRedirectionPolicy. name The Pulumi resource name. args Arguments used to configure this LbHttpsRedirectionPolicy. The set of arguments for LbHttpsRedirectionPolicy. options Resource options controlling this resource's behavior.
LbHttpsRedirectionPolicy.reference(String urn)
Creates a typed reference to an existing LbHttpsRedirectionPolicy resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
enabled ↔ Output<bool>
Whether to enable HTTP to HTTPS redirection. true to activate HTTP to HTTPS redirection or false to deactivate HTTP to HTTPS redirection.
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
lbName ↔ Output<String>
Name of the load balancer to which you want to enable HTTP to HTTPS redirection.
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, {LbHttpsRedirectionPolicyState? state, CustomResourceOptions? options}) → LbHttpsRedirectionPolicy
Gets an existing LbHttpsRedirectionPolicy resource's state with the given name and id.