Experimental
@aws-cdk/aws-imagebuilder-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
IImagePipeline Interface
An EC2 Image Builder Image Pipeline.
Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#The environment this resource belongs to.
notes
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.
imagePipelineArnstringimage_pipeline_arnstrimagePipelineArnStringImagePipelineArnstringImagePipelineArn*string#The ARN of the image pipeline.
imagePipelineNamestringimage_pipeline_namestrimagePipelineNameStringImagePipelineNamestringImagePipelineName*string#The name of the image pipeline.
Methods
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
notes
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).
grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#Grant custom actions to the given grantee for the image pipeline.
2 parameters
Parameters
granteegranteegranteegranteeGrantee— The principal.actionsactionsactionsactionsActions— The list of actions.
grantDefaultExecutionRolePermissions(grantee: IGrantable): Grant[]def grant_default_execution_role_permissions(self, grantee: IGrantable) -> typing.List[Grant]public List<Grant> grantDefaultExecutionRolePermissions(IGrantable grantee)public Grant[] GrantDefaultExecutionRolePermissions(IGrantable grantee)func GrantDefaultExecutionRolePermissions(Grantee IGrantable) *[]Grant#Grants the default permissions for building an image to the provided execution role.
1 parameter
Parameters
granteegranteegranteegranteeGrantee— The execution role used for the image build.
grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#Grant read permissions to the given grantee for the image pipeline.
1 parameter
Parameters
granteegranteegranteegranteeGrantee— The principal.
grantStartExecution(grantee: IGrantable): Grantdef grant_start_execution(self, grantee: IGrantable) -> Grantpublic Grant grantStartExecution(IGrantable grantee)public Grant GrantStartExecution(IGrantable grantee)func GrantStartExecution(Grantee IGrantable) Grant#Grant permissions to the given grantee to start an execution of the image pipeline.
1 parameter
Parameters
granteegranteegranteegranteeGrantee— The principal.
onCVEDetected(id: string, options?: OnEventOptions): Ruledef on_cve_detected(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onCVEDetected(String id, OnEventOptions options)public Rule OnCVEDetected(string id, OnEventOptions? options = null)func OnCVEDetected(Id *string, Options OnEventOptions) Rule#Creates an EventBridge rule for Image Builder CVE detected events.
2 parameters
Parameters
ididididId— Unique identifier for the rule.optionsoptionsoptionsoptionsOptions— Configuration options for the event rule.
onEvent(id: string, options?: OnEventOptions): Ruledef on_event(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onEvent(String id, OnEventOptions options)public Rule OnEvent(string id, OnEventOptions? options = null)func OnEvent(Id *string, Options OnEventOptions) Rule#Creates an EventBridge rule for Image Builder events.
2 parameters
Parameters
ididididId— Unique identifier for the rule.optionsoptionsoptionsoptionsOptions— Configuration options for the event rule.
onImageBuildCompleted(id: string, options?: OnEventOptions): Ruledef on_image_build_completed(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onImageBuildCompleted(String id, OnEventOptions options)public Rule OnImageBuildCompleted(string id, OnEventOptions? options = null)func OnImageBuildCompleted(Id *string, Options OnEventOptions) Rule#Creates an EventBridge rule for Image Builder image build completion events.
2 parameters
Parameters
ididididId— Unique identifier for the rule.optionsoptionsoptionsoptionsOptions— Configuration options for the event rule.
onImageBuildFailed(id: string, options?: OnEventOptions): Ruledef on_image_build_failed(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onImageBuildFailed(String id, OnEventOptions options)public Rule OnImageBuildFailed(string id, OnEventOptions? options = null)func OnImageBuildFailed(Id *string, Options OnEventOptions) Rule#Creates an EventBridge rule for Image Builder image build failure events.
2 parameters
Parameters
ididididId— Unique identifier for the rule.optionsoptionsoptionsoptionsOptions— Configuration options for the event rule.
onImageBuildStateChange(id: string, options?: OnEventOptions): Ruledef on_image_build_state_change(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onImageBuildStateChange(String id, OnEventOptions options)public Rule OnImageBuildStateChange(string id, OnEventOptions? options = null)func OnImageBuildStateChange(Id *string, Options OnEventOptions) Rule#Creates an EventBridge rule for Image Builder image state change events.
2 parameters
Parameters
ididididId— Unique identifier for the rule.optionsoptionsoptionsoptionsOptions— Configuration options for the event rule.
onImageBuildSucceeded(id: string, options?: OnEventOptions): Ruledef on_image_build_succeeded(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onImageBuildSucceeded(String id, OnEventOptions options)public Rule OnImageBuildSucceeded(string id, OnEventOptions? options = null)func OnImageBuildSucceeded(Id *string, Options OnEventOptions) Rule#Creates an EventBridge rule for Image Builder image success events.
2 parameters
Parameters
ididididId— Unique identifier for the rule.optionsoptionsoptionsoptionsOptions— Configuration options for the event rule.
onImagePipelineAutoDisabled(id: string, options?: OnEventOptions): Ruledef on_image_pipeline_auto_disabled(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onImagePipelineAutoDisabled(String id, OnEventOptions options)public Rule OnImagePipelineAutoDisabled(string id, OnEventOptions? options = null)func OnImagePipelineAutoDisabled(Id *string, Options OnEventOptions) Rule#Creates an EventBridge rule for Image Builder image pipeline automatically disabled events.
2 parameters
Parameters
ididididId— Unique identifier for the rule.optionsoptionsoptionsoptionsOptions— Configuration options for the event rule.
onWaitForAction(id: string, options?: OnEventOptions): Ruledef on_wait_for_action(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onWaitForAction(String id, OnEventOptions options)public Rule OnWaitForAction(string id, OnEventOptions? options = null)func OnWaitForAction(Id *string, Options OnEventOptions) Rule#Creates an EventBridge rule for Image Builder wait for action events.
2 parameters
Parameters
ididididId— Unique identifier for the rule.optionsoptionsoptionsoptionsOptions— Configuration options for the event rule.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.
1 parameter · returns
Parameters
mixinsmixinsmixinsmixinsMixins— The mixins to apply.
Returns: This construct for chaining