EventPermission class
Provides a resource to create an EventBridge permission to support cross-account events in the current account default event bus.
> Note: EventBridge was formerly known as CloudWatch Events. The functionality is identical.
> Note: The EventBridge bus policy resource (aws.cloudwatch.EventBusPolicy) is incompatible with the EventBridge permission resource (aws.cloudwatch.EventPermission) and will overwrite permissions.
Example Usage
Account Access
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const devAccountAccess = new aws.cloudwatch.EventPermission("DevAccountAccess", {
principal: "123456789012",
statementId: "DevAccountAccess",
});
import pulumi
import pulumi_aws as aws
dev_account_access = aws.cloudwatch.EventPermission("DevAccountAccess",
principal="123456789012",
statement_id="DevAccountAccess")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var devAccountAccess = new Aws.CloudWatch.EventPermission("DevAccountAccess", new()
{
Principal = "123456789012",
StatementId = "DevAccountAccess",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudwatch"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudwatch.NewEventPermission(ctx, "DevAccountAccess", &cloudwatch.EventPermissionArgs{
Principal: pulumi.String("123456789012"),
StatementId: pulumi.String("DevAccountAccess"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_cloudwatch_eventpermission" "DevAccountAccess" {
principal = "123456789012"
statement_id = "DevAccountAccess"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.EventPermission;
import com.pulumi.aws.cloudwatch.EventPermissionArgs;
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 devAccountAccess = new EventPermission("devAccountAccess", EventPermissionArgs.builder()
.principal("123456789012")
.statementId("DevAccountAccess")
.build());
}
}
resources:
devAccountAccess:
type: aws:cloudwatch:EventPermission
name: DevAccountAccess
properties:
principal: '123456789012'
statementId: DevAccountAccess
Organization Access
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const organizationAccess = new aws.cloudwatch.EventPermission("OrganizationAccess", {
condition: {
key: "aws:PrincipalOrgID",
type: "StringEquals",
value: example.id,
},
principal: "*",
statementId: "OrganizationAccess",
});
import pulumi
import pulumi_aws as aws
organization_access = aws.cloudwatch.EventPermission("OrganizationAccess",
condition={
"key": "aws:PrincipalOrgID",
"type": "StringEquals",
"value": example["id"],
},
principal="*",
statement_id="OrganizationAccess")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var organizationAccess = new Aws.CloudWatch.EventPermission("OrganizationAccess", new()
{
Condition = new Aws.CloudWatch.Inputs.EventPermissionConditionArgs
{
Key = "aws:PrincipalOrgID",
Type = "StringEquals",
Value = example.Id,
},
Principal = "*",
StatementId = "OrganizationAccess",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudwatch"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudwatch.NewEventPermission(ctx, "OrganizationAccess", &cloudwatch.EventPermissionArgs{
Condition: &cloudwatch.EventPermissionConditionArgs{
Key: pulumi.String("aws:PrincipalOrgID"),
Type: pulumi.String("StringEquals"),
Value: pulumi.Any(example.Id),
},
Principal: pulumi.String("*"),
StatementId: pulumi.String("OrganizationAccess"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_cloudwatch_eventpermission" "OrganizationAccess" {
condition = {
key = "aws:PrincipalOrgID"
type = "StringEquals"
value = example.id
}
principal = "*"
statement_id = "OrganizationAccess"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.EventPermission;
import com.pulumi.aws.cloudwatch.EventPermissionArgs;
import com.pulumi.aws.cloudwatch.inputs.EventPermissionConditionArgs;
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 organizationAccess = new EventPermission("organizationAccess", EventPermissionArgs.builder()
.condition(EventPermissionConditionArgs.builder()
.key("aws:PrincipalOrgID")
.type("StringEquals")
.value(example.id())
.build())
.principal("*")
.statementId("OrganizationAccess")
.build());
}
}
resources:
organizationAccess:
type: aws:cloudwatch:EventPermission
name: OrganizationAccess
properties:
condition:
key: aws:PrincipalOrgID
type: StringEquals
value: ${example.id}
principal: '*'
statementId: OrganizationAccess
Import
Identity Schema
Required
statementId(String) Statement ID of the EventBridge permission.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import Permissions eventBusName and statementId separated by a forward slash (/) (if you omit eventBusName, the default event bus will be used). For example:
$ pulumi import aws:cloudwatch/eventPermission:EventPermission example example-event-bus/DevAccountAccess
Constructors
- EventPermission(String name, {EventPermissionArgs? args, CustomResourceOptions? options})
-
Creates a new EventPermission.
nameThe Pulumi resource name.argsArguments used to configure this EventPermission. The set of arguments for EventPermission.optionsResource options controlling this resource's behavior. - EventPermission.reference(String urn)
- Creates a typed reference to an existing EventPermission resource.
Properties
-
action
↔ Output<
String?> -
The action that you are enabling the other account to perform. Defaults to
events:PutEvents.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
condition
↔ Output<
EventPermissionCondition?> -
Configuration block to limit the event bus permissions you are granting to only accounts that fulfill the condition. Specified below.
latefinal
-
eventBusName
↔ Output<
String?> -
The name of the event bus to set the permissions on.
If you omit this, the permissions are set on the
defaultevent bus.latefinal - 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
-
principal
↔ Output<
String> -
The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify
*to permit any account to put events to your default event bus, optionally limited bycondition.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
-
statementId
↔ Output<
String> -
An identifier string for the external account that you are granting permissions 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, {EventPermissionState? state, CustomResourceOptions? options}) → EventPermission -
Gets an existing EventPermission resource's state with the given
nameandid.