Package software.amazon.awscdk.services.elasticache

Class CfnSecurityGroupIngress

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.elasticache.CfnSecurityGroupIngress

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-24T02:42:37.980Z")
@Stability(Stable)
public class CfnSecurityGroupIngress
extends CfnResource
implements IInspectable

The AWS::ElastiCache::SecurityGroupIngress type authorizes ingress to a cache security group from hosts in specified Amazon EC2 security groups.

For more information about ElastiCache security group ingress, go to AuthorizeCacheSecurityGroupIngress in the Amazon ElastiCache API Reference Guide .

Updates are not supported.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticache.*;
 CfnSecurityGroupIngress cfnSecurityGroupIngress = CfnSecurityGroupIngress.Builder.create(this, "MyCfnSecurityGroupIngress")
         .cacheSecurityGroupName("cacheSecurityGroupName")
         .ec2SecurityGroupName("ec2SecurityGroupName")
         // the properties below are optional
         .ec2SecurityGroupOwnerId("ec2SecurityGroupOwnerId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-securitygroupingress.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnSecurityGroupIngress.Builder	A fluent builder for CfnSecurityGroupIngress.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnSecurityGroupIngress(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSecurityGroupIngress(software.amazon.jsii.JsiiObjectRef objRef)
	CfnSecurityGroupIngress(software.constructs.Construct scope, String id, CfnSecurityGroupIngressProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrId()
String	getCacheSecurityGroupName()	The name of the Cache Security Group to authorize.
protected Map<String,Object>	getCfnProperties()
String	getEc2SecurityGroupName()	Name of the EC2 Security Group to include in the authorization.
String	getEc2SecurityGroupOwnerId()	Specifies the Amazon Account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName property.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCacheSecurityGroupName(String value)	The name of the Cache Security Group to authorize.
void	setEc2SecurityGroupName(String value)	Name of the EC2 Security Group to include in the authorization.
void	setEc2SecurityGroupOwnerId(String value)	Specifies the Amazon Account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName property.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnSecurityGroupIngress

protected CfnSecurityGroupIngress(software.amazon.jsii.JsiiObjectRef objRef)

CfnSecurityGroupIngress

protected CfnSecurityGroupIngress(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSecurityGroupIngress

@Stability(Stable)
public CfnSecurityGroupIngress(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnSecurityGroupIngressProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCacheSecurityGroupName

@Stability(Stable)
@NotNull
public String getCacheSecurityGroupName()

The name of the Cache Security Group to authorize.

setCacheSecurityGroupName

@Stability(Stable)
public void setCacheSecurityGroupName(@NotNull
 String value)

The name of the Cache Security Group to authorize.

getEc2SecurityGroupName

@Stability(Stable)
@NotNull
public String getEc2SecurityGroupName()

Name of the EC2 Security Group to include in the authorization.

setEc2SecurityGroupName

@Stability(Stable)
public void setEc2SecurityGroupName(@NotNull
 String value)

Name of the EC2 Security Group to include in the authorization.

getEc2SecurityGroupOwnerId

@Stability(Stable)
@Nullable
public String getEc2SecurityGroupOwnerId()

Specifies the Amazon Account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName property.

setEc2SecurityGroupOwnerId

@Stability(Stable)
public void setEc2SecurityGroupOwnerId(@Nullable
 String value)

Specifies the Amazon Account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName property.