Package software.amazon.awscdk.services.secretsmanager

Interface CfnResourcePolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnResourcePolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:23.550Z")
@Stability(Stable)
public interface CfnResourcePolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnResourcePolicy.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.secretsmanager.*;
 Object resourcePolicy;
 CfnResourcePolicyProps cfnResourcePolicyProps = CfnResourcePolicyProps.builder()
         .resourcePolicy(resourcePolicy)
         .secretId("secretId")
         // the properties below are optional
         .blockPublicPolicy(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-resourcepolicy.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnResourcePolicyProps.Builder	builder()
default Object	getBlockPublicPolicy()	Specifies whether to block resource-based policies that allow broad access to the secret.
Object	getResourcePolicy()	A JSON-formatted string for an AWS resource-based policy.
String	getSecretId()	The ARN or name of the secret to attach the resource-based policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getResourcePolicy

@Stability(Stable)
@NotNull
Object getResourcePolicy()

A JSON-formatted string for an AWS resource-based policy.

For example policies, see Permissions policy examples .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-resourcepolicy.html#cfn-secretsmanager-resourcepolicy-resourcepolicy

getSecretId

@Stability(Stable)
@NotNull
String getSecretId()

The ARN or name of the secret to attach the resource-based policy.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-resourcepolicy.html#cfn-secretsmanager-resourcepolicy-secretid

getBlockPublicPolicy

@Stability(Stable)
@Nullable
default Object getBlockPublicPolicy()

Specifies whether to block resource-based policies that allow broad access to the secret.

By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-resourcepolicy.html#cfn-secretsmanager-resourcepolicy-blockpublicpolicy

builder

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

Returns:

a CfnResourcePolicyProps.Builder of CfnResourcePolicyProps