software.amazon.awscdk

Interface IResource

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IAccelerator, IAccelerator.Jsii$Default, IAccessKey, IAccessKey.Jsii$Default, IAccessPoint, IAccessPoint.Jsii$Default, IActivity, IActivity.Jsii$Default, IAlarm, IAlarm.Jsii$Default, IAlias, IAlias, IAlias.Jsii$Default, IAlias.Jsii$Default, IApiDestination, IApiDestination.Jsii$Default, IApiKey, IApiKey.Jsii$Default, IApplicationListener, IApplicationListener.Jsii$Default, IApplicationLoadBalancer, IApplicationLoadBalancer.Jsii$Default, IAutoScalingGroup, IAutoScalingGroup.Jsii$Default, IBackupPlan, IBackupPlan.Jsii$Default, IBackupVault, IBackupVault.Jsii$Default, IBaseService, IBaseService.Jsii$Default, IBucket, IBucket.Jsii$Default, ICertificate, ICertificate.Jsii$Default, ICertificateAuthority, ICertificateAuthority.Jsii$Default, IClientVpnEndpoint, IClientVpnEndpoint.Jsii$Default, ICluster, ICluster, ICluster.Jsii$Default, ICluster.Jsii$Default, IClusterParameterGroup, IClusterParameterGroup.Jsii$Default, ICodeSigningConfig, ICodeSigningConfig.Jsii$Default, IConfigurationSet, IConfigurationSet.Jsii$Default, IConnection, IConnection.Jsii$Default, IDatabaseCluster, IDatabaseCluster, IDatabaseCluster.Jsii$Default, IDatabaseCluster.Jsii$Default, IDatabaseInstance, IDatabaseInstance, IDatabaseInstance.Jsii$Default, IDatabaseInstance.Jsii$Default, IDatabaseProxy, IDatabaseProxy.Jsii$Default, IDedicatedIpPool, IDedicatedIpPool.Jsii$Default, IDistribution, IDistribution.Jsii$Default, IDomain, IDomain, IDomain.Jsii$Default, IDomain.Jsii$Default, IDomainName, IDomainName.Jsii$Default, IEc2Service, IEc2Service.Jsii$Default, IEc2TaskDefinition, IEc2TaskDefinition.Jsii$Default, IEcsApplication, IEcsApplication.Jsii$Default, IEcsDeploymentGroup, IEcsDeploymentGroup.Jsii$Default, IEmailIdentity, IEmailIdentity.Jsii$Default, IEndpointGroup, IEndpointGroup.Jsii$Default, IEventBus, IEventBus.Jsii$Default, IEventSourceMapping, IEventSourceMapping.Jsii$Default, IExternalService, IExternalService.Jsii$Default, IExternalTaskDefinition, IExternalTaskDefinition.Jsii$Default, IFargateService, IFargateService.Jsii$Default, IFargateTaskDefinition, IFargateTaskDefinition.Jsii$Default, IFileSystem, IFileSystem.Jsii$Default, IFlowLog, IFlowLog.Jsii$Default, IFunction, IFunction, IFunction.Jsii$Default, IFunction.Jsii$Default, IFunctionUrl, IFunctionUrl.Jsii$Default, IGatewayResponse, IGatewayResponse.Jsii$Default, IGatewayRoute, IGatewayRoute.Jsii$Default, IGatewayVpcEndpoint, IGatewayVpcEndpoint.Jsii$Default, IGroup, IGroup.Jsii$Default, IHostedZone, IHostedZone.Jsii$Default, IHttpNamespace, IHttpNamespace.Jsii$Default, IIdentity, IIdentity.Jsii$Default, IInstance, IInstance, IInstance.Jsii$Default, IInstance.Jsii$Default, IInterfaceVpcEndpoint, IInterfaceVpcEndpoint.Jsii$Default, IKey, IKey.Jsii$Default, IKeyGroup, IKeyGroup.Jsii$Default, ILambdaApplication, ILambdaApplication.Jsii$Default, ILambdaDeploymentGroup, ILambdaDeploymentGroup.Jsii$Default, ILaunchTemplate, ILaunchTemplate.Jsii$Default, ILayerVersion, ILayerVersion.Jsii$Default, ILifecycleHook, ILifecycleHook.Jsii$Default, IListener, IListener.Jsii$Default, ILoadBalancerV2, ILoadBalancerV2.Jsii$Default, ILogGroup, ILogGroup.Jsii$Default, ILogStream, ILogStream.Jsii$Default, IMesh, IMesh.Jsii$Default, INamespace, INamespace.Jsii$Default, INetworkAcl, INetworkAcl.Jsii$Default, INetworkAclEntry, INetworkAclEntry.Jsii$Default, INetworkListener, INetworkListener.Jsii$Default, INetworkLoadBalancer, INetworkLoadBalancer.Jsii$Default, INodegroup, INodegroup.Jsii$Default, INotificationRule, INotificationRule.Jsii$Default, IOpenIdConnectProvider, IOpenIdConnectProvider.Jsii$Default, IOptionGroup, IOptionGroup.Jsii$Default, IOriginAccessIdentity, IOriginAccessIdentity.Jsii$Default, IParameter, IParameter.Jsii$Default, IParameterGroup, IParameterGroup.Jsii$Default, IPipeline, IPipeline.Jsii$Default, IPolicy, IPolicy.Jsii$Default, IPortfolio, IPortfolio.Jsii$Default, IPrivateDnsNamespace, IPrivateDnsNamespace.Jsii$Default, IPrivateHostedZone, IPrivateHostedZone.Jsii$Default, IPrivateSubnet, IPrivateSubnet.Jsii$Default, IProduct, IProduct.Jsii$Default, IProfilingGroup, IProfilingGroup.Jsii$Default, IProject, IProject.Jsii$Default, IPublicDnsNamespace, IPublicDnsNamespace.Jsii$Default, IPublicHostedZone, IPublicHostedZone.Jsii$Default, IPublicKey, IPublicKey.Jsii$Default, IPublicSubnet, IPublicSubnet.Jsii$Default, IQueue, IQueue.Jsii$Default, IReceiptRule, IReceiptRule.Jsii$Default, IReceiptRuleSet, IReceiptRuleSet.Jsii$Default, IRecordSet, IRecordSet.Jsii$Default, IReportGroup, IReportGroup.Jsii$Default, IRepository, IRepository, IRepository.Jsii$Default, IRepository.Jsii$Default, IRequestValidator, IRequestValidator.Jsii$Default, IResource, IResource.Jsii$Default, IResource.Jsii$Default, IResourceWithPolicy, IResourceWithPolicy.Jsii$Default, IRestApi, IRestApi.Jsii$Default, IRole, IRole.Jsii$Default, IRoute, IRoute.Jsii$Default, IRule, IRule, IRule.Jsii$Default, IRule.Jsii$Default, ISamlProvider, ISamlProvider.Jsii$Default, IScalableTarget, IScalableTarget.Jsii$Default, ISecret, ISecret.Jsii$Default, ISecretTargetAttachment, ISecretTargetAttachment.Jsii$Default, ISecurityGroup, ISecurityGroup.Jsii$Default, IServerApplication, IServerApplication.Jsii$Default, IServerDeploymentGroup, IServerDeploymentGroup.Jsii$Default, IServerlessCluster, IServerlessCluster.Jsii$Default, IService, IService, IService.Jsii$Default, IService.Jsii$Default, ISigningProfile, ISigningProfile.Jsii$Default, ISlackChannelConfiguration, ISlackChannelConfiguration.Jsii$Default, IStage, IStage.Jsii$Default, IStateMachine, IStateMachine.Jsii$Default, IStream, IStream.Jsii$Default, IStringListParameter, IStringListParameter.Jsii$Default, IStringParameter, IStringParameter.Jsii$Default, ISubnet, ISubnet.Jsii$Default, ISubnetGroup, ISubnetGroup.Jsii$Default, ISubnetNetworkAclAssociation, ISubnetNetworkAclAssociation.Jsii$Default, ITable, ITable.Jsii$Default, ITaskDefinition, ITaskDefinition.Jsii$Default, ITopic, ITopic.Jsii$Default, IUsagePlan, IUsagePlan.Jsii$Default, IUser, IUser.Jsii$Default, IUserPool, IUserPool.Jsii$Default, IUserPoolClient, IUserPoolClient.Jsii$Default, IUserPoolDomain, IUserPoolDomain.Jsii$Default, IUserPoolIdentityProvider, IUserPoolIdentityProvider.Jsii$Default, IUserPoolResourceServer, IUserPoolResourceServer.Jsii$Default, IVersion, IVersion.Jsii$Default, IVirtualGateway, IVirtualGateway.Jsii$Default, IVirtualNode, IVirtualNode.Jsii$Default, IVirtualRouter, IVirtualRouter.Jsii$Default, IVirtualService, IVirtualService.Jsii$Default, IVolume, IVolume.Jsii$Default, IVpc, IVpc.Jsii$Default, IVpcEndpoint, IVpcEndpoint.Jsii$Default, IVpcEndpointService, IVpcEndpointService.Jsii$Default, IVpcLink, IVpcLink.Jsii$Default, IVpnConnection, IVpnConnection.Jsii$Default, IVpnGateway, IVpnGateway.Jsii$Default

