software.amazon.awscdk.services.codepipeline

Interface CommonAwsActionProps

All Superinterfaces:

CommonActionProps

All Known Subinterfaces:

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

All Known Implementing Classes:

BitBucketSourceActionProps.Jsii$Proxy, 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, LambdaInvokeActionProps.Jsii$Proxy, ManualApprovalActionProps.Jsii$Proxy, S3DeployActionProps.Jsii$Proxy, S3SourceActionProps.Jsii$Proxy, ServiceCatalogDeployActionBeta1Props.Jsii$Proxy, StepFunctionsInvokeActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.883Z")
public interface CommonAwsActionProps
extends 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 and Description
static class	CommonAwsActionProps.Builder A builder for CommonAwsActionProps
static class	CommonAwsActionProps.Jsii$Proxy An implementation for CommonAwsActionProps

Method Summary

Modifier and Type	Method and 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

Method Detail

getRole

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 {@link IAction.bind} method in the {@link ActionBindOptions.role} property.

Default: a new Role will be generated

builder

static CommonAwsActionProps.Builder builder()

Specified by:

builder in interface CommonActionProps

Returns:

a CommonAwsActionProps.Builder of CommonAwsActionProps