Component class
Manages an Image Builder Component.
Example Usage
URI Document
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.imagebuilder.Component("example", {
name: "example",
platform: "Linux",
uri: `s3://${exampleAwsS3Object.bucket}/${exampleAwsS3Object.key}`,
version: "1.0.0",
});
import pulumi
import pulumi_aws as aws
example = aws.imagebuilder.Component("example",
name="example",
platform="Linux",
uri=f"s3://{example_aws_s3_object['bucket']}/{example_aws_s3_object['key']}",
version="1.0.0")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.ImageBuilder.Component("example", new()
{
Name = "example",
Platform = "Linux",
Uri = $"s3://{exampleAwsS3Object.Bucket}/{exampleAwsS3Object.Key}",
Version = "1.0.0",
});
});
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.NewComponent(ctx, "example", &imagebuilder.ComponentArgs{
Name: pulumi.String("example"),
Platform: pulumi.String("Linux"),
Uri: pulumi.Sprintf("s3://%v/%v", exampleAwsS3Object.Bucket, exampleAwsS3Object.Key),
Version: pulumi.String("1.0.0"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_imagebuilder_component" "example" {
name = "example"
platform = "Linux"
uri ="s3://${exampleAwsS3Object.bucket}/${exampleAwsS3Object.key}"
version = "1.0.0"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.imagebuilder.Component;
import com.pulumi.aws.imagebuilder.ComponentArgs;
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 Component("example", ComponentArgs.builder()
.name("example")
.platform("Linux")
.uri(String.format("s3://%s/%s", exampleAwsS3Object.bucket(),exampleAwsS3Object.key()))
.version("1.0.0")
.build());
}
}
resources:
example:
type: aws:imagebuilder:Component
properties:
name: example
platform: Linux
uri: s3://${exampleAwsS3Object.bucket}/${exampleAwsS3Object.key}
version: 1.0.0
Import
Using pulumi import, import aws.imagebuilder.getComponents resources using the ARN. For example:
$ pulumi import aws:imagebuilder/component:Component example arn:aws:imagebuilder:us-east-1:123456789012:component/example/1.0.0/1
Certain resource arguments, such as uri, cannot be read via the API and imported into the provider. The provider will display a difference for these arguments the first run after import if declared in the the provider configuration for an imported resource.
Constructors
- Component(String name, {ComponentArgs? args, CustomResourceOptions? options})
-
Creates a new Component.
nameThe Pulumi resource name.argsArguments used to configure this Component. The set of arguments for Component.optionsResource options controlling this resource's behavior. - Component.reference(String urn)
- Creates a typed reference to an existing Component resource.
Properties
-
arn
↔ Output<
String> -
(Required) ARN of the component.
latefinal
-
changeDescription
↔ Output<
String?> -
Change description of the component.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
data
↔ Output<
String> -
Inline YAML string with data of the component. Exactly one of
dataandurican be specified. the provider will only perform drift detection of its value when present in a configuration.latefinal -
dateCreated
↔ Output<
String> -
Date the component was created.
latefinal
-
description
↔ Output<
String?> -
Description of the component.
latefinal
-
encrypted
↔ Output<
bool> -
Encryption status of the component.
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
-
kmsKeyId
↔ Output<
String?> -
ARN of the KMS Key used to encrypt the component.
latefinal
-
name
↔ Output<
String> -
Name of the component.
latefinal
-
owner
↔ Output<
String> -
Owner of the component.
latefinal
-
platform
↔ Output<
String> -
Platform of the component.
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
-
skipDestroy
↔ Output<
bool?> -
Whether to retain the old version when the resource is destroyed or replacement is necessary. Defaults to
false.latefinal -
supportedOsVersions
↔ Output<
List< String> ?> -
Set of Operating Systems (OS) supported by the component.
latefinal
-
Key-value map of resource tags for the component. 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
-
type
↔ Output<
String> -
Type of the component.
latefinal
-
uri
↔ Output<
String?> -
S3 URI with data of the component. Exactly one of
dataandurican be specified.latefinal -
urn
↔ Output<
String> -
latefinalinherited
-
version
↔ Output<
String> -
Version of the component.
latefinal
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