software.amazon.awscdk.services.s3

Interface Location

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Location.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.815Z")
 @Stability(value=Stable)
public interface Location
extends software.amazon.jsii.JsiiSerializable

An interface that represents the location of a specific object in an S3 Bucket.

Example:

 Stack lambdaStack = new Stack(app, "LambdaStack");
 CfnParametersCode lambdaCode = Code.fromCfnParameters();
 Function.Builder.create(lambdaStack, "Lambda")
         .code(lambdaCode)
         .handler("index.handler")
         .runtime(Runtime.NODEJS_14_X)
         .build();
 // other resources that your Lambda needs, added to the lambdaStack...
 Stack pipelineStack = new Stack(app, "PipelineStack");
 Pipeline pipeline = new Pipeline(pipelineStack, "Pipeline");
 // add the source code repository containing this code to your Pipeline,
 // and the source code of the Lambda Function, if they're separate
 Artifact cdkSourceOutput = new Artifact();
 CodeCommitSourceAction cdkSourceAction = CodeCommitSourceAction.Builder.create()
         .repository(Repository.Builder.create(pipelineStack, "CdkCodeRepo")
                 .repositoryName("CdkCodeRepo")
                 .build())
         .actionName("CdkCode_Source")
         .output(cdkSourceOutput)
         .build();
 Artifact lambdaSourceOutput = new Artifact();
 CodeCommitSourceAction lambdaSourceAction = CodeCommitSourceAction.Builder.create()
         .repository(Repository.Builder.create(pipelineStack, "LambdaCodeRepo")
                 .repositoryName("LambdaCodeRepo")
                 .build())
         .actionName("LambdaCode_Source")
         .output(lambdaSourceOutput)
         .build();
 pipeline.addStage(StageOptions.builder()
         .stageName("Source")
         .actions(List.of(cdkSourceAction, lambdaSourceAction))
         .build());
 // synthesize the Lambda CDK template, using CodeBuild
 // the below values are just examples, assuming your CDK code is in TypeScript/JavaScript -
 // adjust the build environment and/or commands accordingly
 Project cdkBuildProject = Project.Builder.create(pipelineStack, "CdkBuildProject")
         .environment(BuildEnvironment.builder()
                 .buildImage(LinuxBuildImage.UBUNTU_14_04_NODEJS_10_1_0)
                 .build())
         .buildSpec(BuildSpec.fromObject(Map.of(
                 "version", "0.2",
                 "phases", Map.of(
                         "install", Map.of(
                                 "commands", "npm install"),
                         "build", Map.of(
                                 "commands", List.of("npm run build", "npm run cdk synth LambdaStack -- -o ."))),
                 "artifacts", Map.of(
                         "files", "LambdaStack.template.yaml"))))
         .build();
 Artifact cdkBuildOutput = new Artifact();
 CodeBuildAction cdkBuildAction = CodeBuildAction.Builder.create()
         .actionName("CDK_Build")
         .project(cdkBuildProject)
         .input(cdkSourceOutput)
         .outputs(List.of(cdkBuildOutput))
         .build();
 // build your Lambda code, using CodeBuild
 // again, this example assumes your Lambda is written in TypeScript/JavaScript -
 // make sure to adjust the build environment and/or commands if they don't match your specific situation
 Project lambdaBuildProject = Project.Builder.create(pipelineStack, "LambdaBuildProject")
         .environment(BuildEnvironment.builder()
                 .buildImage(LinuxBuildImage.UBUNTU_14_04_NODEJS_10_1_0)
                 .build())
         .buildSpec(BuildSpec.fromObject(Map.of(
                 "version", "0.2",
                 "phases", Map.of(
                         "install", Map.of(
                                 "commands", "npm install"),
                         "build", Map.of(
                                 "commands", "npm run build")),
                 "artifacts", Map.of(
                         "files", List.of("index.js", "node_modules/**/*")))))
         .build();
 Artifact lambdaBuildOutput = new Artifact();
 CodeBuildAction lambdaBuildAction = CodeBuildAction.Builder.create()
         .actionName("Lambda_Build")
         .project(lambdaBuildProject)
         .input(lambdaSourceOutput)
         .outputs(List.of(lambdaBuildOutput))
         .build();
 pipeline.addStage(StageOptions.builder()
         .stageName("Build")
         .actions(List.of(cdkBuildAction, lambdaBuildAction))
         .build());
 // finally, deploy your Lambda Stack
 pipeline.addStage(StageOptions.builder()
         .stageName("Deploy")
         .actions(List.of(
             CloudFormationCreateUpdateStackAction.Builder.create()
                     .actionName("Lambda_CFN_Deploy")
                     .templatePath(cdkBuildOutput.atPath("LambdaStack.template.yaml"))
                     .stackName("LambdaStackDeployedName")
                     .adminPermissions(true)
                     .parameterOverrides(lambdaCode.assign(lambdaBuildOutput.getS3Location()))
                     .extraInputs(List.of(lambdaBuildOutput))
                     .build()))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static Location.Builder	builder()
String	getBucketName() The name of the S3 Bucket the object is in.
String	getObjectKey() The path inside the Bucket where the object is located at.
default String	getObjectVersion() The S3 object version.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBucketName

@Stability(value=Stable)
 @NotNull
String getBucketName()

The name of the S3 Bucket the object is in.

getObjectKey

@Stability(value=Stable)
 @NotNull
String getObjectKey()

The path inside the Bucket where the object is located at.

getObjectVersion

@Stability(value=Stable)
 @Nullable
default String getObjectVersion()

The S3 object version.

builder

@Stability(value=Stable)
static Location.Builder builder()

Returns:

a Location.Builder of Location