Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. imagebuilder
  5. getImagePipeline

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.imagebuilder.getImagePipeline

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::ImageBuilder::ImagePipeline

    Using getImagePipeline

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getImagePipeline(args: GetImagePipelineArgs, opts?: InvokeOptions): Promise<GetImagePipelineResult>
function getImagePipelineOutput(args: GetImagePipelineOutputArgs, opts?: InvokeOptions): Output<GetImagePipelineResult>
    def get_image_pipeline(arn: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetImagePipelineResult
def get_image_pipeline_output(arn: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetImagePipelineResult]
    func LookupImagePipeline(ctx *Context, args *LookupImagePipelineArgs, opts ...InvokeOption) (*LookupImagePipelineResult, error)
func LookupImagePipelineOutput(ctx *Context, args *LookupImagePipelineOutputArgs, opts ...InvokeOption) LookupImagePipelineResultOutput

    > Note: This function is named LookupImagePipeline in the Go SDK.

    public static class GetImagePipeline 
{
    public static Task<GetImagePipelineResult> InvokeAsync(GetImagePipelineArgs args, InvokeOptions? opts = null)
    public static Output<GetImagePipelineResult> Invoke(GetImagePipelineInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetImagePipelineResult> getImagePipeline(GetImagePipelineArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:imagebuilder:getImagePipeline
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the image pipeline.
    Arn string
    The Amazon Resource Name (ARN) of the image pipeline.
    arn String
    The Amazon Resource Name (ARN) of the image pipeline.
    arn string
    The Amazon Resource Name (ARN) of the image pipeline.
    arn str
    The Amazon Resource Name (ARN) of the image pipeline.
    arn String
    The Amazon Resource Name (ARN) of the image pipeline.

    getImagePipeline Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the image pipeline.
    ContainerRecipeArn string
    The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
    Description string
    The description of the image pipeline.
    DistributionConfigurationArn string
    The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
    EnhancedImageMetadataEnabled bool
    Collects additional information about the image being created, including the operating system (OS) version and package list.
    ExecutionRole string
    The execution role name/ARN for the image build, if provided
    ImageRecipeArn string
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    ImageScanningConfiguration Pulumi.AwsNative.ImageBuilder.Outputs.ImagePipelineImageScanningConfiguration
    Contains settings for vulnerability scans.
    ImageTestsConfiguration Pulumi.AwsNative.ImageBuilder.Outputs.ImagePipelineImageTestsConfiguration
    The image tests configuration of the image pipeline.
    InfrastructureConfigurationArn string
    The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
    Schedule Pulumi.AwsNative.ImageBuilder.Outputs.ImagePipelineSchedule
    The schedule of the image pipeline.
    Status Pulumi.AwsNative.ImageBuilder.ImagePipelineStatus
    The status of the image pipeline.
    Tags Dictionary<string, string>
    The tags of this image pipeline.
    Workflows List<Pulumi.AwsNative.ImageBuilder.Outputs.ImagePipelineWorkflowConfiguration>
    Workflows to define the image build process
    Arn string
    The Amazon Resource Name (ARN) of the image pipeline.
    ContainerRecipeArn string
    The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
    Description string
    The description of the image pipeline.
    DistributionConfigurationArn string
    The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
    EnhancedImageMetadataEnabled bool
    Collects additional information about the image being created, including the operating system (OS) version and package list.
    ExecutionRole string
    The execution role name/ARN for the image build, if provided
    ImageRecipeArn string
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    ImageScanningConfiguration ImagePipelineImageScanningConfiguration
    Contains settings for vulnerability scans.
    ImageTestsConfiguration ImagePipelineImageTestsConfiguration
    The image tests configuration of the image pipeline.
    InfrastructureConfigurationArn string
    The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
    Schedule ImagePipelineSchedule
    The schedule of the image pipeline.
    Status ImagePipelineStatus
    The status of the image pipeline.
    Tags map[string]string
    The tags of this image pipeline.
    Workflows []ImagePipelineWorkflowConfiguration
    Workflows to define the image build process
    arn String
    The Amazon Resource Name (ARN) of the image pipeline.
    containerRecipeArn String
    The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
    description String
    The description of the image pipeline.
    distributionConfigurationArn String
    The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
    enhancedImageMetadataEnabled Boolean
    Collects additional information about the image being created, including the operating system (OS) version and package list.
    executionRole String
    The execution role name/ARN for the image build, if provided
    imageRecipeArn String
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    imageScanningConfiguration ImagePipelineImageScanningConfiguration
    Contains settings for vulnerability scans.
    imageTestsConfiguration ImagePipelineImageTestsConfiguration
    The image tests configuration of the image pipeline.
    infrastructureConfigurationArn String
    The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
    schedule ImagePipelineSchedule
    The schedule of the image pipeline.
    status ImagePipelineStatus
    The status of the image pipeline.
    tags Map<String,String>
    The tags of this image pipeline.
    workflows List<ImagePipelineWorkflowConfiguration>
    Workflows to define the image build process
    arn string
    The Amazon Resource Name (ARN) of the image pipeline.
    containerRecipeArn string
    The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
    description string
    The description of the image pipeline.
    distributionConfigurationArn string
    The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
    enhancedImageMetadataEnabled boolean
    Collects additional information about the image being created, including the operating system (OS) version and package list.
    executionRole string
    The execution role name/ARN for the image build, if provided
    imageRecipeArn string
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    imageScanningConfiguration ImagePipelineImageScanningConfiguration
    Contains settings for vulnerability scans.
    imageTestsConfiguration ImagePipelineImageTestsConfiguration
    The image tests configuration of the image pipeline.
    infrastructureConfigurationArn string
    The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
    schedule ImagePipelineSchedule
    The schedule of the image pipeline.
    status ImagePipelineStatus
    The status of the image pipeline.
    tags {[key: string]: string}
    The tags of this image pipeline.
    workflows ImagePipelineWorkflowConfiguration[]
    Workflows to define the image build process
    arn str
    The Amazon Resource Name (ARN) of the image pipeline.
    container_recipe_arn str
    The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
    description str
    The description of the image pipeline.
    distribution_configuration_arn str
    The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
    enhanced_image_metadata_enabled bool
    Collects additional information about the image being created, including the operating system (OS) version and package list.
    execution_role str
    The execution role name/ARN for the image build, if provided
    image_recipe_arn str
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    image_scanning_configuration ImagePipelineImageScanningConfiguration
    Contains settings for vulnerability scans.
    image_tests_configuration ImagePipelineImageTestsConfiguration
    The image tests configuration of the image pipeline.
    infrastructure_configuration_arn str
    The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
    schedule ImagePipelineSchedule
    The schedule of the image pipeline.
    status ImagePipelineStatus
    The status of the image pipeline.
    tags Mapping[str, str]
    The tags of this image pipeline.
    workflows Sequence[ImagePipelineWorkflowConfiguration]
    Workflows to define the image build process
    arn String
    The Amazon Resource Name (ARN) of the image pipeline.
    containerRecipeArn String
    The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
    description String
    The description of the image pipeline.
    distributionConfigurationArn String
    The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
    enhancedImageMetadataEnabled Boolean
    Collects additional information about the image being created, including the operating system (OS) version and package list.
    executionRole String
    The execution role name/ARN for the image build, if provided
    imageRecipeArn String
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    imageScanningConfiguration Property Map
    Contains settings for vulnerability scans.
    imageTestsConfiguration Property Map
    The image tests configuration of the image pipeline.
    infrastructureConfigurationArn String
    The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
    schedule Property Map
    The schedule of the image pipeline.
    status "DISABLED" | "ENABLED"
    The status of the image pipeline.
    tags Map<String>
    The tags of this image pipeline.
    workflows List<Property Map>
    Workflows to define the image build process

    Supporting Types

    ImagePipelineEcrConfiguration

    ContainerTags List<string>
    Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.
    RepositoryName string
    The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don't provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images.
    ContainerTags []string
    Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.
    RepositoryName string
    The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don't provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images.
    containerTags List<String>
    Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.
    repositoryName String
    The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don't provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images.
    containerTags string[]
    Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.
    repositoryName string
    The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don't provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images.
    container_tags Sequence[str]
    Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.
    repository_name str
    The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don't provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images.
    containerTags List<String>
    Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images.
    repositoryName String
    The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don't provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images.

    ImagePipelineImageScanningConfiguration

    EcrConfiguration Pulumi.AwsNative.ImageBuilder.Inputs.ImagePipelineEcrConfiguration
    Contains ECR settings for vulnerability scans.
    ImageScanningEnabled bool
    This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
    EcrConfiguration ImagePipelineEcrConfiguration
    Contains ECR settings for vulnerability scans.
    ImageScanningEnabled bool
    This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
    ecrConfiguration ImagePipelineEcrConfiguration
    Contains ECR settings for vulnerability scans.
    imageScanningEnabled Boolean
    This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
    ecrConfiguration ImagePipelineEcrConfiguration
    Contains ECR settings for vulnerability scans.
    imageScanningEnabled boolean
    This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
    ecr_configuration ImagePipelineEcrConfiguration
    Contains ECR settings for vulnerability scans.
    image_scanning_enabled bool
    This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
    ecrConfiguration Property Map
    Contains ECR settings for vulnerability scans.
    imageScanningEnabled Boolean
    This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.

    ImagePipelineImageTestsConfiguration

    ImageTestsEnabled bool
    Defines if tests should be executed when building this image.
    TimeoutMinutes int
    The maximum time in minutes that tests are permitted to run.
    ImageTestsEnabled bool
    Defines if tests should be executed when building this image.
    TimeoutMinutes int
    The maximum time in minutes that tests are permitted to run.
    imageTestsEnabled Boolean
    Defines if tests should be executed when building this image.
    timeoutMinutes Integer
    The maximum time in minutes that tests are permitted to run.
    imageTestsEnabled boolean
    Defines if tests should be executed when building this image.
    timeoutMinutes number
    The maximum time in minutes that tests are permitted to run.
    image_tests_enabled bool
    Defines if tests should be executed when building this image.
    timeout_minutes int
    The maximum time in minutes that tests are permitted to run.
    imageTestsEnabled Boolean
    Defines if tests should be executed when building this image.
    timeoutMinutes Number
    The maximum time in minutes that tests are permitted to run.

    ImagePipelineSchedule

    PipelineExecutionStartCondition Pulumi.AwsNative.ImageBuilder.ImagePipelineSchedulePipelineExecutionStartCondition
    The condition configures when the pipeline should trigger a new image build.
    ScheduleExpression string
    The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
    PipelineExecutionStartCondition ImagePipelineSchedulePipelineExecutionStartCondition
    The condition configures when the pipeline should trigger a new image build.
    ScheduleExpression string
    The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
    pipelineExecutionStartCondition ImagePipelineSchedulePipelineExecutionStartCondition
    The condition configures when the pipeline should trigger a new image build.
    scheduleExpression String
    The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
    pipelineExecutionStartCondition ImagePipelineSchedulePipelineExecutionStartCondition
    The condition configures when the pipeline should trigger a new image build.
    scheduleExpression string
    The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
    pipeline_execution_start_condition ImagePipelineSchedulePipelineExecutionStartCondition
    The condition configures when the pipeline should trigger a new image build.
    schedule_expression str
    The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
    pipelineExecutionStartCondition "EXPRESSION_MATCH_ONLY" | "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
    The condition configures when the pipeline should trigger a new image build.
    scheduleExpression String
    The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.

    ImagePipelineSchedulePipelineExecutionStartCondition

    ImagePipelineStatus

    ImagePipelineWorkflowConfiguration

    OnFailure Pulumi.AwsNative.ImageBuilder.ImagePipelineWorkflowConfigurationOnFailure
    Define execution decision in case of workflow failure
    ParallelGroup string
    The parallel group name
    Parameters List<Pulumi.AwsNative.ImageBuilder.Inputs.ImagePipelineWorkflowParameter>
    The parameters associated with the workflow
    WorkflowArn string
    The Amazon Resource Name (ARN) of the workflow
    OnFailure ImagePipelineWorkflowConfigurationOnFailure
    Define execution decision in case of workflow failure
    ParallelGroup string
    The parallel group name
    Parameters []ImagePipelineWorkflowParameter
    The parameters associated with the workflow
    WorkflowArn string
    The Amazon Resource Name (ARN) of the workflow
    onFailure ImagePipelineWorkflowConfigurationOnFailure
    Define execution decision in case of workflow failure
    parallelGroup String
    The parallel group name
    parameters List<ImagePipelineWorkflowParameter>
    The parameters associated with the workflow
    workflowArn String
    The Amazon Resource Name (ARN) of the workflow
    onFailure ImagePipelineWorkflowConfigurationOnFailure
    Define execution decision in case of workflow failure
    parallelGroup string
    The parallel group name
    parameters ImagePipelineWorkflowParameter[]
    The parameters associated with the workflow
    workflowArn string
    The Amazon Resource Name (ARN) of the workflow
    on_failure ImagePipelineWorkflowConfigurationOnFailure
    Define execution decision in case of workflow failure
    parallel_group str
    The parallel group name
    parameters Sequence[ImagePipelineWorkflowParameter]
    The parameters associated with the workflow
    workflow_arn str
    The Amazon Resource Name (ARN) of the workflow
    onFailure "CONTINUE" | "ABORT"
    Define execution decision in case of workflow failure
    parallelGroup String
    The parallel group name
    parameters List<Property Map>
    The parameters associated with the workflow
    workflowArn String
    The Amazon Resource Name (ARN) of the workflow

    ImagePipelineWorkflowConfigurationOnFailure

    ImagePipelineWorkflowParameter

    Name string
    The name of the workflow parameter to set.
    Value List<string>
    Sets the value for the named workflow parameter.
    Name string
    The name of the workflow parameter to set.
    Value []string
    Sets the value for the named workflow parameter.
    name String
    The name of the workflow parameter to set.
    value List<String>
    Sets the value for the named workflow parameter.
    name string
    The name of the workflow parameter to set.
    value string[]
    Sets the value for the named workflow parameter.
    name str
    The name of the workflow parameter to set.
    value Sequence[str]
    Sets the value for the named workflow parameter.
    name String
    The name of the workflow parameter to set.
    value List<String>
    Sets the value for the named workflow parameter.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native