Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. imagebuilder
  5. getImageRecipe

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.imagebuilder.getImageRecipe

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::ImageBuilder::ImageRecipe

    Using getImageRecipe

    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 getImageRecipe(args: GetImageRecipeArgs, opts?: InvokeOptions): Promise<GetImageRecipeResult>
function getImageRecipeOutput(args: GetImageRecipeOutputArgs, opts?: InvokeOptions): Output<GetImageRecipeResult>
    def get_image_recipe(arn: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetImageRecipeResult
def get_image_recipe_output(arn: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetImageRecipeResult]
    func LookupImageRecipe(ctx *Context, args *LookupImageRecipeArgs, opts ...InvokeOption) (*LookupImageRecipeResult, error)
func LookupImageRecipeOutput(ctx *Context, args *LookupImageRecipeOutputArgs, opts ...InvokeOption) LookupImageRecipeResultOutput

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

    public static class GetImageRecipe 
{
    public static Task<GetImageRecipeResult> InvokeAsync(GetImageRecipeArgs args, InvokeOptions? opts = null)
    public static Output<GetImageRecipeResult> Invoke(GetImageRecipeInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetImageRecipeResult> getImageRecipe(GetImageRecipeArgs args, InvokeOptions options)
public static Output<GetImageRecipeResult> getImageRecipe(GetImageRecipeArgs args, InvokeOptions options)

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

    The following arguments are supported:

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

    getImageRecipe Result

    The following output properties are available:

    AdditionalInstanceConfiguration Pulumi.AwsNative.ImageBuilder.Outputs.ImageRecipeAdditionalInstanceConfiguration
    Specify additional settings and launch scripts for your build instances.
    Arn string
    The Amazon Resource Name (ARN) of the image recipe.
    AdditionalInstanceConfiguration ImageRecipeAdditionalInstanceConfiguration
    Specify additional settings and launch scripts for your build instances.
    Arn string
    The Amazon Resource Name (ARN) of the image recipe.
    additionalInstanceConfiguration ImageRecipeAdditionalInstanceConfiguration
    Specify additional settings and launch scripts for your build instances.
    arn String
    The Amazon Resource Name (ARN) of the image recipe.
    additionalInstanceConfiguration ImageRecipeAdditionalInstanceConfiguration
    Specify additional settings and launch scripts for your build instances.
    arn string
    The Amazon Resource Name (ARN) of the image recipe.
    additional_instance_configuration ImageRecipeAdditionalInstanceConfiguration
    Specify additional settings and launch scripts for your build instances.
    arn str
    The Amazon Resource Name (ARN) of the image recipe.
    additionalInstanceConfiguration Property Map
    Specify additional settings and launch scripts for your build instances.
    arn String
    The Amazon Resource Name (ARN) of the image recipe.

    Supporting Types

    ImageRecipeAdditionalInstanceConfiguration

    SystemsManagerAgent Pulumi.AwsNative.ImageBuilder.Inputs.ImageRecipeSystemsManagerAgent
    Contains settings for the SSM agent on your build instance.
    UserDataOverride string
    Use this property to provide commands or a command script to run when you launch your build instance.
    SystemsManagerAgent ImageRecipeSystemsManagerAgent
    Contains settings for the SSM agent on your build instance.
    UserDataOverride string
    Use this property to provide commands or a command script to run when you launch your build instance.
    systemsManagerAgent ImageRecipeSystemsManagerAgent
    Contains settings for the SSM agent on your build instance.
    userDataOverride String
    Use this property to provide commands or a command script to run when you launch your build instance.
    systemsManagerAgent ImageRecipeSystemsManagerAgent
    Contains settings for the SSM agent on your build instance.
    userDataOverride string
    Use this property to provide commands or a command script to run when you launch your build instance.
    systems_manager_agent ImageRecipeSystemsManagerAgent
    Contains settings for the SSM agent on your build instance.
    user_data_override str
    Use this property to provide commands or a command script to run when you launch your build instance.
    systemsManagerAgent Property Map
    Contains settings for the SSM agent on your build instance.
    userDataOverride String
    Use this property to provide commands or a command script to run when you launch your build instance.

    ImageRecipeSystemsManagerAgent

    UninstallAfterBuild bool
    Controls whether the SSM agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.
    UninstallAfterBuild bool
    Controls whether the SSM agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.
    uninstallAfterBuild Boolean
    Controls whether the SSM agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.
    uninstallAfterBuild boolean
    Controls whether the SSM agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.
    uninstall_after_build bool
    Controls whether the SSM agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.
    uninstallAfterBuild Boolean
    Controls whether the SSM agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.

    Package Details

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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native