Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. ebs
  5. EncryptionByDefault

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.ebs.EncryptionByDefault

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a resource to manage whether default EBS encryption is enabled for your AWS account in the current AWS region. To manage the default KMS key for the region, see the aws.ebs.DefaultKmsKey resource.

    NOTE: Removing this resource disables default EBS encryption.

    Example Usage

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

const example = new aws.ebs.EncryptionByDefault("example", {enabled: true});

    import pulumi
import pulumi_aws as aws

example = aws.ebs.EncryptionByDefault("example", enabled=True)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ebs.NewEncryptionByDefault(ctx, "example", &ebs.EncryptionByDefaultArgs{
			Enabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ebs.EncryptionByDefault("example", new()
    {
        Enabled = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ebs.EncryptionByDefault;
import com.pulumi.aws.ebs.EncryptionByDefaultArgs;
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 example = new EncryptionByDefault("example", EncryptionByDefaultArgs.builder()
            .enabled(true)
            .build());

    }
}

    resources:
  example:
    type: aws:ebs:EncryptionByDefault
    properties:
      enabled: true

    Create EncryptionByDefault Resource

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

    Constructor syntax

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

@overload
def EncryptionByDefault(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        enabled: Optional[bool] = None)
    func NewEncryptionByDefault(ctx *Context, name string, args *EncryptionByDefaultArgs, opts ...ResourceOption) (*EncryptionByDefault, error)
    public EncryptionByDefault(string name, EncryptionByDefaultArgs? args = null, CustomResourceOptions? opts = null)
    public EncryptionByDefault(String name, EncryptionByDefaultArgs args)
public EncryptionByDefault(String name, EncryptionByDefaultArgs args, CustomResourceOptions options)

    type: aws:ebs:EncryptionByDefault
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args EncryptionByDefaultArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EncryptionByDefaultArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EncryptionByDefaultArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EncryptionByDefaultArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EncryptionByDefaultArgs
    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 encryptionByDefaultResource = new Aws.Ebs.EncryptionByDefault("encryptionByDefaultResource", new()
{
    Enabled = false,
});

    example, err := ebs.NewEncryptionByDefault(ctx, "encryptionByDefaultResource", &ebs.EncryptionByDefaultArgs{
	Enabled: pulumi.Bool(false),
})

    var encryptionByDefaultResource = new EncryptionByDefault("encryptionByDefaultResource", EncryptionByDefaultArgs.builder()
    .enabled(false)
    .build());

    encryption_by_default_resource = aws.ebs.EncryptionByDefault("encryptionByDefaultResource", enabled=False)

    const encryptionByDefaultResource = new aws.ebs.EncryptionByDefault("encryptionByDefaultResource", {enabled: false});

    type: aws:ebs:EncryptionByDefault
properties:
    enabled: false

    EncryptionByDefault Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The EncryptionByDefault resource accepts the following input properties:

    Enabled bool
    Whether or not default EBS encryption is enabled. Valid values are true or false. Defaults to true.
    Enabled bool
    Whether or not default EBS encryption is enabled. Valid values are true or false. Defaults to true.
    enabled Boolean
    Whether or not default EBS encryption is enabled. Valid values are true or false. Defaults to true.
    enabled boolean
    Whether or not default EBS encryption is enabled. Valid values are true or false. Defaults to true.
    enabled bool
    Whether or not default EBS encryption is enabled. Valid values are true or false. Defaults to true.
    enabled Boolean
    Whether or not default EBS encryption is enabled. Valid values are true or false. Defaults to true.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EncryptionByDefault 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 EncryptionByDefault Resource

    Get an existing EncryptionByDefault 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?: EncryptionByDefaultState, opts?: CustomResourceOptions): EncryptionByDefault
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None) -> EncryptionByDefault
    func GetEncryptionByDefault(ctx *Context, name string, id IDInput, state *EncryptionByDefaultState, opts ...ResourceOption) (*EncryptionByDefault, error)
    public static EncryptionByDefault Get(string name, Input<string> id, EncryptionByDefaultState? state, CustomResourceOptions? opts = null)
    public static EncryptionByDefault get(String name, Output<String> id, EncryptionByDefaultState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Enabled bool
    Whether or not default EBS encryption is enabled. Valid values are true or false. Defaults to true.
    Enabled bool
    Whether or not default EBS encryption is enabled. Valid values are true or false. Defaults to true.
    enabled Boolean
    Whether or not default EBS encryption is enabled. Valid values are true or false. Defaults to true.
    enabled boolean
    Whether or not default EBS encryption is enabled. Valid values are true or false. Defaults to true.
    enabled bool
    Whether or not default EBS encryption is enabled. Valid values are true or false. Defaults to true.
    enabled Boolean
    Whether or not default EBS encryption is enabled. Valid values are true or false. Defaults to true.

    Import

    Using pulumi import, import the default EBS encryption state. For example:

    $ pulumi import aws:ebs/encryptionByDefault:EncryptionByDefault example default

    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.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws