IImagePipeline

class aws_cdk.aws_imagebuilder_alpha.IImagePipeline(*args, **kwargs)

Bases: IResource, Protocol

(experimental) An EC2 Image Builder Image Pipeline.

Stability:: experimental

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:: policy (RemovalPolicy)
Return type:: None

grant(grantee, *actions)

(experimental) Grant custom actions to the given grantee for the image pipeline.

Parameters:

grantee (IGrantable) – The principal.
actions (str) – The list of actions.

Stability:

experimental

Return type:

Grant

grant_default_execution_role_permissions(grantee)

(experimental) Grants the default permissions for building an image to the provided execution role.

Parameters:: grantee (IGrantable) – The execution role used for the image build.
Stability:: experimental
Return type:: List[Grant]

grant_read(grantee)

(experimental) Grant read permissions to the given grantee for the image pipeline.

Parameters:: grantee (IGrantable) – The principal.
Stability:: experimental
Return type:: Grant

grant_start_execution(grantee)

(experimental) Grant permissions to the given grantee to start an execution of the image pipeline.

Parameters:: grantee (IGrantable) – The principal.
Stability:: experimental
Return type:: Grant

on_cve_detected(id, *, target=None, cross_stack_scope=None, description=None, event_pattern=None, rule_name=None)

(experimental) Creates an EventBridge rule for Image Builder CVE detected events.

Parameters:

id (str) – Unique identifier for the rule.
target (Optional[IRuleTarget]) – The target to register for the event. Default: - No target is added to the rule. Use addTarget() to add a target.
cross_stack_scope (Optional[Construct]) – The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region). This helps dealing with cycles that often arise in these situations. Default: - none (the main scope will be used, even for cross-stack Events)
description (Optional[str]) – A description of the rule’s purpose. Default: - No description
event_pattern (Union[EventPattern, Dict[str, Any], None]) – Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. Default: - No additional filtering based on an event pattern.
rule_name (Optional[str]) – A name for the rule. Default: AWS CloudFormation generates a unique physical ID.

See:

https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

Stability:

experimental

Return type:

Rule

on_event(id, *, target=None, cross_stack_scope=None, description=None, event_pattern=None, rule_name=None)

(experimental) Creates an EventBridge rule for Image Builder events.

Parameters:

id (str) – Unique identifier for the rule.
target (Optional[IRuleTarget]) – The target to register for the event. Default: - No target is added to the rule. Use addTarget() to add a target.
cross_stack_scope (Optional[Construct]) – The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region). This helps dealing with cycles that often arise in these situations. Default: - none (the main scope will be used, even for cross-stack Events)
description (Optional[str]) – A description of the rule’s purpose. Default: - No description
event_pattern (Union[EventPattern, Dict[str, Any], None]) – Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. Default: - No additional filtering based on an event pattern.
rule_name (Optional[str]) – A name for the rule. Default: AWS CloudFormation generates a unique physical ID.

See:

https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

Stability:

experimental

Return type:

Rule

on_image_build_completed(id, *, target=None, cross_stack_scope=None, description=None, event_pattern=None, rule_name=None)

(experimental) Creates an EventBridge rule for Image Builder image build completion events.

Parameters:

id (str) – Unique identifier for the rule.
target (Optional[IRuleTarget]) – The target to register for the event. Default: - No target is added to the rule. Use addTarget() to add a target.
cross_stack_scope (Optional[Construct]) – The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region). This helps dealing with cycles that often arise in these situations. Default: - none (the main scope will be used, even for cross-stack Events)
description (Optional[str]) – A description of the rule’s purpose. Default: - No description
event_pattern (Union[EventPattern, Dict[str, Any], None]) – Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. Default: - No additional filtering based on an event pattern.
rule_name (Optional[str]) – A name for the rule. Default: AWS CloudFormation generates a unique physical ID.

See:

https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

Stability:

experimental

Return type:

Rule

on_image_build_failed(id, *, target=None, cross_stack_scope=None, description=None, event_pattern=None, rule_name=None)

(experimental) Creates an EventBridge rule for Image Builder image build failure events.

Parameters:

id (str) – Unique identifier for the rule.
target (Optional[IRuleTarget]) – The target to register for the event. Default: - No target is added to the rule. Use addTarget() to add a target.
cross_stack_scope (Optional[Construct]) – The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region). This helps dealing with cycles that often arise in these situations. Default: - none (the main scope will be used, even for cross-stack Events)
description (Optional[str]) – A description of the rule’s purpose. Default: - No description
event_pattern (Union[EventPattern, Dict[str, Any], None]) – Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. Default: - No additional filtering based on an event pattern.
rule_name (Optional[str]) – A name for the rule. Default: AWS CloudFormation generates a unique physical ID.

