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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.009Z")
 @Stability(value=Stable)
public class CfnSecurityGroupIngress
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ElastiCache::SecurityGroupIngress`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSecurityGroupIngress(software.constructs.Construct scope, String id, CfnSecurityGroupIngressProps props) Create a new `AWS::ElastiCache::SecurityGroupIngress`.
protected	CfnSecurityGroupIngress(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSecurityGroupIngress(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
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, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSecurityGroupIngress

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

CfnSecurityGroupIngress

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

CfnSecurityGroupIngress

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

Create a new `AWS::ElastiCache::SecurityGroupIngress`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getCacheSecurityGroupName

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

The name of the Cache Security Group to authorize.

setCacheSecurityGroupName

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

The name of the Cache Security Group to authorize.

getEc2SecurityGroupName

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

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

setEc2SecurityGroupName

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

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

getEc2SecurityGroupOwnerId

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

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

The Amazon access key ID is not an acceptable value.

setEc2SecurityGroupOwnerId

@Stability(value=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.

The Amazon access key ID is not an acceptable value.