ElasticBeanstalkDeployActionProps

class aws_cdk.aws_codepipeline_actions.ElasticBeanstalkDeployActionProps(*, action_name, run_order=None, variables_namespace=None, role=None, application_name, environment_name, input)

Bases: CommonAwsActionProps

Construction properties of the ElasticBeanstalkDeployAction Elastic Beanstalk deploy CodePipeline Action.

Parameters:

  • action_name (str) – The physical, human-readable name of the Action. Note that Action names must be unique within a single Stage.

  • run_order (Union[int, float, None]) – The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute. Default: 1

  • variables_namespace (Optional[str]) – The name of the namespace to use for variables emitted by this action. Default: - a name will be generated, based on the stage and action names, if any of the action’s variables were referenced - otherwise, no namespace will be set

  • role (Optional[IRole]) – 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

  • application_name (str) – The name of the AWS Elastic Beanstalk application to deploy.

  • environment_name (str) – The name of the AWS Elastic Beanstalk environment to deploy to.

  • input (Artifact) – The source to use as input for deployment.

ExampleMetadata:

infused

Example:

source_output = codepipeline.Artifact()
target_bucket = s3.Bucket(self, "MyBucket")

pipeline = codepipeline.Pipeline(self, "MyPipeline")
deploy_action = codepipeline_actions.ElasticBeanstalkDeployAction(
    action_name="ElasticBeanstalkDeploy",
    input=source_output,
    environment_name="envName",
    application_name="appName"
)

deploy_stage = pipeline.add_stage(
    stage_name="Deploy",
    actions=[deploy_action]
)

Attributes

action_name

The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

application_name

The name of the AWS Elastic Beanstalk application to deploy.

environment_name

The name of the AWS Elastic Beanstalk environment to deploy to.

input

The source to use as input for deployment.

role

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

run_order

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Default:

1

See:

https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html

variables_namespace

The name of the namespace to use for variables emitted by this action.

Default:

  • a name will be generated, based on the stage and action names,

if any of the action’s variables were referenced - otherwise, no namespace will be set