Resource for managing AWS User Notifications Organizations Access. This resource enables or disables organizations access for AWS User Notifications in AWS Organizations, allowing the service to access organization information.
NOTE: This resource can only be used in the management account of an AWS Organization.
NOTE: Deleting this resource will always disable organizations access for AWS User Notifications, regardless of the
enabledattribute value.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.notifications.OrganizationsAccess("example", {enabled: true});
import pulumi
import pulumi_aws as aws
example = aws.notifications.OrganizationsAccess("example", enabled=True)
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/notifications"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := notifications.NewOrganizationsAccess(ctx, "example", ¬ifications.OrganizationsAccessArgs{
Enabled: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Notifications.OrganizationsAccess("example", new()
{
Enabled = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.notifications.OrganizationsAccess;
import com.pulumi.aws.notifications.OrganizationsAccessArgs;
import java.util.List;
import java.util.ArrayList;
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 OrganizationsAccess("example", OrganizationsAccessArgs.builder()
.enabled(true)
.build());
}
}
resources:
example:
type: aws:notifications:OrganizationsAccess
properties:
enabled: true
Create OrganizationsAccess Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OrganizationsAccess(name: string, args: OrganizationsAccessArgs, opts?: CustomResourceOptions);@overload
def OrganizationsAccess(resource_name: str,
args: OrganizationsAccessArgs,
opts: Optional[ResourceOptions] = None)
@overload
def OrganizationsAccess(resource_name: str,
opts: Optional[ResourceOptions] = None,
enabled: Optional[bool] = None,
timeouts: Optional[OrganizationsAccessTimeoutsArgs] = None)func NewOrganizationsAccess(ctx *Context, name string, args OrganizationsAccessArgs, opts ...ResourceOption) (*OrganizationsAccess, error)public OrganizationsAccess(string name, OrganizationsAccessArgs args, CustomResourceOptions? opts = null)
public OrganizationsAccess(String name, OrganizationsAccessArgs args)
public OrganizationsAccess(String name, OrganizationsAccessArgs args, CustomResourceOptions options)
type: aws:notifications:OrganizationsAccess
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args OrganizationsAccessArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args OrganizationsAccessArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args OrganizationsAccessArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OrganizationsAccessArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OrganizationsAccessArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var organizationsAccessResource = new Aws.Notifications.OrganizationsAccess("organizationsAccessResource", new()
{
Enabled = false,
Timeouts = new Aws.Notifications.Inputs.OrganizationsAccessTimeoutsArgs
{
Create = "string",
Delete = "string",
Update = "string",
},
});
example, err := notifications.NewOrganizationsAccess(ctx, "organizationsAccessResource", ¬ifications.OrganizationsAccessArgs{
Enabled: pulumi.Bool(false),
Timeouts: ¬ifications.OrganizationsAccessTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
var organizationsAccessResource = new com.pulumi.aws.notifications.OrganizationsAccess("organizationsAccessResource", com.pulumi.aws.notifications.OrganizationsAccessArgs.builder()
.enabled(false)
.timeouts(OrganizationsAccessTimeoutsArgs.builder()
.create("string")
.delete("string")
.update("string")
.build())
.build());
organizations_access_resource = aws.notifications.OrganizationsAccess("organizationsAccessResource",
enabled=False,
timeouts={
"create": "string",
"delete": "string",
"update": "string",
})
const organizationsAccessResource = new aws.notifications.OrganizationsAccess("organizationsAccessResource", {
enabled: false,
timeouts: {
create: "string",
"delete": "string",
update: "string",
},
});
type: aws:notifications:OrganizationsAccess
properties:
enabled: false
timeouts:
create: string
delete: string
update: string
OrganizationsAccess Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The OrganizationsAccess resource accepts the following input properties:
- Enabled bool
- Whether to enable organizations access for AWS User Notifications in AWS Organizations. When set to
true, enables organizations access. When set tofalse, disables organizations access. - Timeouts
Organizations
Access Timeouts
- Enabled bool
- Whether to enable organizations access for AWS User Notifications in AWS Organizations. When set to
true, enables organizations access. When set tofalse, disables organizations access. - Timeouts
Organizations
Access Timeouts Args
- enabled Boolean
- Whether to enable organizations access for AWS User Notifications in AWS Organizations. When set to
true, enables organizations access. When set tofalse, disables organizations access. - timeouts
Organizations
Access Timeouts
- enabled boolean
- Whether to enable organizations access for AWS User Notifications in AWS Organizations. When set to
true, enables organizations access. When set tofalse, disables organizations access. - timeouts
Organizations
Access Timeouts
- enabled bool
- Whether to enable organizations access for AWS User Notifications in AWS Organizations. When set to
true, enables organizations access. When set tofalse, disables organizations access. - timeouts
Organizations
Access Timeouts Args
- enabled Boolean
- Whether to enable organizations access for AWS User Notifications in AWS Organizations. When set to
true, enables organizations access. When set tofalse, disables organizations access. - timeouts Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the OrganizationsAccess resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing OrganizationsAccess Resource
Get an existing OrganizationsAccess resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: OrganizationsAccessState, opts?: CustomResourceOptions): OrganizationsAccess@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
enabled: Optional[bool] = None,
timeouts: Optional[OrganizationsAccessTimeoutsArgs] = None) -> OrganizationsAccessfunc GetOrganizationsAccess(ctx *Context, name string, id IDInput, state *OrganizationsAccessState, opts ...ResourceOption) (*OrganizationsAccess, error)public static OrganizationsAccess Get(string name, Input<string> id, OrganizationsAccessState? state, CustomResourceOptions? opts = null)public static OrganizationsAccess get(String name, Output<String> id, OrganizationsAccessState state, CustomResourceOptions options)resources: _: type: aws:notifications:OrganizationsAccess get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Enabled bool
- Whether to enable organizations access for AWS User Notifications in AWS Organizations. When set to
true, enables organizations access. When set tofalse, disables organizations access. - Timeouts
Organizations
Access Timeouts
- Enabled bool
- Whether to enable organizations access for AWS User Notifications in AWS Organizations. When set to
true, enables organizations access. When set tofalse, disables organizations access. - Timeouts
Organizations
Access Timeouts Args
- enabled Boolean
- Whether to enable organizations access for AWS User Notifications in AWS Organizations. When set to
true, enables organizations access. When set tofalse, disables organizations access. - timeouts
Organizations
Access Timeouts
- enabled boolean
- Whether to enable organizations access for AWS User Notifications in AWS Organizations. When set to
true, enables organizations access. When set tofalse, disables organizations access. - timeouts
Organizations
Access Timeouts
- enabled bool
- Whether to enable organizations access for AWS User Notifications in AWS Organizations. When set to
true, enables organizations access. When set tofalse, disables organizations access. - timeouts
Organizations
Access Timeouts Args
- enabled Boolean
- Whether to enable organizations access for AWS User Notifications in AWS Organizations. When set to
true, enables organizations access. When set tofalse, disables organizations access. - timeouts Property Map
Supporting Types
OrganizationsAccessTimeouts, OrganizationsAccessTimeoutsArgs
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Import
Using pulumi import, import User Notifications Organizations Access using the AWS account ID. For example:
$ pulumi import aws:notifications/organizationsAccess:OrganizationsAccess example 123456789012
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
