Package software.amazon.awscdk.customresources

Interface SdkCallsPolicyOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SdkCallsPolicyOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:25.121Z")
@Stability(Stable)
public interface SdkCallsPolicyOptions
extends software.amazon.jsii.JsiiSerializable

Options for the auto-generation of policies based on the configured SDK calls.

Example:

 AwsCustomResource getParameter = AwsCustomResource.Builder.create(this, "GetParameter")
         .onUpdate(AwsSdkCall.builder() // will also be called for a CREATE event
                 .service("SSM")
                 .action("GetParameter")
                 .parameters(Map.of(
                         "Name", "my-parameter",
                         "WithDecryption", true))
                 .physicalResourceId(PhysicalResourceId.of(Date.now().toString())).build())
         .policy(AwsCustomResourcePolicy.fromSdkCalls(SdkCallsPolicyOptions.builder()
                 .resources(AwsCustomResourcePolicy.ANY_RESOURCE)
                 .build()))
         .build();
 // Use the value in another construct with
 getParameter.getResponseField("Parameter.Value");
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SdkCallsPolicyOptions.Builder	builder()
List<String>	getResources()	The resources that the calls will have access to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getResources

@Stability(Stable)
@NotNull
List<String> getResources()

The resources that the calls will have access to.

It is best to use specific resource ARN's when possible. However, you can also use AwsCustomResourcePolicy.ANY_RESOURCE to allow access to all resources. For example, when onCreate is used to create a resource which you don't know the physical name of in advance.

Note that will apply to ALL SDK calls.

builder

@Stability(Stable)
static SdkCallsPolicyOptions.Builder builder()

Returns:

a SdkCallsPolicyOptions.Builder of SdkCallsPolicyOptions