All Known Implementing Classes:

AaaaRecord, Accelerator, AccessKey, AccessKeysRotated, AccessPoint, Activity, Alarm, AlarmBase, Alias, Alias, AliasTargetInstance, ApiDestination, ApiKey, ApplicationListener, ApplicationLoadBalancer, Archive, ARecord, Authorizer, AutoScalingGroup, AwsCliLayer, BackupPlan, BackupSelection, BackupVault, BaseListener, BaseLoadBalancer, BasePathMapping, BaseService, BastionHostLinux, BitBucketSourceCredentials, Bucket, BucketBase, BucketPolicy, CaaAmazonRecord, CaaRecord, CachePolicy, Certificate, ClientVpnAuthorizationRule, ClientVpnEndpoint, ClientVpnRoute, CloudFormationProduct, CloudFormationStackDriftDetectionCheck, CloudFormationStackNotificationCheck, CloudFrontWebDistribution, Cluster, Cluster, ClusterParameterGroup, CnameInstance, CnameRecord, CodeSigningConfig, CognitoUserPoolsAuthorizer, CompositeAlarm, ConfigurationSet, Connection, CrossAccountDestination, CustomLambdaDeploymentConfig, CustomResource, CustomRule, Dashboard, DatabaseCluster, DatabaseCluster, DatabaseClusterBase, DatabaseClusterFromSnapshot, DatabaseInstance, DatabaseInstance, DatabaseInstanceBase, DatabaseInstanceFromSnapshot, DatabaseInstanceReadReplica, DatabaseProxy, DatabaseSecret, DatabaseSecret, DedicatedIpPool, Deployment, Distribution, DnsValidatedCertificate, DockerImageFunction, Domain, Domain, DomainName, DsRecord, Ec2Service, Ec2TaskDefinition, EcsApplication, EdgeFunction, EmailIdentity, EndpointGroup, EventBus, EventInvokeConfig, EventSourceMapping, ExternalService, ExternalTaskDefinition, FargateCluster, FargateService, FargateTaskDefinition, FileSystem, FileSystemBase, FlowLog, Function, Function, FunctionBase, FunctionUrl, GatewayResponse, GatewayRoute, GatewayVpcEndpoint, GitHubEnterpriseSourceCredentials, GitHubSourceCredentials, Group, HostedZone, HttpNamespace, IAccelerator.Jsii$Proxy, IAccessKey.Jsii$Proxy, IAccessPoint.Jsii$Proxy, IActivity.Jsii$Proxy, IAlarm.Jsii$Proxy, IAlias.Jsii$Proxy, IAlias.Jsii$Proxy, IApiDestination.Jsii$Proxy, IApiKey.Jsii$Proxy, IApplicationListener.Jsii$Proxy, IApplicationLoadBalancer.Jsii$Proxy, IAutoScalingGroup.Jsii$Proxy, IBackupPlan.Jsii$Proxy, IBackupVault.Jsii$Proxy, IBaseService.Jsii$Proxy, IBucket.Jsii$Proxy, ICertificate.Jsii$Proxy, ICertificateAuthority.Jsii$Proxy, IClientVpnEndpoint.Jsii$Proxy, ICluster.Jsii$Proxy, ICluster.Jsii$Proxy, IClusterParameterGroup.Jsii$Proxy, ICodeSigningConfig.Jsii$Proxy, IConfigurationSet.Jsii$Proxy, IConnection.Jsii$Proxy, IDatabaseCluster.Jsii$Proxy, IDatabaseCluster.Jsii$Proxy, IDatabaseInstance.Jsii$Proxy, IDatabaseInstance.Jsii$Proxy, IDatabaseProxy.Jsii$Proxy, IDedicatedIpPool.Jsii$Proxy, IDistribution.Jsii$Proxy, IDomain.Jsii$Proxy, IDomain.Jsii$Proxy, IDomainName.Jsii$Proxy, IEc2Service.Jsii$Proxy, IEc2TaskDefinition.Jsii$Proxy, IEcsApplication.Jsii$Proxy, IEcsDeploymentGroup.Jsii$Proxy, IEmailIdentity.Jsii$Proxy, IEndpointGroup.Jsii$Proxy, IEventBus.Jsii$Proxy, IEventSourceMapping.Jsii$Proxy, IExternalService.Jsii$Proxy, IExternalTaskDefinition.Jsii$Proxy, IFargateService.Jsii$Proxy, IFargateTaskDefinition.Jsii$Proxy, IFileSystem.Jsii$Proxy, IFlowLog.Jsii$Proxy, IFunction.Jsii$Proxy, IFunction.Jsii$Proxy, IFunctionUrl.Jsii$Proxy, IGatewayResponse.Jsii$Proxy, IGatewayRoute.Jsii$Proxy, IGatewayVpcEndpoint.Jsii$Proxy, IGroup.Jsii$Proxy, IHostedZone.Jsii$Proxy, IHttpNamespace.Jsii$Proxy, IIdentity.Jsii$Proxy, IInstance.Jsii$Proxy, IInstance.Jsii$Proxy, IInterfaceVpcEndpoint.Jsii$Proxy, IKey.Jsii$Proxy, IKeyGroup.Jsii$Proxy, ILambdaApplication.Jsii$Proxy, ILambdaDeploymentGroup.Jsii$Proxy, ILaunchTemplate.Jsii$Proxy, ILayerVersion.Jsii$Proxy, ILifecycleHook.Jsii$Proxy, IListener.Jsii$Proxy, ILoadBalancerV2.Jsii$Proxy, ILogGroup.Jsii$Proxy, ILogStream.Jsii$Proxy, IMesh.Jsii$Proxy, INamespace.Jsii$Proxy, INetworkAcl.Jsii$Proxy, INetworkAclEntry.Jsii$Proxy, INetworkListener.Jsii$Proxy, INetworkLoadBalancer.Jsii$Proxy, INodegroup.Jsii$Proxy, INotificationRule.Jsii$Proxy, Instance, InstanceBase, InterfaceVpcEndpoint, IOpenIdConnectProvider.Jsii$Proxy, IOptionGroup.Jsii$Proxy, IOriginAccessIdentity.Jsii$Proxy, IParameter.Jsii$Proxy, IParameterGroup.Jsii$Proxy, IpInstance, IPipeline.Jsii$Proxy, IPolicy.Jsii$Proxy, IPortfolio.Jsii$Proxy, IPrivateDnsNamespace.Jsii$Proxy, IPrivateHostedZone.Jsii$Proxy, IPrivateSubnet.Jsii$Proxy, IProduct.Jsii$Proxy, IProfilingGroup.Jsii$Proxy, IProject.Jsii$Proxy, IPublicDnsNamespace.Jsii$Proxy, IPublicHostedZone.Jsii$Proxy, IPublicKey.Jsii$Proxy, IPublicSubnet.Jsii$Proxy, IQueue.Jsii$Proxy, IReceiptRule.Jsii$Proxy, IReceiptRuleSet.Jsii$Proxy, IRecordSet.Jsii$Proxy, IReportGroup.Jsii$Proxy, IRepository.Jsii$Proxy, IRepository.Jsii$Proxy, IRequestValidator.Jsii$Proxy, IResource.Jsii$Proxy, IResource.Jsii$Proxy, IResourceWithPolicy.Jsii$Proxy, IRestApi.Jsii$Proxy, IRole.Jsii$Proxy, IRoute.Jsii$Proxy, IRule.Jsii$Proxy, IRule.Jsii$Proxy, ISamlProvider.Jsii$Proxy, IScalableTarget.Jsii$Proxy, ISecret.Jsii$Proxy, ISecretTargetAttachment.Jsii$Proxy, ISecurityGroup.Jsii$Proxy, IServerApplication.Jsii$Proxy, IServerDeploymentGroup.Jsii$Proxy, IServerlessCluster.Jsii$Proxy, IService.Jsii$Proxy, IService.Jsii$Proxy, ISigningProfile.Jsii$Proxy, ISlackChannelConfiguration.Jsii$Proxy, IStage.Jsii$Proxy, IStateMachine.Jsii$Proxy, IStream.Jsii$Proxy, IStringListParameter.Jsii$Proxy, IStringParameter.Jsii$Proxy, ISubnet.Jsii$Proxy, ISubnetGroup.Jsii$Proxy, ISubnetNetworkAclAssociation.Jsii$Proxy, ITable.Jsii$Proxy, ITaskDefinition.Jsii$Proxy, ITopic.Jsii$Proxy, IUsagePlan.Jsii$Proxy, IUser.Jsii$Proxy, IUserPool.Jsii$Proxy, IUserPoolClient.Jsii$Proxy, IUserPoolDomain.Jsii$Proxy, IUserPoolIdentityProvider.Jsii$Proxy, IUserPoolResourceServer.Jsii$Proxy, IVersion.Jsii$Proxy, IVirtualGateway.Jsii$Proxy, IVirtualNode.Jsii$Proxy, IVirtualRouter.Jsii$Proxy, IVirtualService.Jsii$Proxy, IVolume.Jsii$Proxy, IVpc.Jsii$Proxy, IVpcEndpoint.Jsii$Proxy, IVpcEndpointService.Jsii$Proxy, IVpcLink.Jsii$Proxy, IVpnConnection.Jsii$Proxy, IVpnGateway.Jsii$Proxy, Key, KeyGroup, KubectlLayer, LambdaApplication, LambdaDeploymentGroup, LambdaRestApi, LaunchTemplate, LayerVersion, LazyRole, LifecycleHook, Listener, LoadBalancer, LogGroup, LogStream, LustreFileSystem, ManagedPolicy, ManagedRule, Mesh, Method, MetricFilter, Model, MxRecord, NetworkAcl, NetworkAclEntry, NetworkListener, NetworkLoadBalancer, Nodegroup, NodejsFunction, NodeProxyAgentLayer, NonIpInstance, NotificationRule, NsRecord, OpenIdConnectProvider, OpenIdConnectProvider, OptionGroup, OriginAccessIdentity, OriginRequestPolicy, ParameterGroup, Pipeline, PipelineProject, Policy, Portfolio, PrivateCertificate, PrivateDnsNamespace, PrivateHostedZone, PrivateSubnet, Product, ProfilingGroup, Project, ProxyResource, PublicDnsNamespace, PublicHostedZone, PublicKey, PublicSubnet, QualifiedFunctionBase, QueryDefinition, Queue, QueueBase, QueuePolicy, RateLimitedApiKey, ReceiptFilter, ReceiptRule, ReceiptRuleSet, RecordSet, ReportGroup, Repository, Repository, RepositoryBase, RequestAuthorizer, RequestValidator, Resource, Resource, ResourceBase, ResourcePolicy, ResourcePolicy, ResponseHeadersPolicy, RestApi, RestApiBase, Role, RotationSchedule, Route, Rule, SamlProvider, ScalableTarget, ScheduledAction, Secret, SecretTargetAttachment, SecurityGroup, ServerApplication, ServerDeploymentConfig, ServerDeploymentGroup, ServerlessCluster, ServerlessClusterFromSnapshot, Service, SigningProfile, SingletonFunction, SlackChannelConfiguration, SpecRestApi, SrvRecord, Stage, StateMachine, StepFunctionsRestApi, Stream, StringListParameter, StringParameter, Subnet, SubnetGroup, SubnetNetworkAclAssociation, Subscription, SubscriptionFilter, Table, TagOptions, TaskDefinition, TokenAuthorizer, Topic, TopicBase, TopicPolicy, Trail, TriggerFunction, TxtRecord, UntrustedCodeBoundaryPolicy, UsagePlan, User, UserPool, UserPoolClient, UserPoolDomain, UserPoolIdentityProviderAmazon, UserPoolIdentityProviderApple, UserPoolIdentityProviderFacebook, UserPoolIdentityProviderGoogle, UserPoolIdentityProviderOidc, UserPoolIdentityProviderSaml, UserPoolResourceServer, Version, VirtualGateway, VirtualNode, VirtualRouter, VirtualService, Volume, Vpc, VpcEndpoint, VpcEndpointService, VpcLink, VpnConnection, VpnGateway, WarmPool, ZoneDelegationRecord

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:35.913Z")
 @Stability(value=Stable)
public interface IResource
extends software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

Interface for the Resource construct.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IResource.Jsii$Default Internal default implementation for IResource.
static class	IResource.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
ResourceEnvironment	getEnv() The environment this resource belongs to.
Stack	getStack() The stack in which this resource is defined.

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEnv

@Stability(value=Stable)
 @NotNull
ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

getStack

@Stability(value=Stable)
 @NotNull
Stack getStack()

The stack in which this resource is defined.

applyRemovalPolicy

@Stability(value=Stable)
void applyRemovalPolicy(@NotNull
                                                 RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy - This parameter is required.