Add ability to specify resource options at the stack level #245

corymhall · 2024-11-22T17:52:22Z

It has been possible to specify Pulumi resource options at the stack level, but it did not flow through to the actual resources. This PR makes sure that the inheritance works correctly.

This PR also adds functionality to automatically set the Stack environment based on the App provider. Because the App creates the stacks in an async context, we can use provider functions to lookup the environment and then pass the resolved environment to the stack.

For now this is something that the user will have to specify (example in the lookups example test). This would mean that all Stacks have their environment provided by default. This will cut down on the number of Intrinsics used in the generated template. The reason I am not turning this on by default is because it requires lookups to be enabled (environment agnostic stacks use Intrinsics to find availability zones, but explicit environment stacks use lookups).

If the user provides a provider to the Stack we are no longer in an async context which means we can't determine the environment from the provider and fall back to an environment agnostic stack.

re #61, re #219

corymhall · 2024-11-22T17:54:45Z

src/stack.ts

+                }
+
+                if (nativeAccount !== awsAccount) {
+                    warn(


Using a warning instead of throwing an error because it's possible this could still be correct.

corymhall · 2024-11-22T17:55:19Z

src/converters/artifact-converter.ts

-     * @param s - The string that contains the placeholders to replace
-     * @returns The string with the placeholders fully resolved
-     */
-    protected resolvePlaceholders(s: string): Promise<string> {


This was left over from before and it doesn't look like it is used anywhere anymore.

corymhall · 2024-11-22T17:56:07Z

src/converters/app-converter.ts

@@ -564,15 +567,15 @@ export class StackConverter extends ArtifactConverter implements intrinsics.Intr

        switch (target) {
            case 'AWS::AccountId':
-                return getAccountId({ parent: this.app.component }).then((r) => r.accountId);
+                return getAccountId({ parent: this.stackResource }).then((r) => r.accountId);


The parent should be the stack so that we use the provider associated with the stack.

It has been possible to specify Pulumi resource options at the stack level, but it did not flow through to the actual resources. This PR makes sure that the inheritance works correctly. This PR also adds functionality to automatically set the Stack environment based on the App provider. Because the App creates the stacks in an async context, we can use provider functions to lookup the environment and then pass the resolved environment to the stack. This means that all Stacks have their environment provided by default. This will cut down on the number of Intrinsics used in the generated template. If the user provides a provider to the Stack we are no longer in an async context which means we can't determine the environment from the provider and fall back to an environment agnostic stack. re #61, re #219

corymhall · 2024-11-22T20:45:07Z

This change is part of the following stack:

Add ability to specify resource options at the stack level #245 ◀
- chore: add example of looking up availability zones #248

_{Change managed by git-spice.}

t0yv0 · 2024-11-22T21:48:48Z

README.md

+useful in cases where you need to deploy resources to different AWS regions.
+
+```ts
+const awsProvider = new aws.Provider('aws-provider');


examples are better with imports I think, if not too hard. To see where aws is coming from.

t0yv0 · 2024-11-22T21:50:37Z

README.md

+One thing to note is that when you pass different custom providers to a Stack,
+by default the Stack becomes an [environment agnostic stack](https://docs.aws.amazon.com/cdk/v2/guide/configure-env.html#configure-env-examples).
+If you want to have the environment specified at the CDK Stack level, then you
+also need to provide the environment to the Stack Props.


Stack Props, as follows:

t0yv0 · 2024-11-22T21:51:29Z

README.md

+    const east2Stack = new pulumicdk.Stack('east2-stack', {
+        props: {
+            env: {
+                region: 'us-east-2',


I think I understand now the comment you had regarding not being able to pass a pulumi.Output region in here automatically.

I was looking at IResolvable but it's unclear that that's allowed to return promises to CDK.

t0yv0 · 2024-11-22T21:57:11Z

src/stack.ts

@@ -150,6 +179,17 @@ export class App
        this.appOptions = props.args;
        const lookupsEnabled = process.env.PULUMI_CDK_EXPERIMENTAL_LOOKUPS === 'true';
        const lookups = lookupsEnabled && pulumi.runtime.isDryRun();
+        const account = await native


Micro-optimization: you can do these in parallel.

t0yv0 · 2024-11-22T21:57:35Z

src/stack.ts

@@ -230,6 +295,8 @@ export interface StackOptions extends pulumi.ComponentResourceOptions {
    props?: cdk.StackProps;
 }

+type Writeable<T> = { -readonly [P in keyof T]: T[P] };


Still used? Linter says unused.

t0yv0 · 2024-11-22T21:58:25Z

src/stack.ts

@@ -336,6 +477,22 @@ function generateAppId(): string {
        .slice(-17);
 }

+function hasProvider(


Linter thinks unused.

t0yv0

Seems like a useful feature, thank you!

corymhall commented Nov 22, 2024

View reviewed changes

corymhall requested review from flostadler and t0yv0 November 22, 2024 19:32

corymhall added 2 commits November 22, 2024 15:12

updates

4d93a76

corymhall force-pushed the corymhall/stack-provider branch from 145ba8e to 4d93a76 Compare November 22, 2024 20:45

corymhall mentioned this pull request Nov 22, 2024

chore: add example of looking up availability zones #248

Open

t0yv0 reviewed Nov 22, 2024

View reviewed changes

src/stack.ts

@@ -336,6 +477,22 @@ function generateAppId(): string {

.slice(-17);

}

function hasProvider(

Copy link

Member

t0yv0 Nov 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Linter thinks unused.

t0yv0 approved these changes Nov 22, 2024

View reviewed changes

mjeffryes assigned corymhall Nov 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ability to specify resource options at the stack level #245

Add ability to specify resource options at the stack level #245

corymhall commented Nov 22, 2024 •

edited

Loading

corymhall Nov 22, 2024

corymhall Nov 22, 2024

corymhall Nov 22, 2024

corymhall commented Nov 22, 2024

t0yv0 Nov 22, 2024

t0yv0 Nov 22, 2024

t0yv0 Nov 22, 2024

t0yv0 Nov 22, 2024

t0yv0 Nov 22, 2024

t0yv0 Nov 22, 2024

t0yv0 Nov 22, 2024

t0yv0 left a comment

Add ability to specify resource options at the stack level #245

Are you sure you want to change the base?

Add ability to specify resource options at the stack level #245

Conversation

corymhall commented Nov 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

corymhall commented Nov 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

t0yv0 left a comment

Choose a reason for hiding this comment

corymhall commented Nov 22, 2024 •

edited

Loading