ImagePipeline class

Manages an Image Builder Image Pipeline.

> NOTE: Starting with version 5.74.0, lifecycle meta-argument replaceTriggeredBy must be used in order to prevent a dependency error on destroy.

Required

  • arn (String) ARN of the Image Builder image pipeline.

Using pulumi import, import aws.imagebuilder.ImagePipeline resources using the ARN. For example:

$ pulumi import aws:imagebuilder/imagePipeline:ImagePipeline example arn:aws:imagebuilder:us-east-1:123456789012:image-pipeline/example

Constructors

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

Properties

arn ↔ Output<String>
ARN of the image pipeline.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
containerRecipeArn ↔ Output<String?>
ARN of the container recipe.
latefinal
dateCreated ↔ Output<String>
Date the image pipeline was created.
latefinal
dateLastRun ↔ Output<String>
Date the image pipeline was last run.
latefinal
dateNextRun ↔ Output<String>
Date the image pipeline will run next.
latefinal
dateUpdated ↔ Output<String>
Date the image pipeline was updated.
latefinal
description ↔ Output<String?>
Description of the image pipeline.
latefinal
distributionConfigurationArn ↔ Output<String?>
ARN of the Image Builder Distribution Configuration.
latefinal
enhancedImageMetadataEnabled ↔ Output<bool?>
Whether additional information about the image being created is collected. Defaults to true.
latefinal
executionRole ↔ Output<String?>
ARN of the service-linked role to be used by Image Builder to execute workflows.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
imageRecipeArn ↔ Output<String?>
ARN of the image recipe.
latefinal
imageScanningConfiguration ↔ Output<ImagePipelineImageScanningConfiguration>
Configuration block with image scanning configuration. Detailed below.
latefinal
imageTestsConfiguration ↔ Output<ImagePipelineImageTestsConfiguration>
Configuration block with image tests configuration. Detailed below.
latefinal
infrastructureConfigurationArn ↔ Output<String>
ARN of the Image Builder Infrastructure Configuration.
latefinal
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
loggingConfiguration ↔ Output<ImagePipelineLoggingConfiguration?>
Configuration block with logging configuration. Detailed below.
latefinal
name ↔ Output<String>
Name of the image pipeline.
latefinal
platform ↔ Output<String>
Platform of the image pipeline.
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
schedule ↔ Output<ImagePipelineSchedule?>
Configuration block with schedule settings. Detailed below.
latefinal
status ↔ Output<String?>
Status of the image pipeline. Valid values are DISABLED and ENABLED. Defaults to ENABLED.
latefinal
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags for the image pipeline. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
workflows ↔ Output<List<ImagePipelineWorkflow>>
Configuration block with the workflow configuration. Detailed below.
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

Static Methods

get(String name, Input<String> id, {ImagePipelineState? state, CustomResourceOptions? options}) → ImagePipeline
Gets an existing ImagePipeline resource's state with the given name and id.