1. Packages
  2. AWS Classic
  3. API Docs
  4. servicecatalog
  5. OrganizationsAccess

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi

aws.servicecatalog.OrganizationsAccess

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi

    Manages Service Catalog AWS Organizations Access, a portfolio sharing feature through AWS Organizations. This allows Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This resource will prompt AWS to set organizations:EnableAWSServiceAccess on your behalf so that your shares can be in sync with any changes in your AWS Organizations structure.

    NOTE: This resource can only be used by the management account in the organization. In other words, a delegated administrator is not authorized to use the resource.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.servicecatalog.OrganizationsAccess("example", {enabled: true});
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.servicecatalog.OrganizationsAccess("example", enabled=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/servicecatalog"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := servicecatalog.NewOrganizationsAccess(ctx, "example", &servicecatalog.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.ServiceCatalog.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.servicecatalog.OrganizationsAccess;
    import com.pulumi.aws.servicecatalog.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:servicecatalog: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)
    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:servicecatalog: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.ServiceCatalog.OrganizationsAccess("organizationsAccessResource", new()
    {
        Enabled = false,
    });
    
    example, err := servicecatalog.NewOrganizationsAccess(ctx, "organizationsAccessResource", &servicecatalog.OrganizationsAccessArgs{
    	Enabled: pulumi.Bool(false),
    })
    
    var organizationsAccessResource = new OrganizationsAccess("organizationsAccessResource", OrganizationsAccessArgs.builder()
        .enabled(false)
        .build());
    
    organizations_access_resource = aws.servicecatalog.OrganizationsAccess("organizationsAccessResource", enabled=False)
    
    const organizationsAccessResource = new aws.servicecatalog.OrganizationsAccess("organizationsAccessResource", {enabled: false});
    
    type: aws:servicecatalog:OrganizationsAccess
    properties:
        enabled: false
    

    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

    The OrganizationsAccess resource accepts the following input properties:

    Enabled bool
    Whether to enable AWS Organizations access.
    Enabled bool
    Whether to enable AWS Organizations access.
    enabled Boolean
    Whether to enable AWS Organizations access.
    enabled boolean
    Whether to enable AWS Organizations access.
    enabled bool
    Whether to enable AWS Organizations access.
    enabled Boolean
    Whether to enable AWS Organizations access.

    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) -> OrganizationsAccess
    func 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)
    Resource lookup is not supported in YAML
    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.
    The following state arguments are supported:
    Enabled bool
    Whether to enable AWS Organizations access.
    Enabled bool
    Whether to enable AWS Organizations access.
    enabled Boolean
    Whether to enable AWS Organizations access.
    enabled boolean
    Whether to enable AWS Organizations access.
    enabled bool
    Whether to enable AWS Organizations access.
    enabled Boolean
    Whether to enable AWS Organizations access.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi