CloudFormationServiceResource
Index > CloudFormation > CloudFormationServiceResource
Auto-generated documentation for CloudFormation type annotations stubs module mypy-boto3-cloudformation.
CloudFormationServiceResource
Type annotations and code completion for boto3.resource("cloudformation")
, included resources and collections.
boto3 documentation
from mypy_boto3_cloudformation.service_resource import CloudFormationServiceResource
def get_cloudformation_resource() -> CloudFormationServiceResource:
return boto3.resource("cloudformation")
Attributes
-
stacks
: ServiceResourceStacksCollection
Collections
ServiceResourceStacksCollection
Provides access to Stack resource.
Type annotations and code completion for boto3.resource("cloudformation").stacks
collection.
boto3 documentation
from mypy_boto3_cloudformation.service_resource import ServiceResourceStacksCollection
def get_collection() -> ServiceResourceStacksCollection:
return boto3.resource("cloudformation").stacks
Methods
CloudFormationServiceResource.Event method
Creates a Event resource.
Type annotations and code completion for boto3.resource("cloudformation").Event
method.
boto3 documentation
kwargs: ServiceResourceEventRequestTypeDef = { # (1)
"id": ...,
}
parent.Event(**kwargs)
CloudFormationServiceResource.Stack method
Creates a Stack resource.
Type annotations and code completion for boto3.resource("cloudformation").Stack
method.
boto3 documentation
kwargs: ServiceResourceStackRequestTypeDef = { # (1)
"name": ...,
}
parent.Stack(**kwargs)
CloudFormationServiceResource.StackResource method
Creates a StackResource resource.
Type annotations and code completion for boto3.resource("cloudformation").StackResource
method.
boto3 documentation
kwargs: ServiceResourceStackResourceRequestTypeDef = { # (1)
"stack_name": ...,
"logical_id": ...,
}
parent.StackResource(**kwargs)
CloudFormationServiceResource.StackResourceSummary method
Creates a StackResourceSummary resource.
Type annotations and code completion for boto3.resource("cloudformation").StackResourceSummary
method.
boto3 documentation
def StackResourceSummary(
self,
stack_name: str,
logical_id: str,
) -> StackResourceSummary:
...
kwargs: ServiceResourceStackResourceSummaryRequestTypeDef = { # (1)
"stack_name": ...,
"logical_id": ...,
}
parent.StackResourceSummary(**kwargs)
CloudFormationServiceResource.create_stack method
Creates a stack as specified in the template.
Type annotations and code completion for boto3.resource("cloudformation").create_stack
method.
boto3 documentation
def create_stack(
self,
*,
StackName: str,
TemplateBody: str = ...,
TemplateURL: str = ...,
Parameters: Sequence[ParameterTypeDef] = ..., # (1)
DisableRollback: bool = ...,
RollbackConfiguration: RollbackConfigurationTypeDef = ..., # (2)
TimeoutInMinutes: int = ...,
NotificationARNs: Sequence[str] = ...,
Capabilities: Sequence[CapabilityType] = ..., # (3)
ResourceTypes: Sequence[str] = ...,
RoleARN: str = ...,
OnFailure: OnFailureType = ..., # (4)
StackPolicyBody: str = ...,
StackPolicyURL: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (5)
ClientRequestToken: str = ...,
EnableTerminationProtection: bool = ...,
) -> Stack:
...
- See ParameterTypeDef
- See RollbackConfigurationTypeDef
- See CapabilityType
- See OnFailureType
- See TagTypeDef
kwargs: CreateStackInputServiceResourceCreateStackTypeDef = { # (1)
"StackName": ...,
}
parent.create_stack(**kwargs)
CloudFormationServiceResource.get_available_subresources method
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for boto3.resource("cloudformation").get_available_subresources
method.
boto3 documentation
Event
Type annotations and code completion for boto3.resource("cloudformation").Event
class.
boto3 documentation
from mypy_boto3_cloudformation.service_resource import Event
def get_resource() -> Event:
return boto3.resource("cloudformation").Event(...)
Event attributes
stack_id
:str
event_id
:str
stack_name
:str
logical_resource_id
:str
physical_resource_id
:str
resource_type
:str
timestamp
:datetime
resource_status
: ResourceStatusTyperesource_status_reason
:str
resource_properties
:str
client_request_token
:str
hook_type
:str
hook_status
: HookStatusTypehook_status_reason
:str
hook_invocation_point
:Literal['PRE_PROVISION']
(see HookInvocationPointType)hook_failure_mode
: HookFailureModeTypeid
:str
Event methods
Event.get_available_subresources method
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for boto3.resource("cloudformation").get_available_subresources
method.
boto3 documentation
Stack
Type annotations and code completion for boto3.resource("cloudformation").Stack
class.
boto3 documentation
from mypy_boto3_cloudformation.service_resource import Stack
def get_resource() -> Stack:
return boto3.resource("cloudformation").Stack(...)
Stack attributes
stack_id
:str
stack_name
:str
change_set_id
:str
description
:str
parameters
:List
[ParameterTypeDef]creation_time
:datetime
deletion_time
:datetime
last_updated_time
:datetime
rollback_configuration
: RollbackConfigurationResponseMetadataTypeDefstack_status
: StackStatusTypestack_status_reason
:str
disable_rollback
:bool
notification_arns
:List
[str
]timeout_in_minutes
:int
capabilities
:List
[CapabilityType]outputs
:List
[OutputTypeDef]role_arn
:str
tags
:List
[TagTypeDef]enable_termination_protection
:bool
parent_id
:str
root_id
:str
drift_information
: StackDriftInformationResponseMetadataTypeDefname
:str
events
: StackEventsCollectionresource_summaries
: StackResourceSummariesCollection
Stack collections
Stack.events
Provides access to Event resource.
Type annotations and code completion for boto3.resource("cloudformation").Stack(...).events
collection.
boto3 documentation
from mypy_boto3_cloudformation.service_resource import StackEventsCollection
def get_collection() -> StackEventsCollection:
resource = boto3.resource("cloudformation").Stack(...)
return resource.events
Stack.resource_summaries
Provides access to StackResourceSummary resource.
Type annotations and code completion for boto3.resource("cloudformation").Stack(...).resource_summaries
collection.
boto3 documentation
from mypy_boto3_cloudformation.service_resource import StackResourceSummariesCollection
def get_collection() -> StackResourceSummariesCollection:
resource = boto3.resource("cloudformation").Stack(...)
return resource.resource_summaries
Stack methods
Stack.Resource method
Creates a StackResource resource.
Type annotations and code completion for boto3.resource("cloudformation").Resource
method.
boto3 documentation
kwargs: StackResourceRequestTypeDef = { # (1)
"logical_id": ...,
}
parent.Resource(**kwargs)
Stack.cancel_update method
Cancels an update on the specified stack.
Type annotations and code completion for boto3.resource("cloudformation").cancel_update
method.
boto3 documentation
kwargs: CancelUpdateStackInputStackCancelUpdateTypeDef = { # (1)
"ClientRequestToken": ...,
}
parent.cancel_update(**kwargs)
Stack.delete method
Deletes a specified stack.
Type annotations and code completion for boto3.resource("cloudformation").delete
method.
boto3 documentation
def delete(
self,
*,
RetainResources: Sequence[str] = ...,
RoleARN: str = ...,
ClientRequestToken: str = ...,
) -> None:
...
kwargs: DeleteStackInputStackDeleteTypeDef = { # (1)
"RetainResources": ...,
}
parent.delete(**kwargs)
Stack.get_available_subresources method
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for boto3.resource("cloudformation").get_available_subresources
method.
boto3 documentation
Stack.load method
Calls meth:CloudFormation.Client.describe_stacks
to update the attributes
of the Stack resource.
Type annotations and code completion for boto3.resource("cloudformation").load
method.
boto3 documentation
Stack.reload method
Calls meth:CloudFormation.Client.describe_stacks
to update the attributes
of the Stack resource.
Type annotations and code completion for boto3.resource("cloudformation").reload
method.
boto3 documentation
Stack.update method
Updates a stack as specified in the template.
Type annotations and code completion for boto3.resource("cloudformation").update
method.
boto3 documentation
def update(
self,
*,
TemplateBody: str = ...,
TemplateURL: str = ...,
UsePreviousTemplate: bool = ...,
StackPolicyDuringUpdateBody: str = ...,
StackPolicyDuringUpdateURL: str = ...,
Parameters: Sequence[ParameterTypeDef] = ..., # (1)
Capabilities: Sequence[CapabilityType] = ..., # (2)
ResourceTypes: Sequence[str] = ...,
RoleARN: str = ...,
RollbackConfiguration: RollbackConfigurationTypeDef = ..., # (3)
StackPolicyBody: str = ...,
StackPolicyURL: str = ...,
NotificationARNs: Sequence[str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (4)
DisableRollback: bool = ...,
ClientRequestToken: str = ...,
) -> UpdateStackOutputTypeDef: # (5)
...
- See ParameterTypeDef
- See CapabilityType
- See RollbackConfigurationTypeDef
- See TagTypeDef
- See UpdateStackOutputTypeDef
kwargs: UpdateStackInputStackUpdateTypeDef = { # (1)
"TemplateBody": ...,
}
parent.update(**kwargs)
StackResource
Type annotations and code completion for boto3.resource("cloudformation").StackResource
class.
boto3 documentation
from mypy_boto3_cloudformation.service_resource import StackResource
def get_resource() -> StackResource:
return boto3.resource("cloudformation").StackResource(...)
StackResource attributes
stack_id
:str
logical_resource_id
:str
physical_resource_id
:str
resource_type
:str
last_updated_timestamp
:datetime
resource_status
: ResourceStatusTyperesource_status_reason
:str
description
:str
metadata
:str
drift_information
: StackResourceDriftInformationResponseMetadataTypeDefmodule_info
: ModuleInfoResponseMetadataTypeDefstack_name
:str
logical_id
:str
StackResource methods
StackResource.Stack method
Creates a Stack resource.
Type annotations and code completion for boto3.resource("cloudformation").Stack
method.
boto3 documentation
StackResource.get_available_subresources method
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for boto3.resource("cloudformation").get_available_subresources
method.
boto3 documentation
StackResource.load method
Calls meth:CloudFormation.Client.describe_stack_resource
to update the
attributes of the StackResource resource.
Type annotations and code completion for boto3.resource("cloudformation").load
method.
boto3 documentation
StackResource.reload method
Calls meth:CloudFormation.Client.describe_stack_resource
to update the
attributes of the StackResource resource.
Type annotations and code completion for boto3.resource("cloudformation").reload
method.
boto3 documentation
StackResourceSummary
Type annotations and code completion for boto3.resource("cloudformation").StackResourceSummary
class.
boto3 documentation
from mypy_boto3_cloudformation.service_resource import StackResourceSummary
def get_resource() -> StackResourceSummary:
return boto3.resource("cloudformation").StackResourceSummary(...)
StackResourceSummary attributes
logical_resource_id
:str
physical_resource_id
:str
resource_type
:str
last_updated_timestamp
:datetime
resource_status
: ResourceStatusTyperesource_status_reason
:str
drift_information
: StackResourceDriftInformationSummaryResponseMetadataTypeDefmodule_info
: ModuleInfoResponseMetadataTypeDefstack_name
:str
logical_id
:str
StackResourceSummary methods
StackResourceSummary.Resource method
Creates a StackResource resource.
Type annotations and code completion for boto3.resource("cloudformation").Resource
method.
boto3 documentation
StackResourceSummary.get_available_subresources method
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for boto3.resource("cloudformation").get_available_subresources
method.
boto3 documentation