com.pepperize.cdk.organizations.Root Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdk-organizations Show documentation
Manage AWS organizations, organizational units (OU), accounts and service control policies (SCP).
There is a newer version: 0.7.969
package com.pepperize.cdk.organizations;

/**
 * The parent container for all the accounts for your organization.
 * 
 * If you apply a policy to the root, it applies to all organizational units (OUs) and accounts in the organization.
 * Currently, you can have only one root. AWS Organizations automatically creates it for you when you create an organization.
 * 

 * @see https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.98.0 (build 00b106d)", date = "2024-05-17T01:18:02.676Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Jsii(module = com.pepperize.cdk.organizations.$Module.class, fqn = "@pepperize/cdk-organizations.Root")
public class Root extends software.constructs.Construct implements com.pepperize.cdk.organizations.IParent, com.pepperize.cdk.organizations.IPolicyAttachmentTarget, com.pepperize.cdk.organizations.ITaggableResource {

    protected Root(final software.amazon.jsii.JsiiObjectRef objRef) {
        super(objRef);
    }

    protected Root(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
        super(initializationMode);
    }

    /**
     * @param scope This parameter is required.
     * @param id This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public Root(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id) {
        super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
        software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required") });
    }

    /**
     * Attach a policy.
     * 

     * Before you can attach the policy, you must enable that policy type for use. You can use policies when you have all features enabled.
     * 

     * @see https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html
     * @param policy This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public void attachPolicy(final @org.jetbrains.annotations.NotNull com.pepperize.cdk.organizations.IPolicy policy) {
        software.amazon.jsii.Kernel.call(this, "attachPolicy", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(policy, "policy is required") });
    }

    /**
     * Enables and disables Enables a policy type.
     * 

     * After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or account in that root.
     * 

     * @see https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_enable-disable.html
     * @param policyType This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public void enablePolicyType(final @org.jetbrains.annotations.NotNull com.pepperize.cdk.organizations.PolicyType policyType) {
        software.amazon.jsii.Kernel.call(this, "enablePolicyType", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(policyType, "policyType is required") });
    }

    /**
     * The unique identifier (ID) of the parent root, organizational unit (OU), account, or policy that you want to create the new OU in.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    @Override
    public @org.jetbrains.annotations.NotNull java.lang.String identifier() {
        return software.amazon.jsii.Kernel.call(this, "identifier", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    protected @org.jetbrains.annotations.NotNull software.amazon.awscdk.customresources.AwsCustomResource getResource() {
        return software.amazon.jsii.Kernel.get(this, "resource", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.customresources.AwsCustomResource.class));
    }

    /**
     * The unique identifier (ID) for the root.
     * 
     * The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.NotNull java.lang.String getRootId() {
        return software.amazon.jsii.Kernel.get(this, "rootId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     * TagManager to set, remove and format tags.
     */
    @Override
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.NotNull software.amazon.awscdk.TagManager getTags() {
        return software.amazon.jsii.Kernel.get(this, "tags", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.TagManager.class));
    }
}