Amazonka.CloudFormation.DescribeStackInstance

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.

Creating a Request

data DescribeStackInstance

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

ToHeaders DescribeStackInstance

Defined in Amazonka.CloudFormation.DescribeStackInstance

Methods

toHeaders :: DescribeStackInstance -> [Header]

ToPath DescribeStackInstance

Defined in Amazonka.CloudFormation.DescribeStackInstance

Methods

toPath :: DescribeStackInstance -> ByteString

ToQuery DescribeStackInstance

Defined in Amazonka.CloudFormation.DescribeStackInstance

Methods

toQuery :: DescribeStackInstance -> QueryString

AWSRequest DescribeStackInstance

Defined in Amazonka.CloudFormation.DescribeStackInstance

Associated Types

type AWSResponse DescribeStackInstance

Methods

request :: (Service -> Service) -> DescribeStackInstance -> Request DescribeStackInstance

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeStackInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeStackInstance)))

Generic DescribeStackInstance

Defined in Amazonka.CloudFormation.DescribeStackInstance

Associated Types

type Rep DescribeStackInstance :: Type -> Type

Methods

from :: DescribeStackInstance -> Rep DescribeStackInstance x

to :: Rep DescribeStackInstance x -> DescribeStackInstance

Read DescribeStackInstance

Defined in Amazonka.CloudFormation.DescribeStackInstance

Methods

readsPrec :: Int -> ReadS DescribeStackInstance

readList :: ReadS [DescribeStackInstance]

readPrec :: ReadPrec DescribeStackInstance

readListPrec :: ReadPrec [DescribeStackInstance]

Show DescribeStackInstance

Defined in Amazonka.CloudFormation.DescribeStackInstance

Methods

showsPrec :: Int -> DescribeStackInstance -> ShowS

show :: DescribeStackInstance -> String

showList :: [DescribeStackInstance] -> ShowS

NFData DescribeStackInstance

Defined in Amazonka.CloudFormation.DescribeStackInstance

Methods

rnf :: DescribeStackInstance -> ()

Eq DescribeStackInstance

Defined in Amazonka.CloudFormation.DescribeStackInstance

Methods

(==) :: DescribeStackInstance -> DescribeStackInstance -> Bool

(/=) :: DescribeStackInstance -> DescribeStackInstance -> Bool

Hashable DescribeStackInstance

Defined in Amazonka.CloudFormation.DescribeStackInstance

Methods

hashWithSalt :: Int -> DescribeStackInstance -> Int

hash :: DescribeStackInstance -> Int

type AWSResponse DescribeStackInstance

Defined in Amazonka.CloudFormation.DescribeStackInstance

type AWSResponse DescribeStackInstance = DescribeStackInstanceResponse

type Rep DescribeStackInstance

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

Arguments

:: Text

DescribeStackInstance

-> Text

$sel:stackInstanceAccount:DescribeStackInstance'

-> Text

$sel:stackInstanceRegion:DescribeStackInstance'

-> DescribeStackInstance

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)

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

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

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

describeStackInstance_stackInstanceRegion :: Lens' DescribeStackInstance Text

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

Destructuring the Response

data DescribeStackInstanceResponse

See: newDescribeStackInstanceResponse smart constructor.

Constructors

DescribeStackInstanceResponse'

Fields

• stackInstance :: Maybe StackInstance

  The stack instance that matches the specified request parameters.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeStackInstanceResponse

Defined in Amazonka.CloudFormation.DescribeStackInstance

Associated Types

type Rep DescribeStackInstanceResponse :: Type -> Type

Methods

from :: DescribeStackInstanceResponse -> Rep DescribeStackInstanceResponse x

to :: Rep DescribeStackInstanceResponse x -> DescribeStackInstanceResponse

Read DescribeStackInstanceResponse

Defined in Amazonka.CloudFormation.DescribeStackInstance

Methods

readsPrec :: Int -> ReadS DescribeStackInstanceResponse

readList :: ReadS [DescribeStackInstanceResponse]

readPrec :: ReadPrec DescribeStackInstanceResponse

readListPrec :: ReadPrec [DescribeStackInstanceResponse]

Show DescribeStackInstanceResponse

Defined in Amazonka.CloudFormation.DescribeStackInstance

Methods

showsPrec :: Int -> DescribeStackInstanceResponse -> ShowS

show :: DescribeStackInstanceResponse -> String

showList :: [DescribeStackInstanceResponse] -> ShowS

NFData DescribeStackInstanceResponse

Defined in Amazonka.CloudFormation.DescribeStackInstance

Methods

rnf :: DescribeStackInstanceResponse -> ()

Eq DescribeStackInstanceResponse

Defined in Amazonka.CloudFormation.DescribeStackInstance

Methods

(==) :: DescribeStackInstanceResponse -> DescribeStackInstanceResponse -> Bool

(/=) :: DescribeStackInstanceResponse -> DescribeStackInstanceResponse -> Bool

type Rep DescribeStackInstanceResponse

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

Arguments

:: Int

$sel:httpStatus:DescribeStackInstanceResponse'

-> DescribeStackInstanceResponse

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)

The stack instance that matches the specified request parameters.

describeStackInstanceResponse_httpStatus :: Lens' DescribeStackInstanceResponse Int

The response's http status code.