SinkPolicy class
Resource for managing an AWS CloudWatch Observability Access Manager Sink Policy.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.oam.Sink("example", {name: "ExampleSink"});
const exampleSinkPolicy = new aws.oam.SinkPolicy("example", {
sinkIdentifier: example.arn,
policy: JSON.stringify({
Version: "2012-10-17",
Statement: [{
Action: [
"oam:CreateLink",
"oam:UpdateLink",
],
Effect: "Allow",
Resource: "*",
Principal: {
AWS: [
"1111111111111",
"222222222222",
],
},
Condition: {
"ForAllValues:StringEquals": {
"oam:ResourceTypes": [
"AWS::CloudWatch::Metric",
"AWS::Logs::LogGroup",
],
},
},
}],
}),
});
import pulumi
import json
import pulumi_aws as aws
example = aws.oam.Sink("example", name="ExampleSink")
example_sink_policy = aws.oam.SinkPolicy("example",
sink_identifier=example.arn,
policy=json.dumps({
"Version": "2012-10-17",
"Statement": [{
"Action": [
"oam:CreateLink",
"oam:UpdateLink",
],
"Effect": "Allow",
"Resource": "*",
"Principal": {
"AWS": [
"1111111111111",
"222222222222",
],
},
"Condition": {
"ForAllValues:StringEquals": {
"oam:ResourceTypes": [
"AWS::CloudWatch::Metric",
"AWS::Logs::LogGroup",
],
},
},
}],
}))
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Oam.Sink("example", new()
{
Name = "ExampleSink",
});
var exampleSinkPolicy = new Aws.Oam.SinkPolicy("example", new()
{
SinkIdentifier = example.Arn,
Policy = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["Version"] = "2012-10-17",
["Statement"] = new[]
{
new Dictionary<string, object?>
{
["Action"] = new[]
{
"oam:CreateLink",
"oam:UpdateLink",
},
["Effect"] = "Allow",
["Resource"] = "*",
["Principal"] = new Dictionary<string, object?>
{
["AWS"] = new[]
{
"1111111111111",
"222222222222",
},
},
["Condition"] = new Dictionary<string, object?>
{
["ForAllValues:StringEquals"] = new Dictionary<string, object?>
{
["oam:ResourceTypes"] = new[]
{
"AWS::CloudWatch::Metric",
"AWS::Logs::LogGroup",
},
},
},
},
},
}),
});
});
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/oam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := oam.NewSink(ctx, "example", &oam.SinkArgs{
Name: pulumi.String("ExampleSink"),
})
if err != nil {
return err
}
tmpJSON0, err := json.Marshal(map[string]interface{}{
"Version": "2012-10-17",
"Statement": []map[string]interface{}{
map[string]interface{}{
"Action": []string{
"oam:CreateLink",
"oam:UpdateLink",
},
"Effect": "Allow",
"Resource": "*",
"Principal": map[string][]string{
"AWS": []string{
"1111111111111",
"222222222222",
},
},
"Condition": map[string]map[string][]string{
"ForAllValues:StringEquals": map[string][]string{
"oam:ResourceTypes": []string{
"AWS::CloudWatch::Metric",
"AWS::Logs::LogGroup",
},
},
},
},
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = oam.NewSinkPolicy(ctx, "example", &oam.SinkPolicyArgs{
SinkIdentifier: example.Arn,
Policy: pulumi.String(json0),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_oam_sink" "example" {
name = "ExampleSink"
}
resource "aws_oam_sinkpolicy" "example" {
sink_identifier = aws_oam_sink.example.arn
policy = jsonencode({
"Version" = "2012-10-17"
"Statement" = [{
"Action" = ["oam:CreateLink", "oam:UpdateLink"]
"Effect" = "Allow"
"Resource" = "*"
"Principal" = {
"AWS" = ["1111111111111", "222222222222"]
}
"Condition" = {
"ForAllValues:StringEquals" = {
"oam:ResourceTypes" = ["AWS::CloudWatch::Metric", "AWS::Logs::LogGroup"]
}
}
}]
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.oam.Sink;
import com.pulumi.aws.oam.SinkArgs;
import com.pulumi.aws.oam.SinkPolicy;
import com.pulumi.aws.oam.SinkPolicyArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Sink("example", SinkArgs.builder()
.name("ExampleSink")
.build());
var exampleSinkPolicy = new SinkPolicy("exampleSinkPolicy", SinkPolicyArgs.builder()
.sinkIdentifier(example.arn())
.policy(serializeJson(
jsonObject(
jsonProperty("Version", "2012-10-17"),
jsonProperty("Statement", jsonArray(jsonObject(
jsonProperty("Action", jsonArray(
"oam:CreateLink",
"oam:UpdateLink"
)),
jsonProperty("Effect", "Allow"),
jsonProperty("Resource", "*"),
jsonProperty("Principal", jsonObject(
jsonProperty("AWS", jsonArray(
"1111111111111",
"222222222222"
))
)),
jsonProperty("Condition", jsonObject(
jsonProperty("ForAllValues:StringEquals", jsonObject(
jsonProperty("oam:ResourceTypes", jsonArray(
"AWS::CloudWatch::Metric",
"AWS::Logs::LogGroup"
))
))
))
)))
)))
.build());
}
}
resources:
example:
type: aws:oam:Sink
properties:
name: ExampleSink
exampleSinkPolicy:
type: aws:oam:SinkPolicy
name: example
properties:
sinkIdentifier: ${example.arn}
policy:
fn::toJSON:
Version: 2012-10-17
Statement:
- Action:
- oam:CreateLink
- oam:UpdateLink
Effect: Allow
Resource: '*'
Principal:
AWS:
- '1111111111111'
- '222222222222'
Condition:
ForAllValues:StringEquals:
oam:ResourceTypes:
- AWS::CloudWatch::Metric
- AWS::Logs::LogGroup
Import
Using pulumi import, import CloudWatch Observability Access Manager Sink Policy using the sinkIdentifier. For example:
$ pulumi import aws:oam/sinkPolicy:SinkPolicy example arn:aws:oam:us-west-2:123456789012:sink/sink-id
Constructors
- SinkPolicy(String name, {SinkPolicyArgs? args, CustomResourceOptions? options})
-
Creates a new SinkPolicy.
nameThe Pulumi resource name.argsArguments used to configure this SinkPolicy. The set of arguments for SinkPolicy.optionsResource options controlling this resource's behavior. - SinkPolicy.reference(String urn)
- Creates a typed reference to an existing SinkPolicy resource.
Properties
-
arn
↔ Output<
String> -
ARN of the Sink.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
policy
↔ Output<
String> -
JSON policy to use. If you are updating an existing policy, the entire existing policy is replaced by what you specify here.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sinkId
↔ Output<
String> -
ID string that AWS generated as part of the sink ARN.
latefinal
-
sinkIdentifier
↔ Output<
String> -
ARN of the sink to attach this policy to.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {SinkPolicyState? state, CustomResourceOptions? options}) → SinkPolicy -
Gets an existing SinkPolicy resource's state with the given
nameandid.