Skip to content

Commit f9a894f

Browse files
authored
feat: factory methods for Grants made public (#36123)
The `<Resource>Grants._from<Resource>()` methods were marked as internal while we experimented with the interface. Make them public. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 07c4a0d commit f9a894f

File tree

22 files changed

+25
-30
lines changed

22 files changed

+25
-30
lines changed

packages/aws-cdk-lib/aws-apigateway/lib/api-key.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ abstract class ApiKeyBase extends Resource implements IApiKey {
104104
/**
105105
* Collection of grant methods for an ApiKey
106106
*/
107-
public readonly grants = ApiKeyGrants._fromApiKey(this);
107+
public readonly grants = ApiKeyGrants.fromApiKey(this);
108108

109109
/**
110110
* Permits the IAM principal all read operations through this key

packages/aws-cdk-lib/aws-appmesh/lib/virtual-gateway.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ abstract class VirtualGatewayBase extends cdk.Resource implements IVirtualGatewa
107107
/**
108108
* Collection of grant methods for a VirtualGateway
109109
*/
110-
public readonly grants: VirtualGatewayGrants = VirtualGatewayGrants._fromVirtualGateway(this);
110+
public readonly grants: VirtualGatewayGrants = VirtualGatewayGrants.fromVirtualGateway(this);
111111

112112
public get virtualGatewayRef(): VirtualGatewayReference {
113113
return {

packages/aws-cdk-lib/aws-appmesh/test/virtual-gateway.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -968,7 +968,7 @@ describe('virtual gateway', () => {
968968

969969
// WHEN
970970
const user = new iam.User(stack, 'test');
971-
VirtualGatewayGrants._fromVirtualGateway(gateway).streamAggregatedResources(user);
971+
VirtualGatewayGrants.fromVirtualGateway(gateway).streamAggregatedResources(user);
972972

973973
// THEN
974974
Template.fromStack(stack).hasResourceProperties('AWS::IAM::Policy', {

packages/aws-cdk-lib/aws-cloudfront/lib/distribution.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,7 @@ export class Distribution extends Resource implements IDistribution {
333333
return grant(this, grantee, ...actions);
334334
}
335335
public grantCreateInvalidation(grantee: iam.IGrantable): iam.Grant {
336-
return DistributionGrants._fromDistribution(this).createInvalidation(grantee);
336+
return DistributionGrants.fromDistribution(this).createInvalidation(grantee);
337337
}
338338
}();
339339
}
@@ -346,7 +346,7 @@ export class Distribution extends Resource implements IDistribution {
346346
/**
347347
* Collection of grant methods for a Distribution
348348
*/
349-
public readonly grants = DistributionGrants._fromDistribution(this);
349+
public readonly grants = DistributionGrants.fromDistribution(this);
350350

351351
private readonly httpVersion: HttpVersion;
352352
private readonly defaultBehavior: CacheBehavior;

packages/aws-cdk-lib/aws-cloudfront/lib/web-distribution.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -788,15 +788,15 @@ export class CloudFrontWebDistribution extends cdk.Resource implements IDistribu
788788
return iam.Grant.addToPrincipal({ grantee, actions, resourceArns: [formatDistributionArn(this)] });
789789
}
790790
public grantCreateInvalidation(identity: iam.IGrantable): iam.Grant {
791-
return DistributionGrants._fromDistribution(this).createInvalidation(identity);
791+
return DistributionGrants.fromDistribution(this).createInvalidation(identity);
792792
}
793793
}();
794794
}
795795

796796
/**
797797
* Collection of grant methods for a Distribution
798798
*/
799-
public readonly grants = DistributionGrants._fromDistribution(this);
799+
public readonly grants = DistributionGrants.fromDistribution(this);
800800

801801
/**
802802
* The logging bucket for this CloudFront distribution.

packages/aws-cdk-lib/aws-cloudfront/test/distribution.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1283,7 +1283,7 @@ test('grants createInvalidation to L1', () => {
12831283
});
12841284

12851285
DistributionGrants.
1286-
_fromDistribution(distribution.node.defaultChild as CfnDistribution)
1286+
fromDistribution(distribution.node.defaultChild as CfnDistribution)
12871287
.createInvalidation(role);
12881288

12891289
Template.fromStack(stack).hasResourceProperties('AWS::IAM::Policy', {

packages/aws-cdk-lib/aws-codecommit/lib/repository.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ abstract class RepositoryBase extends Resource implements IRepository {
257257
/**
258258
* Collection of grant methods for a Repository
259259
*/
260-
public readonly grants = RepositoryGrants._fromRepository(this);
260+
public readonly grants = RepositoryGrants.fromRepository(this);
261261

262262
public get repositoryRef(): RepositoryReference {
263263
return {

packages/aws-cdk-lib/aws-codeguruprofiler/lib/profiling-group.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ abstract class ProfilingGroupBase extends Resource implements IProfilingGroup {
7575
/**
7676
* Collection of grant methods for a ProfilingGroup
7777
*/
78-
public readonly grants = ProfilingGroupGrants._fromProfilingGroup(this);
78+
public readonly grants = ProfilingGroupGrants.fromProfilingGroup(this);
7979

8080
public get profilingGroupRef(): ProfilingGroupReference {
8181
return {

packages/aws-cdk-lib/aws-ecs/lib/cluster.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ export class Cluster extends Resource implements ICluster {
239239
/**
240240
* Collection of grant methods for a Cluster
241241
*/
242-
public readonly grants = ClusterGrants._fromCluster(this);
242+
public readonly grants = ClusterGrants.fromCluster(this);
243243

244244
/**
245245
* The names of both ASG and Fargate capacity providers associated with the cluster.

packages/aws-cdk-lib/aws-elasticsearch/lib/domain.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -957,7 +957,7 @@ abstract class DomainBase extends cdk.Resource implements IDomain {
957957
/**
958958
* Collection of grant methods for a Domain
959959
*/
960-
public readonly grants = DomainGrants._fromDomain(this);
960+
public readonly grants = DomainGrants.fromDomain(this);
961961

962962
public get domainRef(): DomainReference {
963963
return {

0 commit comments

Comments
 (0)