Interface CfnDomain.VPCOptionsProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnDomain.VPCOptionsProperty extends
The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

For more information, see Launching your Amazon OpenSearch Service domains using a VPC in the Amazon OpenSearch Service Developer Guide .


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 VPCOptionsProperty vPCOptionsProperty = VPCOptionsProperty.builder()
  • Method Details

    • getSecurityGroupIds

      @Stability(Stable) @Nullable default List<String> getSecurityGroupIds()
      The list of security group IDs that are associated with the VPC endpoints for the domain.

      If you don't provide a security group ID, OpenSearch Service uses the default security group for the VPC. To learn more, see Security groups for your VPC in the Amazon VPC User Guide .

    • getSubnetIds

      @Stability(Stable) @Nullable default List<String> getSubnetIds()
      Provide one subnet ID for each Availability Zone that your domain uses.

      For example, you must specify three subnet IDs for a three-AZ domain. To learn more, see VPCs and subnets in the Amazon VPC User Guide .

      If you specify more than one subnet, you must also configure ZoneAwarenessEnabled and ZoneAwarenessConfig within ClusterConfig , otherwise you'll see the error "You must specify exactly one subnet" during template creation.

    • builder

      @Stability(Stable) static CfnDomain.VPCOptionsProperty.Builder builder()
      a CfnDomain.VPCOptionsProperty.Builder of CfnDomain.VPCOptionsProperty