amazonka-cloudformation-2.0: Amazon CloudFormation SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudFormation.DescribeStackInstance

Description

Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region.

For a list of stack instances that are associated with a specific stack set, use ListStackInstances.

Synopsis

Creating a Request

data DescribeStackInstance Source #

See: newDescribeStackInstance smart constructor.

Constructors

DescribeStackInstance' 

Fields

  • callAs :: Maybe CallAs
    Service-managed permissions
    Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.
    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

  • stackSetName :: Text

    The name or the unique stack ID of the stack set that you want to get stack instance information for.

  • stackInstanceAccount :: Text

    The ID of an Amazon Web Services account that's associated with this stack instance.

  • stackInstanceRegion :: Text

    The name of a Region that's associated with this stack instance.

Instances

Instances details
ToHeaders DescribeStackInstance Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackInstance

ToPath DescribeStackInstance Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackInstance

ToQuery DescribeStackInstance Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackInstance

AWSRequest DescribeStackInstance Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackInstance

Associated Types

type AWSResponse DescribeStackInstance #

Generic DescribeStackInstance Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackInstance

Associated Types

type Rep DescribeStackInstance :: Type -> Type #

Read DescribeStackInstance Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackInstance

Show DescribeStackInstance Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackInstance

NFData DescribeStackInstance Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackInstance

Methods

rnf :: DescribeStackInstance -> () #

Eq DescribeStackInstance Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackInstance

Hashable DescribeStackInstance Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackInstance

type AWSResponse DescribeStackInstance Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackInstance

type Rep DescribeStackInstance Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackInstance

type Rep DescribeStackInstance = D1 ('MetaData "DescribeStackInstance" "Amazonka.CloudFormation.DescribeStackInstance" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "DescribeStackInstance'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "callAs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAs)) :*: S1 ('MetaSel ('Just "stackSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "stackInstanceAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "stackInstanceRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeStackInstance Source #

Create a value of DescribeStackInstance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:callAs:DescribeStackInstance', describeStackInstance_callAs - [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.
  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

DescribeStackInstance, describeStackInstance_stackSetName - The name or the unique stack ID of the stack set that you want to get stack instance information for.

$sel:stackInstanceAccount:DescribeStackInstance', describeStackInstance_stackInstanceAccount - The ID of an Amazon Web Services account that's associated with this stack instance.

$sel:stackInstanceRegion:DescribeStackInstance', describeStackInstance_stackInstanceRegion - The name of a Region that's associated with this stack instance.

Request Lenses

describeStackInstance_callAs :: Lens' DescribeStackInstance (Maybe CallAs) Source #

Service-managed permissions
Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.
  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

describeStackInstance_stackSetName :: Lens' DescribeStackInstance Text Source #

The name or the unique stack ID of the stack set that you want to get stack instance information for.

describeStackInstance_stackInstanceAccount :: Lens' DescribeStackInstance Text Source #

The ID of an Amazon Web Services account that's associated with this stack instance.

describeStackInstance_stackInstanceRegion :: Lens' DescribeStackInstance Text Source #

The name of a Region that's associated with this stack instance.

Destructuring the Response

data DescribeStackInstanceResponse Source #

See: newDescribeStackInstanceResponse smart constructor.

Constructors

DescribeStackInstanceResponse' 

Fields

Instances

Instances details
Generic DescribeStackInstanceResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackInstance

Associated Types

type Rep DescribeStackInstanceResponse :: Type -> Type #

Read DescribeStackInstanceResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackInstance

Show DescribeStackInstanceResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackInstance

NFData DescribeStackInstanceResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackInstance

Eq DescribeStackInstanceResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackInstance

type Rep DescribeStackInstanceResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackInstance

type Rep DescribeStackInstanceResponse = D1 ('MetaData "DescribeStackInstanceResponse" "Amazonka.CloudFormation.DescribeStackInstance" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "DescribeStackInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stackInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StackInstance)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeStackInstanceResponse Source #

Create a value of DescribeStackInstanceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:stackInstance:DescribeStackInstanceResponse', describeStackInstanceResponse_stackInstance - The stack instance that matches the specified request parameters.

$sel:httpStatus:DescribeStackInstanceResponse', describeStackInstanceResponse_httpStatus - The response's http status code.

Response Lenses

describeStackInstanceResponse_stackInstance :: Lens' DescribeStackInstanceResponse (Maybe StackInstance) Source #

The stack instance that matches the specified request parameters.