AWS CDK Reference

Appearance

v2.275.0

Policy Class ​

Policy Implementation of FilterOrPolicy.

Source
aws-sns/lib/subscription.ts
Type last changed
v2.67.0 · 2 Mar 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sns as sns } from 'aws-cdk-lib';

declare const filterOrPolicy: sns.FilterOrPolicy;
const policy = new sns.Policy({
  policyDocKey: filterOrPolicy,
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sns as sns

# filter_or_policy: sns.FilterOrPolicy

policy = sns.Policy({
    "policy_doc_key": filter_or_policy
})
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.sns.*;

FilterOrPolicy filterOrPolicy;

Policy policy = new Policy(Map.of(
        "policyDocKey", filterOrPolicy));
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SNS;

FilterOrPolicy filterOrPolicy;

var policy = new Policy(new Dictionary<string, FilterOrPolicy> {
    { "policyDocKey", filterOrPolicy }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var filterOrPolicy FilterOrPolicy

policy := awscdk.Aws_sns.NewPolicy(map[string]FilterOrPolicy{
	"policyDocKey": filterOrPolicy,
})

Initializer ​

ts
new Policy(policyDoc: { [key: string]: FilterOrPolicy })
python
Policy(policy_doc: typing.Mapping[str, FilterOrPolicy])
java
new Policy(Map<String, FilterOrPolicy> policyDoc)
csharp
new Policy(IDictionary<string, FilterOrPolicy> policyDoc)
go
NewPolicy(PolicyDoc *map[string]FilterOrPolicy)

Properties ​

policyDoc{ [key: string]: FilterOrPolicy }policy_doctyping.Mapping[str, FilterOrPolicy]policyDocMap<String, FilterOrPolicy>PolicyDocIDictionary<string, FilterOrPolicy>PolicyDoc*map[string]FilterOrPolicy#
policy argument to construct.
typeFilterOrPolicyTypetypeFilterOrPolicyTypetypeFilterOrPolicyTypeTypeFilterOrPolicyTypeTypeFilterOrPolicyType#
Type used in DFS buildFilterPolicyWithMessageBody to determine json value type.

Methods ​

filter(filter: SubscriptionFilter): Filter@staticmethod def filter(filter: SubscriptionFilter) -> Filterpublic static Filter filter(SubscriptionFilter filter)public static Filter Filter(SubscriptionFilter filter)func Filter(Filter SubscriptionFilter) Filterstatic#
Filter of MessageBody.
isFilter(): booleandef is_filter(self, ) -> boolpublic Boolean isFilter()public bool IsFilter()func IsFilter() *bool#
Check if instance is `Filter` type.
isPolicy(): booleandef is_policy(self, ) -> boolpublic Boolean isPolicy()public bool IsPolicy()func IsPolicy() *bool#
Check if instance is `Policy` type.
policy(policy: { [key: string]: FilterOrPolicy }): Policy // chainable@staticmethod def policy(policy: typing.Mapping[str, FilterOrPolicy]) -> Policypublic static Policy policy(Map<String, FilterOrPolicy> policy)public static Policy Policy(IDictionary<string, FilterOrPolicy> policy)func Policy(Policy *map[string]FilterOrPolicy) Policystatic#
Policy of MessageBody.