Package software.amazon.awscdk.services.s3.deployment

Class DeployTimeSubstitutedFile

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.services.s3.deployment.BucketDeployment
software.amazon.awscdk.services.s3.deployment.DeployTimeSubstitutedFile
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)", date="2024-01-03T18:29:32.190Z") @Stability(Stable) public class DeployTimeSubstitutedFile extends BucketDeployment
DeployTimeSubstitutedFile is an extension of BucketDeployment that allows users to upload individual files and specify to make substitutions in the file.

Example: 

 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.lambda.*;
 Function myLambdaFunction;
 Bucket destinationBucket;
 Role role;
 DeployTimeSubstitutedFile.Builder.create(this, "MyFile")
         .source("my-file.yaml")
         .destinationBucket(destinationBucket)
         .substitutions(Map.of(
                 "variableName", myLambdaFunction.getFunctionName()))
         .role(role)
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    DeployTimeSubstitutedFile.Builder
    A fluent builder for DeployTimeSubstitutedFile.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    DeployTimeSubstitutedFile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    DeployTimeSubstitutedFile(software.amazon.jsii.JsiiObjectRef objRef)
     
     
    DeployTimeSubstitutedFile(software.constructs.Construct scope, String id, DeployTimeSubstitutedFileProps props)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    IBucket
    getBucket()
     
    String
    getObjectKey()
     

    Methods inherited from class software.amazon.awscdk.services.s3.deployment.BucketDeployment

    addSource, getDeployedBucket, getObjectKeys

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, toString

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • DeployTimeSubstitutedFile

      protected DeployTimeSubstitutedFile(software.amazon.jsii.JsiiObjectRef objRef)

    • DeployTimeSubstitutedFile

      protected DeployTimeSubstitutedFile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • DeployTimeSubstitutedFile

      @Stability(Stable) public DeployTimeSubstitutedFile(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull DeployTimeSubstitutedFileProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • getBucket

      @Stability(Stable) @NotNull public IBucket getBucket()

    • getObjectKey

      @Stability(Stable) @NotNull public String getObjectKey()