Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudFormation.DescribeStackInstance

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data DescribeStackInstance = DescribeStackInstance' {
- callAs :: Maybe CallAs
- stackSetName :: Text
- stackInstanceAccount :: Text
- stackInstanceRegion :: Text
}
newDescribeStackInstance :: Text -> Text -> Text -> DescribeStackInstance
describeStackInstance_callAs :: Lens' DescribeStackInstance (Maybe CallAs)
describeStackInstance_stackSetName :: Lens' DescribeStackInstance Text
describeStackInstance_stackInstanceAccount :: Lens' DescribeStackInstance Text
describeStackInstance_stackInstanceRegion :: Lens' DescribeStackInstance Text
data DescribeStackInstanceResponse = DescribeStackInstanceResponse' {
- stackInstance :: Maybe StackInstance
- httpStatus :: Int
}
newDescribeStackInstanceResponse :: Int -> DescribeStackInstanceResponse
describeStackInstanceResponse_stackInstance :: Lens' DescribeStackInstanceResponse (Maybe StackInstance)
describeStackInstanceResponse_httpStatus :: Lens' DescribeStackInstanceResponse Int

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

Eq DescribeStackInstance Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackInstance Methods (==) :: DescribeStackInstance -> DescribeStackInstance -> Bool # (/=) :: DescribeStackInstance -> DescribeStackInstance -> Bool #
Read DescribeStackInstance Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackInstance Methods readsPrec :: Int -> ReadS DescribeStackInstance # readList :: ReadS [DescribeStackInstance] # readPrec :: ReadPrec DescribeStackInstance # readListPrec :: ReadPrec [DescribeStackInstance] #
Show DescribeStackInstance Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackInstance Methods showsPrec :: Int -> DescribeStackInstance -> ShowS # show :: DescribeStackInstance -> String # showList :: [DescribeStackInstance] -> ShowS #
Generic DescribeStackInstance Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackInstance Associated Types type Rep DescribeStackInstance :: Type -> Type # Methods from :: DescribeStackInstance -> Rep DescribeStackInstance x # to :: Rep DescribeStackInstance x -> DescribeStackInstance #
NFData DescribeStackInstance Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackInstance Methods rnf :: DescribeStackInstance -> () #
Hashable DescribeStackInstance Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackInstance Methods hashWithSalt :: Int -> DescribeStackInstance -> Int # hash :: DescribeStackInstance -> Int #
AWSRequest DescribeStackInstance Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackInstance Associated Types type AWSResponse DescribeStackInstance # Methods request :: DescribeStackInstance -> Request DescribeStackInstance # response :: MonadResource m => Logger -> Service -> Proxy DescribeStackInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeStackInstance))) #
ToHeaders DescribeStackInstance Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackInstance Methods toHeaders :: DescribeStackInstance -> [Header] #
ToPath DescribeStackInstance Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackInstance Methods toPath :: DescribeStackInstance -> ByteString #
ToQuery DescribeStackInstance Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackInstance Methods toQuery :: DescribeStackInstance -> QueryString #
type Rep DescribeStackInstance Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackInstance type Rep DescribeStackInstance = D1 ('MetaData "DescribeStackInstance" "Amazonka.CloudFormation.DescribeStackInstance" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" '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))))
type AWSResponse DescribeStackInstance Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackInstance type AWSResponse DescribeStackInstance = DescribeStackInstanceResponse

newDescribeStackInstance Source #

Arguments

:: Text	`$sel:stackSetName: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.

$sel:stackSetName: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 stackInstance :: Maybe StackInstance The stack instance that matches the specified request parameters. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeStackInstanceResponse Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackInstance Methods (==) :: DescribeStackInstanceResponse -> DescribeStackInstanceResponse -> Bool # (/=) :: DescribeStackInstanceResponse -> DescribeStackInstanceResponse -> Bool #
Read DescribeStackInstanceResponse Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackInstance Methods readsPrec :: Int -> ReadS DescribeStackInstanceResponse # readList :: ReadS [DescribeStackInstanceResponse] # readPrec :: ReadPrec DescribeStackInstanceResponse # readListPrec :: ReadPrec [DescribeStackInstanceResponse] #
Show DescribeStackInstanceResponse Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackInstance Methods showsPrec :: Int -> DescribeStackInstanceResponse -> ShowS # show :: DescribeStackInstanceResponse -> String # showList :: [DescribeStackInstanceResponse] -> ShowS #
Generic DescribeStackInstanceResponse Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackInstance Associated Types type Rep DescribeStackInstanceResponse :: Type -> Type # Methods from :: DescribeStackInstanceResponse -> Rep DescribeStackInstanceResponse x # to :: Rep DescribeStackInstanceResponse x -> DescribeStackInstanceResponse #
NFData DescribeStackInstanceResponse Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackInstance Methods rnf :: DescribeStackInstanceResponse -> () #
type Rep DescribeStackInstanceResponse Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackInstance type Rep DescribeStackInstanceResponse = D1 ('MetaData "DescribeStackInstanceResponse" "Amazonka.CloudFormation.DescribeStackInstance" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" '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 #

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) Source #

The stack instance that matches the specified request parameters.

describeStackInstanceResponse_httpStatus :: Lens' DescribeStackInstanceResponse Int Source #

The response's http status code.