See:

https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

Stability:

experimental

Return type:

Rule

on_image_build_state_change(id, *, target=None, cross_stack_scope=None, description=None, event_pattern=None, rule_name=None)

(experimental) Creates an EventBridge rule for Image Builder image state change events.

Parameters:

id (str) – Unique identifier for the rule.
target (Optional[IRuleTarget]) – The target to register for the event. Default: - No target is added to the rule. Use addTarget() to add a target.
cross_stack_scope (Optional[Construct]) – The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region). This helps dealing with cycles that often arise in these situations. Default: - none (the main scope will be used, even for cross-stack Events)
description (Optional[str]) – A description of the rule’s purpose. Default: - No description
event_pattern (Union[EventPattern, Dict[str, Any], None]) – Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. Default: - No additional filtering based on an event pattern.
rule_name (Optional[str]) – A name for the rule. Default: AWS CloudFormation generates a unique physical ID.

See:

https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

Stability:

experimental

Return type:

Rule

on_image_build_succeeded(id, *, target=None, cross_stack_scope=None, description=None, event_pattern=None, rule_name=None)

(experimental) Creates an EventBridge rule for Image Builder image success events.

Parameters:

id (str) – Unique identifier for the rule.
target (Optional[IRuleTarget]) – The target to register for the event. Default: - No target is added to the rule. Use addTarget() to add a target.
cross_stack_scope (Optional[Construct]) – The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region). This helps dealing with cycles that often arise in these situations. Default: - none (the main scope will be used, even for cross-stack Events)
description (Optional[str]) – A description of the rule’s purpose. Default: - No description
event_pattern (Union[EventPattern, Dict[str, Any], None]) – Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. Default: - No additional filtering based on an event pattern.
rule_name (Optional[str]) – A name for the rule. Default: AWS CloudFormation generates a unique physical ID.

See:

https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

Stability:

experimental

Return type:

Rule

on_image_pipeline_auto_disabled(id, *, target=None, cross_stack_scope=None, description=None, event_pattern=None, rule_name=None)

(experimental) Creates an EventBridge rule for Image Builder image pipeline automatically disabled events.

Parameters:

id (str) – Unique identifier for the rule.
target (Optional[IRuleTarget]) – The target to register for the event. Default: - No target is added to the rule. Use addTarget() to add a target.
cross_stack_scope (Optional[Construct]) – The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region). This helps dealing with cycles that often arise in these situations. Default: - none (the main scope will be used, even for cross-stack Events)
description (Optional[str]) – A description of the rule’s purpose. Default: - No description
event_pattern (Union[EventPattern, Dict[str, Any], None]) – Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. Default: - No additional filtering based on an event pattern.
rule_name (Optional[str]) – A name for the rule. Default: AWS CloudFormation generates a unique physical ID.

See:

https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

Stability:

experimental

Return type:

Rule

on_wait_for_action(id, *, target=None, cross_stack_scope=None, description=None, event_pattern=None, rule_name=None)

(experimental) Creates an EventBridge rule for Image Builder wait for action events.

Parameters:

id (str) – Unique identifier for the rule.
target (Optional[IRuleTarget]) – The target to register for the event. Default: - No target is added to the rule. Use addTarget() to add a target.
cross_stack_scope (Optional[Construct]) – The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region). This helps dealing with cycles that often arise in these situations. Default: - none (the main scope will be used, even for cross-stack Events)
description (Optional[str]) – A description of the rule’s purpose. Default: - No description
event_pattern (Union[EventPattern, Dict[str, Any], None]) – Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. Default: - No additional filtering based on an event pattern.
rule_name (Optional[str]) – A name for the rule. Default: AWS CloudFormation generates a unique physical ID.

See:

https://docs.aws.amazon.com/imagebuilder/latest/userguide/integ-eventbridge.html

Stability:

experimental

Return type:

Rule

Attributes

env

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

image_pipeline_arn

(experimental) The ARN of the image pipeline.

Stability:: experimental
Attribute:: true

image_pipeline_name

(experimental) The name of the image pipeline.

Stability:: experimental
Attribute:: true

node: The tree node.

stack: The stack in which this resource is defined.