OrganizationalUnitAssociation class
Resource for managing an AWS User Notifications Organizational Unit Association. This resource associates an organizational unit with a notification configuration.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as time from "@pulumi/time";
const example = aws.organizations.getOrganization({});
const exampleNotificationConfiguration = new aws.notifications.NotificationConfiguration("example", {
name: "example-notification-config",
description: "Example notification configuration",
});
const exampleOrganizationalUnit = new aws.organizations.OrganizationalUnit("example", {
name: "example-ou",
parentId: example.then(example => example.roots?.[0]?.id),
});
// Allow time for organizational unit creation to propagate
const wait = new time.index.Sleep("wait", {createDuration: "5s"}, {
dependsOn: [
exampleOrganizationalUnit,
exampleNotificationConfiguration,
],
});
const exampleOrganizationalUnitAssociation = new aws.notifications.OrganizationalUnitAssociation("example", {
organizationalUnitId: exampleOrganizationalUnit.id,
notificationConfigurationArn: exampleNotificationConfiguration.arn,
}, {
dependsOn: [wait],
});
import pulumi
import pulumi_aws as aws
import pulumi_time as time
example = aws.organizations.get_organization()
example_notification_configuration = aws.notifications.NotificationConfiguration("example",
name="example-notification-config",
description="Example notification configuration")
example_organizational_unit = aws.organizations.OrganizationalUnit("example",
name="example-ou",
parent_id=example.roots[0].id)
# Allow time for organizational unit creation to propagate
wait = time.Sleep("wait", create_duration=5s,
opts = pulumi.ResourceOptions(depends_on=[
example_organizational_unit,
example_notification_configuration,
]))
example_organizational_unit_association = aws.notifications.OrganizationalUnitAssociation("example",
organizational_unit_id=example_organizational_unit.id,
notification_configuration_arn=example_notification_configuration.arn,
opts = pulumi.ResourceOptions(depends_on=[wait]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Time = Pulumi.Time;
return await Deployment.RunAsync(() =>
{
var example = Aws.Organizations.GetOrganization.Invoke();
var exampleNotificationConfiguration = new Aws.Notifications.NotificationConfiguration("example", new()
{
Name = "example-notification-config",
Description = "Example notification configuration",
});
var exampleOrganizationalUnit = new Aws.Organizations.OrganizationalUnit("example", new()
{
Name = "example-ou",
ParentId = example.Apply(getOrganizationResult => getOrganizationResult.Roots[0]?.Id),
});
// Allow time for organizational unit creation to propagate
var wait = new Time.Sleep("wait", new()
{
CreateDuration = "5s",
}, new CustomResourceOptions
{
DependsOn =
{
exampleOrganizationalUnit,
exampleNotificationConfiguration,
},
});
var exampleOrganizationalUnitAssociation = new Aws.Notifications.OrganizationalUnitAssociation("example", new()
{
OrganizationalUnitId = exampleOrganizationalUnit.Id,
NotificationConfigurationArn = exampleNotificationConfiguration.Arn,
}, new CustomResourceOptions
{
DependsOn =
{
wait,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/notifications"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/organizations"
"github.com/pulumi/pulumi-time/sdk/go/time"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := organizations.LookupOrganization(ctx, &organizations.LookupOrganizationArgs{}, nil)
if err != nil {
return err
}
exampleNotificationConfiguration, err := notifications.NewNotificationConfiguration(ctx, "example", ¬ifications.NotificationConfigurationArgs{
Name: pulumi.String("example-notification-config"),
Description: pulumi.String("Example notification configuration"),
})
if err != nil {
return err
}
exampleOrganizationalUnit, err := organizations.NewOrganizationalUnit(ctx, "example", &organizations.OrganizationalUnitArgs{
Name: pulumi.String("example-ou"),
ParentId: pulumi.String(example.Roots[0].Id),
})
if err != nil {
return err
}
// Allow time for organizational unit creation to propagate
wait, err := time.NewSleep(ctx, "wait", &time.SleepArgs{
CreateDuration: "5s",
}, pulumi.DependsOn([]pulumi.Resource{
exampleOrganizationalUnit,
exampleNotificationConfiguration,
}))
if err != nil {
return err
}
_, err = notifications.NewOrganizationalUnitAssociation(ctx, "example", ¬ifications.OrganizationalUnitAssociationArgs{
OrganizationalUnitId: exampleOrganizationalUnit.ID().ToIDOutput().ToStringOutput(),
NotificationConfigurationArn: exampleNotificationConfiguration.Arn,
}, pulumi.DependsOn([]pulumi.Resource{
wait,
}))
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_organizations_getorganization" "example" {
}
resource "aws_notifications_notificationconfiguration" "example" {
name = "example-notification-config"
description = "Example notification configuration"
}
resource "aws_organizations_organizationalunit" "example" {
name = "example-ou"
parent_id = data.aws_organizations_getorganization.example.roots[0].id
}
# Allow time for organizational unit creation to propagate
resource "time_sleep" "wait" {
depends_on = [aws_organizations_organizationalunit.example, aws_notifications_notificationconfiguration.example]
create_duration = "5s"
}
resource "aws_notifications_organizationalunitassociation" "example" {
depends_on = [time_sleep.wait]
organizational_unit_id = aws_organizations_organizationalunit.example.id
notification_configuration_arn = aws_notifications_notificationconfiguration.example.arn
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.organizations.OrganizationsFunctions;
import com.pulumi.aws.organizations.inputs.GetOrganizationArgs;
import com.pulumi.aws.notifications.NotificationConfiguration;
import com.pulumi.aws.notifications.NotificationConfigurationArgs;
import com.pulumi.aws.organizations.OrganizationalUnit;
import com.pulumi.aws.organizations.OrganizationalUnitArgs;
import com.pulumi.time.Sleep;
import com.pulumi.time.SleepArgs;
import com.pulumi.aws.notifications.OrganizationalUnitAssociation;
import com.pulumi.aws.notifications.OrganizationalUnitAssociationArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
final var example = OrganizationsFunctions.getOrganization(GetOrganizationArgs.builder()
.build());
var exampleNotificationConfiguration = new NotificationConfiguration("exampleNotificationConfiguration", NotificationConfigurationArgs.builder()
.name("example-notification-config")
.description("Example notification configuration")
.build());
var exampleOrganizationalUnit = new OrganizationalUnit("exampleOrganizationalUnit", OrganizationalUnitArgs.builder()
.name("example-ou")
.parentId(example.roots()[0].id())
.build());
// Allow time for organizational unit creation to propagate
var wait = new Sleep("wait", SleepArgs.builder()
.createDuration("5s")
.build(), CustomResourceOptions.builder()
.dependsOn(Arrays.asList(
exampleOrganizationalUnit,
exampleNotificationConfiguration))
.build());
var exampleOrganizationalUnitAssociation = new OrganizationalUnitAssociation("exampleOrganizationalUnitAssociation", OrganizationalUnitAssociationArgs.builder()
.organizationalUnitId(exampleOrganizationalUnit.id())
.notificationConfigurationArn(exampleNotificationConfiguration.arn())
.build(), CustomResourceOptions.builder()
.dependsOn(wait)
.build());
}
}
resources:
exampleNotificationConfiguration:
type: aws:notifications:NotificationConfiguration
name: example
properties:
name: example-notification-config
description: Example notification configuration
exampleOrganizationalUnit:
type: aws:organizations:OrganizationalUnit
name: example
properties:
name: example-ou
parentId: ${example.roots[0].id}
# Allow time for organizational unit creation to propagate
wait:
type: time:Sleep
properties:
createDuration: 5s
options:
dependsOn:
- ${exampleOrganizationalUnit}
- ${exampleNotificationConfiguration}
exampleOrganizationalUnitAssociation:
type: aws:notifications:OrganizationalUnitAssociation
name: example
properties:
organizationalUnitId: ${exampleOrganizationalUnit.id}
notificationConfigurationArn: ${exampleNotificationConfiguration.arn}
options:
dependsOn:
- ${wait}
variables:
example:
fn::invoke:
function: aws:organizations:getOrganization
arguments: {}
Associate with Organization Root
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.organizations.getOrganization({});
const exampleNotificationConfiguration = new aws.notifications.NotificationConfiguration("example", {
name: "example-notification-config",
description: "Example notification configuration",
});
const exampleOrganizationalUnitAssociation = new aws.notifications.OrganizationalUnitAssociation("example", {
organizationalUnitId: example.then(example => example.roots?.[0]?.id),
notificationConfigurationArn: exampleNotificationConfiguration.arn,
});
import pulumi
import pulumi_aws as aws
example = aws.organizations.get_organization()
example_notification_configuration = aws.notifications.NotificationConfiguration("example",
name="example-notification-config",
description="Example notification configuration")
example_organizational_unit_association = aws.notifications.OrganizationalUnitAssociation("example",
organizational_unit_id=example.roots[0].id,
notification_configuration_arn=example_notification_configuration.arn)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.Organizations.GetOrganization.Invoke();
var exampleNotificationConfiguration = new Aws.Notifications.NotificationConfiguration("example", new()
{
Name = "example-notification-config",
Description = "Example notification configuration",
});
var exampleOrganizationalUnitAssociation = new Aws.Notifications.OrganizationalUnitAssociation("example", new()
{
OrganizationalUnitId = example.Apply(getOrganizationResult => getOrganizationResult.Roots[0]?.Id),
NotificationConfigurationArn = exampleNotificationConfiguration.Arn,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/notifications"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/organizations"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := organizations.LookupOrganization(ctx, &organizations.LookupOrganizationArgs{}, nil)
if err != nil {
return err
}
exampleNotificationConfiguration, err := notifications.NewNotificationConfiguration(ctx, "example", ¬ifications.NotificationConfigurationArgs{
Name: pulumi.String("example-notification-config"),
Description: pulumi.String("Example notification configuration"),
})
if err != nil {
return err
}
_, err = notifications.NewOrganizationalUnitAssociation(ctx, "example", ¬ifications.OrganizationalUnitAssociationArgs{
OrganizationalUnitId: pulumi.String(example.Roots[0].Id),
NotificationConfigurationArn: exampleNotificationConfiguration.Arn,
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_organizations_getorganization" "example" {
}
resource "aws_notifications_notificationconfiguration" "example" {
name = "example-notification-config"
description = "Example notification configuration"
}
resource "aws_notifications_organizationalunitassociation" "example" {
organizational_unit_id = data.aws_organizations_getorganization.example.roots[0].id
notification_configuration_arn = aws_notifications_notificationconfiguration.example.arn
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.organizations.OrganizationsFunctions;
import com.pulumi.aws.organizations.inputs.GetOrganizationArgs;
import com.pulumi.aws.notifications.NotificationConfiguration;
import com.pulumi.aws.notifications.NotificationConfigurationArgs;
import com.pulumi.aws.notifications.OrganizationalUnitAssociation;
import com.pulumi.aws.notifications.OrganizationalUnitAssociationArgs;
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) {
final var example = OrganizationsFunctions.getOrganization(GetOrganizationArgs.builder()
.build());
var exampleNotificationConfiguration = new NotificationConfiguration("exampleNotificationConfiguration", NotificationConfigurationArgs.builder()
.name("example-notification-config")
.description("Example notification configuration")
.build());
var exampleOrganizationalUnitAssociation = new OrganizationalUnitAssociation("exampleOrganizationalUnitAssociation", OrganizationalUnitAssociationArgs.builder()
.organizationalUnitId(example.roots()[0].id())
.notificationConfigurationArn(exampleNotificationConfiguration.arn())
.build());
}
}
resources:
exampleNotificationConfiguration:
type: aws:notifications:NotificationConfiguration
name: example
properties:
name: example-notification-config
description: Example notification configuration
exampleOrganizationalUnitAssociation:
type: aws:notifications:OrganizationalUnitAssociation
name: example
properties:
organizationalUnitId: ${example.roots[0].id}
notificationConfigurationArn: ${exampleNotificationConfiguration.arn}
variables:
example:
fn::invoke:
function: aws:organizations:getOrganization
arguments: {}
Import
Using pulumi import, import User Notifications Organizational Unit Association using the notification_configuration_arn,organizational_unit_id format. For example:
$ pulumi import aws:notifications/organizationalUnitAssociation:OrganizationalUnitAssociation example arn:aws:notifications:us-west-2:123456789012:configuration:example-notification-config,ou-1234-12345678
Constructors
- OrganizationalUnitAssociation(String name, {OrganizationalUnitAssociationArgs? args, CustomResourceOptions? options})
-
Creates a new OrganizationalUnitAssociation.
nameThe Pulumi resource name.argsArguments used to configure this OrganizationalUnitAssociation. The set of arguments for OrganizationalUnitAssociation.optionsResource options controlling this resource's behavior. - OrganizationalUnitAssociation.reference(String urn)
- Creates a typed reference to an existing OrganizationalUnitAssociation resource.
Properties
-
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
-
notificationConfigurationArn
↔ Output<
String> -
ARN of the notification configuration to associate the organizational unit with.
latefinal
-
organizationalUnitId
↔ Output<
String> -
ID of the organizational unit or ID of the root to associate with the notification configuration. Can be a root ID (e.g.,
r-1234), or an organization ID (e.g.,o-1234567890).latefinal -
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
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, {OrganizationalUnitAssociationState? state, CustomResourceOptions? options}) → OrganizationalUnitAssociation -
Gets an existing OrganizationalUnitAssociation resource's state with the given
nameandid.