DistributionConfiguration class
Manages an Image Builder Distribution Configuration.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.imagebuilder.DistributionConfiguration("example", {
distributions: [{
amiDistributionConfiguration: {
launchPermission: {
userIds: ["123456789012"],
},
amiTags: {
CostCenter: "IT",
},
name: "example-{{ imagebuilder:buildDate }}",
},
launchTemplateConfigurations: [{
launchTemplateId: "lt-0aaa1bcde2ff3456",
}],
region: "us-east-1",
}],
name: "example",
});
import pulumi
import pulumi_aws as aws
example = aws.imagebuilder.DistributionConfiguration("example",
distributions=[{
"ami_distribution_configuration": {
"launch_permission": {
"user_ids": ["123456789012"],
},
"ami_tags": {
"CostCenter": "IT",
},
"name": "example-{{ imagebuilder:buildDate }}",
},
"launch_template_configurations": [{
"launch_template_id": "lt-0aaa1bcde2ff3456",
}],
"region": "us-east-1",
}],
name="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.ImageBuilder.DistributionConfiguration("example", new()
{
Distributions = new[]
{
new Aws.ImageBuilder.Inputs.DistributionConfigurationDistributionArgs
{
AmiDistributionConfiguration = new Aws.ImageBuilder.Inputs.DistributionConfigurationDistributionAmiDistributionConfigurationArgs
{
LaunchPermission = new Aws.ImageBuilder.Inputs.DistributionConfigurationDistributionAmiDistributionConfigurationLaunchPermissionArgs
{
UserIds = new[]
{
"123456789012",
},
},
AmiTags =
{
{ "CostCenter", "IT" },
},
Name = "example-{{ imagebuilder:buildDate }}",
},
LaunchTemplateConfigurations = new[]
{
new Aws.ImageBuilder.Inputs.DistributionConfigurationDistributionLaunchTemplateConfigurationArgs
{
LaunchTemplateId = "lt-0aaa1bcde2ff3456",
},
},
Region = "us-east-1",
},
},
Name = "example",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/imagebuilder"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := imagebuilder.NewDistributionConfiguration(ctx, "example", &imagebuilder.DistributionConfigurationArgs{
Distributions: imagebuilder.DistributionConfigurationDistributionArray{
&imagebuilder.DistributionConfigurationDistributionArgs{
AmiDistributionConfiguration: &imagebuilder.DistributionConfigurationDistributionAmiDistributionConfigurationArgs{
LaunchPermission: &imagebuilder.DistributionConfigurationDistributionAmiDistributionConfigurationLaunchPermissionArgs{
UserIds: pulumi.StringArray{
pulumi.String("123456789012"),
},
},
AmiTags: pulumi.StringMap{
"CostCenter": pulumi.String("IT"),
},
Name: pulumi.String("example-{{ imagebuilder:buildDate }}"),
},
LaunchTemplateConfigurations: imagebuilder.DistributionConfigurationDistributionLaunchTemplateConfigurationArray{
&imagebuilder.DistributionConfigurationDistributionLaunchTemplateConfigurationArgs{
LaunchTemplateId: pulumi.String("lt-0aaa1bcde2ff3456"),
},
},
Region: pulumi.String("us-east-1"),
},
},
Name: pulumi.String("example"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_imagebuilder_distributionconfiguration" "example" {
distributions {
ami_distribution_configuration = {
launch_permission = {
user_ids = ["123456789012"]
}
ami_tags = {
"CostCenter" = "IT"
}
name = "example-{{ imagebuilder:buildDate }}"
}
launch_template_configurations {
launch_template_id = "lt-0aaa1bcde2ff3456"
}
region = "us-east-1"
}
name = "example"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.imagebuilder.DistributionConfiguration;
import com.pulumi.aws.imagebuilder.DistributionConfigurationArgs;
import com.pulumi.aws.imagebuilder.inputs.DistributionConfigurationDistributionArgs;
import com.pulumi.aws.imagebuilder.inputs.DistributionConfigurationDistributionAmiDistributionConfigurationArgs;
import com.pulumi.aws.imagebuilder.inputs.DistributionConfigurationDistributionAmiDistributionConfigurationLaunchPermissionArgs;
import com.pulumi.aws.imagebuilder.inputs.DistributionConfigurationDistributionLaunchTemplateConfigurationArgs;
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 DistributionConfiguration("example", DistributionConfigurationArgs.builder()
.distributions(DistributionConfigurationDistributionArgs.builder()
.amiDistributionConfiguration(DistributionConfigurationDistributionAmiDistributionConfigurationArgs.builder()
.launchPermission(DistributionConfigurationDistributionAmiDistributionConfigurationLaunchPermissionArgs.builder()
.userIds("123456789012")
.build())
.amiTags(Map.of("CostCenter", "IT"))
.name("example-{{ imagebuilder:buildDate }}")
.build())
.launchTemplateConfigurations(DistributionConfigurationDistributionLaunchTemplateConfigurationArgs.builder()
.launchTemplateId("lt-0aaa1bcde2ff3456")
.build())
.region("us-east-1")
.build())
.name("example")
.build());
}
}
resources:
example:
type: aws:imagebuilder:DistributionConfiguration
properties:
distributions:
- amiDistributionConfiguration:
launchPermission:
userIds:
- '123456789012'
amiTags:
CostCenter: IT
name: example-{{ imagebuilder:buildDate }}
launchTemplateConfigurations:
- launchTemplateId: lt-0aaa1bcde2ff3456
region: us-east-1
name: example
Import
Identity Schema
Required
arn(String) ARN of the Image Builder distribution configuration.
Using pulumi import, import aws.imagebuilder.getDistributionConfigurations resources using the ARN. For example:
$ pulumi import aws:imagebuilder/distributionConfiguration:DistributionConfiguration example arn:aws:imagebuilder:us-east-1:123456789012:distribution-configuration/example
Constructors
- DistributionConfiguration(String name, {DistributionConfigurationArgs? args, CustomResourceOptions? options})
-
Creates a new DistributionConfiguration.
nameThe Pulumi resource name.argsArguments used to configure this DistributionConfiguration. The set of arguments for DistributionConfiguration.optionsResource options controlling this resource's behavior. - DistributionConfiguration.reference(String urn)
- Creates a typed reference to an existing DistributionConfiguration resource.
Properties
-
arn
↔ Output<
String> -
(Required) ARN of the distribution configuration.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
dateCreated
↔ Output<
String> -
Date the distribution configuration was created.
latefinal
-
dateUpdated
↔ Output<
String> -
Date the distribution configuration was updated.
latefinal
-
description
↔ Output<
String?> -
Description of the distribution configuration.
latefinal
-
distributions
↔ Output<
List< DistributionConfigurationDistribution> > -
One or more configuration blocks with distribution settings. Detailed below.
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 distribution configuration.
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
-
Key-value map of resource tags for the distribution configuration. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A 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, {DistributionConfigurationState? state, CustomResourceOptions? options}) → DistributionConfiguration -
Gets an existing DistributionConfiguration resource's state with the given
nameandid.