Package software.amazon.awscdk.services.codepipeline

Interface CommonAwsActionProps

All Superinterfaces:

CommonActionProps, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

CloudFormationCreateReplaceChangeSetActionProps, CloudFormationCreateUpdateStackActionProps, CloudFormationDeleteStackActionProps, CloudFormationDeployStackInstancesActionProps, CloudFormationDeployStackSetActionProps, CloudFormationExecuteChangeSetActionProps, CodeBuildActionProps, CodeCommitSourceActionProps, CodeDeployEcsDeployActionProps, CodeDeployServerDeployActionProps, CodeStarConnectionsSourceActionProps, EcrSourceActionProps, EcsDeployActionProps, ElasticBeanstalkDeployActionProps, LambdaInvokeActionProps, ManualApprovalActionProps, S3DeployActionProps, S3SourceActionProps, ServiceCatalogDeployActionBeta1Props, StepFunctionsInvokeActionProps

All Known Implementing Classes:

CloudFormationCreateReplaceChangeSetActionProps.Jsii$Proxy, CloudFormationCreateUpdateStackActionProps.Jsii$Proxy, CloudFormationDeleteStackActionProps.Jsii$Proxy, CloudFormationDeployStackInstancesActionProps.Jsii$Proxy, CloudFormationDeployStackSetActionProps.Jsii$Proxy, CloudFormationExecuteChangeSetActionProps.Jsii$Proxy, CodeBuildActionProps.Jsii$Proxy, CodeCommitSourceActionProps.Jsii$Proxy, CodeDeployEcsDeployActionProps.Jsii$Proxy, CodeDeployServerDeployActionProps.Jsii$Proxy, CodeStarConnectionsSourceActionProps.Jsii$Proxy, CommonAwsActionProps.Jsii$Proxy, EcrSourceActionProps.Jsii$Proxy, EcsDeployActionProps.Jsii$Proxy, ElasticBeanstalkDeployActionProps.Jsii$Proxy, LambdaInvokeActionProps.Jsii$Proxy, ManualApprovalActionProps.Jsii$Proxy, S3DeployActionProps.Jsii$Proxy, S3SourceActionProps.Jsii$Proxy, ServiceCatalogDeployActionBeta1Props.Jsii$Proxy, StepFunctionsInvokeActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:58.882Z")
@Stability(Stable)
public interface CommonAwsActionProps
extends software.amazon.jsii.JsiiSerializable, CommonActionProps

Common properties shared by all Actions whose ActionProperties.owner field is 'AWS' (or unset, as 'AWS' is the default).

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codepipeline.*;
 import software.amazon.awscdk.services.iam.*;
 Role role;
 CommonAwsActionProps commonAwsActionProps = CommonAwsActionProps.builder()
         .actionName("actionName")
         // the properties below are optional
         .role(role)
         .runOrder(123)
         .variablesNamespace("variablesNamespace")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CommonAwsActionProps.Builder	A builder for CommonAwsActionProps
static final class	CommonAwsActionProps.Jsii$Proxy	An implementation for CommonAwsActionProps

Method Summary

Modifier and Type	Method	Description
static CommonAwsActionProps.Builder	builder()
default IRole	getRole()	The Role in which context's this Action will be executing in.

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonActionProps

getActionName, getRunOrder, getVariablesNamespace

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRole

@Stability(Stable)
@Nullable
default IRole getRole()

The Role in which context's this Action will be executing in.

The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your IAction.bind method in the ActionBindOptions.role property.

Default: a new Role will be generated

builder

@Stability(Stable)
static CommonAwsActionProps.Builder builder()

Returns:

a CommonAwsActionProps.Builder of CommonAwsActionProps