Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. connect
  5. Instance

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.connect.Instance

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Connect::Instance

    Create Instance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
    @overload
def Instance(resource_name: str,
             args: InstanceArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             attributes: Optional[InstanceAttributesArgs] = None,
             identity_management_type: Optional[InstanceIdentityManagementType] = None,
             directory_id: Optional[str] = None,
             instance_alias: Optional[str] = None,
             tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

    type: aws-native:connect:Instance
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 InstanceArgs
    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 InstanceArgs
    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 InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Instance 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 Instance resource accepts the following input properties:

    Attributes Pulumi.AwsNative.Connect.Inputs.InstanceAttributes
    The attributes for the instance.
    IdentityManagementType Pulumi.AwsNative.Connect.InstanceIdentityManagementType
    Specifies the type of directory integration for new instance.
    DirectoryId string
    Existing directoryId user wants to map to the new Connect instance.
    InstanceAlias string
    Alias of the new directory created as part of new instance creation.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    Attributes InstanceAttributesArgs
    The attributes for the instance.
    IdentityManagementType InstanceIdentityManagementType
    Specifies the type of directory integration for new instance.
    DirectoryId string
    Existing directoryId user wants to map to the new Connect instance.
    InstanceAlias string
    Alias of the new directory created as part of new instance creation.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    attributes InstanceAttributes
    The attributes for the instance.
    identityManagementType InstanceIdentityManagementType
    Specifies the type of directory integration for new instance.
    directoryId String
    Existing directoryId user wants to map to the new Connect instance.
    instanceAlias String
    Alias of the new directory created as part of new instance creation.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    attributes InstanceAttributes
    The attributes for the instance.
    identityManagementType InstanceIdentityManagementType
    Specifies the type of directory integration for new instance.
    directoryId string
    Existing directoryId user wants to map to the new Connect instance.
    instanceAlias string
    Alias of the new directory created as part of new instance creation.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    attributes InstanceAttributesArgs
    The attributes for the instance.
    identity_management_type InstanceIdentityManagementType
    Specifies the type of directory integration for new instance.
    directory_id str
    Existing directoryId user wants to map to the new Connect instance.
    instance_alias str
    Alias of the new directory created as part of new instance creation.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    attributes Property Map
    The attributes for the instance.
    identityManagementType "SAML" | "CONNECT_MANAGED" | "EXISTING_DIRECTORY"
    Specifies the type of directory integration for new instance.
    directoryId String
    Existing directoryId user wants to map to the new Connect instance.
    instanceAlias String
    Alias of the new directory created as part of new instance creation.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

    Arn string
    An instanceArn is automatically generated on creation based on instanceId.
    AwsId string
    An instanceId is automatically generated on creation and assigned as the unique identifier.
    CreatedTime string
    Timestamp of instance creation logged as part of instance creation.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceStatus Pulumi.AwsNative.Connect.InstanceStatus
    Specifies the creation status of new instance.
    ServiceRole string
    Service linked role created as part of instance creation.
    Arn string
    An instanceArn is automatically generated on creation based on instanceId.
    AwsId string
    An instanceId is automatically generated on creation and assigned as the unique identifier.
    CreatedTime string
    Timestamp of instance creation logged as part of instance creation.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceStatus InstanceStatus
    Specifies the creation status of new instance.
    ServiceRole string
    Service linked role created as part of instance creation.
    arn String
    An instanceArn is automatically generated on creation based on instanceId.
    awsId String
    An instanceId is automatically generated on creation and assigned as the unique identifier.
    createdTime String
    Timestamp of instance creation logged as part of instance creation.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceStatus InstanceStatus
    Specifies the creation status of new instance.
    serviceRole String
    Service linked role created as part of instance creation.
    arn string
    An instanceArn is automatically generated on creation based on instanceId.
    awsId string
    An instanceId is automatically generated on creation and assigned as the unique identifier.
    createdTime string
    Timestamp of instance creation logged as part of instance creation.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceStatus InstanceStatus
    Specifies the creation status of new instance.
    serviceRole string
    Service linked role created as part of instance creation.
    arn str
    An instanceArn is automatically generated on creation based on instanceId.
    aws_id str
    An instanceId is automatically generated on creation and assigned as the unique identifier.
    created_time str
    Timestamp of instance creation logged as part of instance creation.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_status InstanceStatus
    Specifies the creation status of new instance.
    service_role str
    Service linked role created as part of instance creation.
    arn String
    An instanceArn is automatically generated on creation based on instanceId.
    awsId String
    An instanceId is automatically generated on creation and assigned as the unique identifier.
    createdTime String
    Timestamp of instance creation logged as part of instance creation.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceStatus "CREATION_IN_PROGRESS" | "CREATION_FAILED" | "ACTIVE"
    Specifies the creation status of new instance.
    serviceRole String
    Service linked role created as part of instance creation.

    Supporting Types

    InstanceAttributes, InstanceAttributesArgs

    InstanceIdentityManagementType, InstanceIdentityManagementTypeArgs

    Saml
    SAML
    ConnectManaged
    CONNECT_MANAGED
    ExistingDirectory
    EXISTING_DIRECTORY
    InstanceIdentityManagementTypeSaml
    SAML
    InstanceIdentityManagementTypeConnectManaged
    CONNECT_MANAGED
    InstanceIdentityManagementTypeExistingDirectory
    EXISTING_DIRECTORY
    Saml
    SAML
    ConnectManaged
    CONNECT_MANAGED
    ExistingDirectory
    EXISTING_DIRECTORY
    Saml
    SAML
    ConnectManaged
    CONNECT_MANAGED
    ExistingDirectory
    EXISTING_DIRECTORY
    SAML
    SAML
    CONNECT_MANAGED
    CONNECT_MANAGED
    EXISTING_DIRECTORY
    EXISTING_DIRECTORY
    "SAML"
    SAML
    "CONNECT_MANAGED"
    CONNECT_MANAGED
    "EXISTING_DIRECTORY"
    EXISTING_DIRECTORY

    InstanceStatus, InstanceStatusArgs

    CreationInProgress
    CREATION_IN_PROGRESS
    CreationFailed
    CREATION_FAILED
    Active
    ACTIVE
    InstanceStatusCreationInProgress
    CREATION_IN_PROGRESS
    InstanceStatusCreationFailed
    CREATION_FAILED
    InstanceStatusActive
    ACTIVE
    CreationInProgress
    CREATION_IN_PROGRESS
    CreationFailed
    CREATION_FAILED
    Active
    ACTIVE
    CreationInProgress
    CREATION_IN_PROGRESS
    CreationFailed
    CREATION_FAILED
    Active
    ACTIVE
    CREATION_IN_PROGRESS
    CREATION_IN_PROGRESS
    CREATION_FAILED
    CREATION_FAILED
    ACTIVE
    ACTIVE
    "CREATION_IN_PROGRESS"
    CREATION_IN_PROGRESS
    "CREATION_FAILED"
    CREATION_FAILED
    "ACTIVE"
    ACTIVE

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native