Package software.amazon.awscdk.services.sso

Class CfnInstance

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.sso.CfnInstance
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:10.257Z") @Stability(Stable) public class CfnInstance extends CfnResource implements IInspectable, ITaggableV2
Creates an instance of IAM Identity Center for a standalone AWS account that is not managed by AWS Organizations or a member AWS account in an organization.

You can create only one instance per account and across all AWS Regions .

The CreateInstance request is rejected if the following apply:

  • The instance is created within the organization management account.
  • An instance already exists in the same account.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sso.*;
 CfnInstance cfnInstance = CfnInstance.Builder.create(this, "MyCfnInstance")
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnInstance

      protected CfnInstance(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnInstance

      protected CfnInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnInstance

      @Stability(Stable) public CfnInstance(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnInstanceProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnInstance

      @Stability(Stable) public CfnInstance(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrIdentityStoreId

      @Stability(Stable) @NotNull public String getAttrIdentityStoreId()
      The identifier of the identity store that is connected to the Identity Center instance.

    • getAttrInstanceArn

      @Stability(Stable) @NotNull public String getAttrInstanceArn()
      The ARN of the Identity Center instance under which the operation will be executed.

      For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .

    • getAttrOwnerAccountId

      @Stability(Stable) @NotNull public String getAttrOwnerAccountId()
      The AWS account ID number of the owner of the Identity Center instance.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current status of this Identity Center instance.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the Identity Center instance.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the Identity Center instance.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Specifies tags to be attached to the instance of IAM Identity Center.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Specifies tags to be attached to the instance of IAM Identity Center.