

This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::ODB::OdbNetwork
<a name="aws-resource-odb-odbnetwork"></a>

The `AWS::ODB::OdbNetwork` resource creates an ODB network. An ODB network provides the networking foundation for Oracle Database resources.

## Syntax
<a name="aws-resource-odb-odbnetwork-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-odb-odbnetwork-syntax.json"></a>

```
{
  "Type" : "AWS::ODB::OdbNetwork",
  "Properties" : {
      "[AvailabilityZone](#cfn-odb-odbnetwork-availabilityzone)" : String,
      "[AvailabilityZoneId](#cfn-odb-odbnetwork-availabilityzoneid)" : String,
      "[BackupSubnetCidr](#cfn-odb-odbnetwork-backupsubnetcidr)" : String,
      "[ClientSubnetCidr](#cfn-odb-odbnetwork-clientsubnetcidr)" : String,
      "[CrossRegionS3RestoreSources](#cfn-odb-odbnetwork-crossregions3restoresources)" : [ String, ... ],
      "[CustomDomainName](#cfn-odb-odbnetwork-customdomainname)" : String,
      "[DefaultDnsPrefix](#cfn-odb-odbnetwork-defaultdnsprefix)" : String,
      "[DeleteAssociatedResources](#cfn-odb-odbnetwork-deleteassociatedresources)" : Boolean,
      "[DisplayName](#cfn-odb-odbnetwork-displayname)" : String,
      "[KmsAccess](#cfn-odb-odbnetwork-kmsaccess)" : String,
      "[KmsPolicyDocument](#cfn-odb-odbnetwork-kmspolicydocument)" : String,
      "[S3Access](#cfn-odb-odbnetwork-s3access)" : String,
      "[S3PolicyDocument](#cfn-odb-odbnetwork-s3policydocument)" : String,
      "[StsAccess](#cfn-odb-odbnetwork-stsaccess)" : String,
      "[StsPolicyDocument](#cfn-odb-odbnetwork-stspolicydocument)" : String,
      "[Tags](#cfn-odb-odbnetwork-tags)" : [ Tag, ... ],
      "[ZeroEtlAccess](#cfn-odb-odbnetwork-zeroetlaccess)" : String
    }
}
```

### YAML
<a name="aws-resource-odb-odbnetwork-syntax.yaml"></a>

```
Type: AWS::ODB::OdbNetwork
Properties:
  [AvailabilityZone](#cfn-odb-odbnetwork-availabilityzone): String
  [AvailabilityZoneId](#cfn-odb-odbnetwork-availabilityzoneid): String
  [BackupSubnetCidr](#cfn-odb-odbnetwork-backupsubnetcidr): String
  [ClientSubnetCidr](#cfn-odb-odbnetwork-clientsubnetcidr): String
  [CrossRegionS3RestoreSources](#cfn-odb-odbnetwork-crossregions3restoresources): 
    - String
  [CustomDomainName](#cfn-odb-odbnetwork-customdomainname): String
  [DefaultDnsPrefix](#cfn-odb-odbnetwork-defaultdnsprefix): String
  [DeleteAssociatedResources](#cfn-odb-odbnetwork-deleteassociatedresources): Boolean
  [DisplayName](#cfn-odb-odbnetwork-displayname): String
  [KmsAccess](#cfn-odb-odbnetwork-kmsaccess): String
  [KmsPolicyDocument](#cfn-odb-odbnetwork-kmspolicydocument): String
  [S3Access](#cfn-odb-odbnetwork-s3access): String
  [S3PolicyDocument](#cfn-odb-odbnetwork-s3policydocument): String
  [StsAccess](#cfn-odb-odbnetwork-stsaccess): String
  [StsPolicyDocument](#cfn-odb-odbnetwork-stspolicydocument): String
  [Tags](#cfn-odb-odbnetwork-tags): 
    - Tag
  [ZeroEtlAccess](#cfn-odb-odbnetwork-zeroetlaccess): String
```

## Properties
<a name="aws-resource-odb-odbnetwork-properties"></a>

`AvailabilityZone`  <a name="cfn-odb-odbnetwork-availabilityzone"></a>
The Availability Zone (AZ) where the ODB network is located.  
Required when creating an ODB network. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the network.  
*Required*: Conditional  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`AvailabilityZoneId`  <a name="cfn-odb-odbnetwork-availabilityzoneid"></a>
The AZ ID of the AZ where the ODB network is located.  
Required when creating an ODB network. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the network.  
*Required*: Conditional  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`BackupSubnetCidr`  <a name="cfn-odb-odbnetwork-backupsubnetcidr"></a>
The CIDR range of the backup subnet in the ODB network.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ClientSubnetCidr`  <a name="cfn-odb-odbnetwork-clientsubnetcidr"></a>
The CIDR range of the client subnet in the ODB network.  
Required when creating an ODB network.  
*Required*: Conditional  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`CrossRegionS3RestoreSources`  <a name="cfn-odb-odbnetwork-crossregions3restoresources"></a>
Property description not available.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CustomDomainName`  <a name="cfn-odb-odbnetwork-customdomainname"></a>
The domain name for the resources in the ODB network.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DefaultDnsPrefix`  <a name="cfn-odb-odbnetwork-defaultdnsprefix"></a>
The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DeleteAssociatedResources`  <a name="cfn-odb-odbnetwork-deleteassociatedresources"></a>
Specifies whether to delete associated OCI networking resources along with the ODB network.  
Required when creating an ODB network.  
*Required*: Conditional  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DisplayName`  <a name="cfn-odb-odbnetwork-displayname"></a>
The user-friendly name of the ODB network.  
Required when creating an ODB network.  
*Required*: Conditional  
*Type*: String  
*Pattern*: `^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KmsAccess`  <a name="cfn-odb-odbnetwork-kmsaccess"></a>
Configuration for AWS Key Management Service (KMS) access from the ODB network.  
*Required*: No  
*Type*: [String](aws-properties-odb-odbnetwork-kmsaccess.md)  
*Allowed values*: `ENABLED | DISABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KmsPolicyDocument`  <a name="cfn-odb-odbnetwork-kmspolicydocument"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Access`  <a name="cfn-odb-odbnetwork-s3access"></a>
The configuration for Amazon S3 access from the ODB network.  
*Required*: No  
*Type*: [String](aws-properties-odb-odbnetwork-s3access.md)  
*Allowed values*: `ENABLED | DISABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3PolicyDocument`  <a name="cfn-odb-odbnetwork-s3policydocument"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StsAccess`  <a name="cfn-odb-odbnetwork-stsaccess"></a>
Configuration for AWS Security Token Service (STS) access from the ODB network.  
*Required*: No  
*Type*: [String](aws-properties-odb-odbnetwork-stsaccess.md)  
*Allowed values*: `ENABLED | DISABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StsPolicyDocument`  <a name="cfn-odb-odbnetwork-stspolicydocument"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-odb-odbnetwork-tags"></a>
Tags to assign to the Odb Network.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-odb-odbnetwork-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ZeroEtlAccess`  <a name="cfn-odb-odbnetwork-zeroetlaccess"></a>
The configuration for Zero-ETL access from the ODB network.  
*Required*: No  
*Type*: [String](aws-properties-odb-odbnetwork-zeroetlaccess.md)  
*Allowed values*: `ENABLED | DISABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-odb-odbnetwork-return-values"></a>

### Ref
<a name="aws-resource-odb-odbnetwork-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the unique identifier of the ODB network. For example:

 `{ "Ref": "myOdbNetwork" }` 

For the ODB network `myOdbNetwork`, `Ref` returns the unique identifier of the ODB network.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-odb-odbnetwork-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

#### 
<a name="aws-resource-odb-odbnetwork-return-values-fn--getatt-fn--getatt"></a>

`OciNetworkAnchorId`  <a name="OciNetworkAnchorId-fn::getatt"></a>
The unique identifier of the OCI network anchor for the ODB network.

`OciResourceAnchorName`  <a name="OciResourceAnchorName-fn::getatt"></a>
The name of the OCI resource anchor that's associated with the ODB network.

`OciVcnUrl`  <a name="OciVcnUrl-fn::getatt"></a>
The URL for the VCN that's associated with the ODB network.

`OdbNetworkArn`  <a name="OdbNetworkArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the ODB network.

`OdbNetworkId`  <a name="OdbNetworkId-fn::getatt"></a>
The unique identifier of the ODB network.

# AWS::ODB::OdbNetwork CrossRegionS3RestoreSourcesAccess
<a name="aws-properties-odb-odbnetwork-crossregions3restoresourcesaccess"></a>

The configuration access for the cross-Region Amazon S3 database restore source for the ODB network.

## Syntax
<a name="aws-properties-odb-odbnetwork-crossregions3restoresourcesaccess-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-odb-odbnetwork-crossregions3restoresourcesaccess-syntax.json"></a>

```
{
  "[Ipv4Addresses](#cfn-odb-odbnetwork-crossregions3restoresourcesaccess-ipv4addresses)" : [ String, ... ],
  "[Region](#cfn-odb-odbnetwork-crossregions3restoresourcesaccess-region)" : String,
  "[Status](#cfn-odb-odbnetwork-crossregions3restoresourcesaccess-status)" : String
}
```

### YAML
<a name="aws-properties-odb-odbnetwork-crossregions3restoresourcesaccess-syntax.yaml"></a>

```
  [Ipv4Addresses](#cfn-odb-odbnetwork-crossregions3restoresourcesaccess-ipv4addresses): 
    - String
  [Region](#cfn-odb-odbnetwork-crossregions3restoresourcesaccess-region): String
  [Status](#cfn-odb-odbnetwork-crossregions3restoresourcesaccess-status): String
```

## Properties
<a name="aws-properties-odb-odbnetwork-crossregions3restoresourcesaccess-properties"></a>

`Ipv4Addresses`  <a name="cfn-odb-odbnetwork-crossregions3restoresourcesaccess-ipv4addresses"></a>
The IPv4 addresses allowed for cross-Region Amazon S3 restore access.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Region`  <a name="cfn-odb-odbnetwork-crossregions3restoresourcesaccess-region"></a>
The AWS Region for cross-Region Amazon S3 restore access.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-odb-odbnetwork-crossregions3restoresourcesaccess-status"></a>
The current status of the cross-Region Amazon S3 restore access configuration.  
*Required*: No  
*Type*: String  
*Allowed values*: `ENABLED | ENABLING | DISABLED | DISABLING`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ODB::OdbNetwork KmsAccess
<a name="aws-properties-odb-odbnetwork-kmsaccess"></a>

Configuration for AWS Key Management Service (KMS) access from the ODB network.

## Syntax
<a name="aws-properties-odb-odbnetwork-kmsaccess-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-odb-odbnetwork-kmsaccess-syntax.json"></a>

```
{
  "[DomainName](#cfn-odb-odbnetwork-kmsaccess-domainname)" : String,
  "[Ipv4Addresses](#cfn-odb-odbnetwork-kmsaccess-ipv4addresses)" : [ String, ... ],
  "[KmsPolicyDocument](#cfn-odb-odbnetwork-kmsaccess-kmspolicydocument)" : String,
  "[Status](#cfn-odb-odbnetwork-kmsaccess-status)" : String
}
```

### YAML
<a name="aws-properties-odb-odbnetwork-kmsaccess-syntax.yaml"></a>

```
  [DomainName](#cfn-odb-odbnetwork-kmsaccess-domainname): String
  [Ipv4Addresses](#cfn-odb-odbnetwork-kmsaccess-ipv4addresses): 
    - String
  [KmsPolicyDocument](#cfn-odb-odbnetwork-kmsaccess-kmspolicydocument): String
  [Status](#cfn-odb-odbnetwork-kmsaccess-status): String
```

## Properties
<a name="aws-properties-odb-odbnetwork-kmsaccess-properties"></a>

`DomainName`  <a name="cfn-odb-odbnetwork-kmsaccess-domainname"></a>
The domain name for AWS Key Management Service (KMS) access configuration.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Ipv4Addresses`  <a name="cfn-odb-odbnetwork-kmsaccess-ipv4addresses"></a>
The IPv4 addresses allowed for AWS Key Management Service (KMS) access.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KmsPolicyDocument`  <a name="cfn-odb-odbnetwork-kmsaccess-kmspolicydocument"></a>
The AWS Key Management Service (KMS) policy document that defines permissions for key usage.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-odb-odbnetwork-kmsaccess-status"></a>
The current status of the AWS Key Management Service (KMS) access configuration.  
*Required*: No  
*Type*: String  
*Allowed values*: `ENABLED | ENABLING | DISABLED | DISABLING`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ODB::OdbNetwork ManagedS3BackupAccess
<a name="aws-properties-odb-odbnetwork-manageds3backupaccess"></a>

The configuration for managed Amazon S3 backup access from the ODB network.

## Syntax
<a name="aws-properties-odb-odbnetwork-manageds3backupaccess-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-odb-odbnetwork-manageds3backupaccess-syntax.json"></a>

```
{
  "[Ipv4Addresses](#cfn-odb-odbnetwork-manageds3backupaccess-ipv4addresses)" : [ String, ... ],
  "[Status](#cfn-odb-odbnetwork-manageds3backupaccess-status)" : String
}
```

### YAML
<a name="aws-properties-odb-odbnetwork-manageds3backupaccess-syntax.yaml"></a>

```
  [Ipv4Addresses](#cfn-odb-odbnetwork-manageds3backupaccess-ipv4addresses): 
    - String
  [Status](#cfn-odb-odbnetwork-manageds3backupaccess-status): String
```

## Properties
<a name="aws-properties-odb-odbnetwork-manageds3backupaccess-properties"></a>

`Ipv4Addresses`  <a name="cfn-odb-odbnetwork-manageds3backupaccess-ipv4addresses"></a>
The IPv4 addresses for the managed Amazon S3 backup access.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-odb-odbnetwork-manageds3backupaccess-status"></a>
The status of the managed Amazon S3 backup access.  
*Required*: No  
*Type*: String  
*Allowed values*: `ENABLED | ENABLING | DISABLED | DISABLING`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ODB::OdbNetwork ManagedServices
<a name="aws-properties-odb-odbnetwork-managedservices"></a>

The managed services configuration for the ODB network.

## Syntax
<a name="aws-properties-odb-odbnetwork-managedservices-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-odb-odbnetwork-managedservices-syntax.json"></a>

```
{
  "[CrossRegionS3RestoreSourcesAccess](#cfn-odb-odbnetwork-managedservices-crossregions3restoresourcesaccess)" : [ CrossRegionS3RestoreSourcesAccess, ... ],
  "[KmsAccess](#cfn-odb-odbnetwork-managedservices-kmsaccess)" : KmsAccess,
  "[ManagedS3BackupAccess](#cfn-odb-odbnetwork-managedservices-manageds3backupaccess)" : ManagedS3BackupAccess,
  "[ManagedServicesIpv4Cidrs](#cfn-odb-odbnetwork-managedservices-managedservicesipv4cidrs)" : [ String, ... ],
  "[ResourceGatewayArn](#cfn-odb-odbnetwork-managedservices-resourcegatewayarn)" : String,
  "[S3Access](#cfn-odb-odbnetwork-managedservices-s3access)" : S3Access,
  "[ServiceNetworkArn](#cfn-odb-odbnetwork-managedservices-servicenetworkarn)" : String,
  "[ServiceNetworkEndpoint](#cfn-odb-odbnetwork-managedservices-servicenetworkendpoint)" : ServiceNetworkEndpoint,
  "[StsAccess](#cfn-odb-odbnetwork-managedservices-stsaccess)" : StsAccess,
  "[ZeroEtlAccess](#cfn-odb-odbnetwork-managedservices-zeroetlaccess)" : ZeroEtlAccess
}
```

### YAML
<a name="aws-properties-odb-odbnetwork-managedservices-syntax.yaml"></a>

```
  [CrossRegionS3RestoreSourcesAccess](#cfn-odb-odbnetwork-managedservices-crossregions3restoresourcesaccess): 
    - CrossRegionS3RestoreSourcesAccess
  [KmsAccess](#cfn-odb-odbnetwork-managedservices-kmsaccess): 
    KmsAccess
  [ManagedS3BackupAccess](#cfn-odb-odbnetwork-managedservices-manageds3backupaccess): 
    ManagedS3BackupAccess
  [ManagedServicesIpv4Cidrs](#cfn-odb-odbnetwork-managedservices-managedservicesipv4cidrs): 
    - String
  [ResourceGatewayArn](#cfn-odb-odbnetwork-managedservices-resourcegatewayarn): String
  [S3Access](#cfn-odb-odbnetwork-managedservices-s3access): 
    S3Access
  [ServiceNetworkArn](#cfn-odb-odbnetwork-managedservices-servicenetworkarn): String
  [ServiceNetworkEndpoint](#cfn-odb-odbnetwork-managedservices-servicenetworkendpoint): 
    ServiceNetworkEndpoint
  [StsAccess](#cfn-odb-odbnetwork-managedservices-stsaccess): 
    StsAccess
  [ZeroEtlAccess](#cfn-odb-odbnetwork-managedservices-zeroetlaccess): 
    ZeroEtlAccess
```

## Properties
<a name="aws-properties-odb-odbnetwork-managedservices-properties"></a>

`CrossRegionS3RestoreSourcesAccess`  <a name="cfn-odb-odbnetwork-managedservices-crossregions3restoresourcesaccess"></a>
The access configuration for the cross-Region Amazon S3 database restore source.  
*Required*: No  
*Type*: [Array](aws-properties-odb-odbnetwork-crossregions3restoresourcesaccess.md) of [CrossRegionS3RestoreSourcesAccess](aws-properties-odb-odbnetwork-crossregions3restoresourcesaccess.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KmsAccess`  <a name="cfn-odb-odbnetwork-managedservices-kmsaccess"></a>
The AWS Key Management Service (KMS) access configuration.  
*Required*: No  
*Type*: [KmsAccess](aws-properties-odb-odbnetwork-kmsaccess.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ManagedS3BackupAccess`  <a name="cfn-odb-odbnetwork-managedservices-manageds3backupaccess"></a>
The managed Amazon S3 backup access configuration.  
*Required*: No  
*Type*: [ManagedS3BackupAccess](aws-properties-odb-odbnetwork-manageds3backupaccess.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ManagedServicesIpv4Cidrs`  <a name="cfn-odb-odbnetwork-managedservices-managedservicesipv4cidrs"></a>
The IPv4 CIDR blocks for the managed services.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResourceGatewayArn`  <a name="cfn-odb-odbnetwork-managedservices-resourcegatewayarn"></a>
The Amazon Resource Name (ARN) of the resource gateway.  
*Required*: No  
*Type*: String  
*Pattern*: `arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-z0-9-_]{6,64}`  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Access`  <a name="cfn-odb-odbnetwork-managedservices-s3access"></a>
The Amazon S3 access configuration.  
*Required*: No  
*Type*: [S3Access](aws-properties-odb-odbnetwork-s3access.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServiceNetworkArn`  <a name="cfn-odb-odbnetwork-managedservices-servicenetworkarn"></a>
The Amazon Resource Name (ARN) of the service network.  
*Required*: No  
*Type*: String  
*Pattern*: `arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-z0-9-_]{6,64}`  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServiceNetworkEndpoint`  <a name="cfn-odb-odbnetwork-managedservices-servicenetworkendpoint"></a>
The service network endpoint configuration.  
*Required*: No  
*Type*: [ServiceNetworkEndpoint](aws-properties-odb-odbnetwork-servicenetworkendpoint.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StsAccess`  <a name="cfn-odb-odbnetwork-managedservices-stsaccess"></a>
The AWS Security Token Service (STS) access configuration.  
*Required*: No  
*Type*: [StsAccess](aws-properties-odb-odbnetwork-stsaccess.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ZeroEtlAccess`  <a name="cfn-odb-odbnetwork-managedservices-zeroetlaccess"></a>
The Zero-ETL access configuration.  
*Required*: No  
*Type*: [ZeroEtlAccess](aws-properties-odb-odbnetwork-zeroetlaccess.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ODB::OdbNetwork S3Access
<a name="aws-properties-odb-odbnetwork-s3access"></a>

The configuration for Amazon S3 access from the ODB network.

## Syntax
<a name="aws-properties-odb-odbnetwork-s3access-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-odb-odbnetwork-s3access-syntax.json"></a>

```
{
  "[DomainName](#cfn-odb-odbnetwork-s3access-domainname)" : String,
  "[Ipv4Addresses](#cfn-odb-odbnetwork-s3access-ipv4addresses)" : [ String, ... ],
  "[S3PolicyDocument](#cfn-odb-odbnetwork-s3access-s3policydocument)" : String,
  "[Status](#cfn-odb-odbnetwork-s3access-status)" : String
}
```

### YAML
<a name="aws-properties-odb-odbnetwork-s3access-syntax.yaml"></a>

```
  [DomainName](#cfn-odb-odbnetwork-s3access-domainname): String
  [Ipv4Addresses](#cfn-odb-odbnetwork-s3access-ipv4addresses): 
    - String
  [S3PolicyDocument](#cfn-odb-odbnetwork-s3access-s3policydocument): String
  [Status](#cfn-odb-odbnetwork-s3access-status): String
```

## Properties
<a name="aws-properties-odb-odbnetwork-s3access-properties"></a>

`DomainName`  <a name="cfn-odb-odbnetwork-s3access-domainname"></a>
The domain name for the Amazon S3 access.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Ipv4Addresses`  <a name="cfn-odb-odbnetwork-s3access-ipv4addresses"></a>
The IPv4 addresses for the Amazon S3 access.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3PolicyDocument`  <a name="cfn-odb-odbnetwork-s3access-s3policydocument"></a>
The endpoint policy for the Amazon S3 access.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-odb-odbnetwork-s3access-status"></a>
The status of the Amazon S3 access.  
*Required*: No  
*Type*: String  
*Allowed values*: `ENABLED | ENABLING | DISABLED | DISABLING`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ODB::OdbNetwork ServiceNetworkEndpoint
<a name="aws-properties-odb-odbnetwork-servicenetworkendpoint"></a>

The configuration for a service network endpoint.

## Syntax
<a name="aws-properties-odb-odbnetwork-servicenetworkendpoint-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-odb-odbnetwork-servicenetworkendpoint-syntax.json"></a>

```
{
  "[VpcEndpointId](#cfn-odb-odbnetwork-servicenetworkendpoint-vpcendpointid)" : String,
  "[VpcEndpointType](#cfn-odb-odbnetwork-servicenetworkendpoint-vpcendpointtype)" : String
}
```

### YAML
<a name="aws-properties-odb-odbnetwork-servicenetworkendpoint-syntax.yaml"></a>

```
  [VpcEndpointId](#cfn-odb-odbnetwork-servicenetworkendpoint-vpcendpointid): String
  [VpcEndpointType](#cfn-odb-odbnetwork-servicenetworkendpoint-vpcendpointtype): String
```

## Properties
<a name="aws-properties-odb-odbnetwork-servicenetworkendpoint-properties"></a>

`VpcEndpointId`  <a name="cfn-odb-odbnetwork-servicenetworkendpoint-vpcendpointid"></a>
The identifier of the VPC endpoint.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcEndpointType`  <a name="cfn-odb-odbnetwork-servicenetworkendpoint-vpcendpointtype"></a>
The type of the VPC endpoint.  
*Required*: No  
*Type*: String  
*Allowed values*: `SERVICENETWORK`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ODB::OdbNetwork StsAccess
<a name="aws-properties-odb-odbnetwork-stsaccess"></a>

Configuration for AWS Security Token Service (STS) access from the ODB network.

## Syntax
<a name="aws-properties-odb-odbnetwork-stsaccess-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-odb-odbnetwork-stsaccess-syntax.json"></a>

```
{
  "[DomainName](#cfn-odb-odbnetwork-stsaccess-domainname)" : String,
  "[Ipv4Addresses](#cfn-odb-odbnetwork-stsaccess-ipv4addresses)" : [ String, ... ],
  "[Status](#cfn-odb-odbnetwork-stsaccess-status)" : String,
  "[StsPolicyDocument](#cfn-odb-odbnetwork-stsaccess-stspolicydocument)" : String
}
```

### YAML
<a name="aws-properties-odb-odbnetwork-stsaccess-syntax.yaml"></a>

```
  [DomainName](#cfn-odb-odbnetwork-stsaccess-domainname): String
  [Ipv4Addresses](#cfn-odb-odbnetwork-stsaccess-ipv4addresses): 
    - String
  [Status](#cfn-odb-odbnetwork-stsaccess-status): String
  [StsPolicyDocument](#cfn-odb-odbnetwork-stsaccess-stspolicydocument): String
```

## Properties
<a name="aws-properties-odb-odbnetwork-stsaccess-properties"></a>

`DomainName`  <a name="cfn-odb-odbnetwork-stsaccess-domainname"></a>
The domain name for AWS Security Token Service (STS) access configuration.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Ipv4Addresses`  <a name="cfn-odb-odbnetwork-stsaccess-ipv4addresses"></a>
The IPv4 addresses allowed for AWS Security Token Service (STS) access.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-odb-odbnetwork-stsaccess-status"></a>
The current status of the AWS Security Token Service (STS) access configuration.  
*Required*: No  
*Type*: String  
*Allowed values*: `ENABLED | ENABLING | DISABLED | DISABLING`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StsPolicyDocument`  <a name="cfn-odb-odbnetwork-stsaccess-stspolicydocument"></a>
The AWS Security Token Service (STS) policy document that defines permissions for token service usage.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ODB::OdbNetwork Tag
<a name="aws-properties-odb-odbnetwork-tag"></a>

A key-value pair to associate with a resource.

## Syntax
<a name="aws-properties-odb-odbnetwork-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-odb-odbnetwork-tag-syntax.json"></a>

```
{
  "[Key](#cfn-odb-odbnetwork-tag-key)" : String,
  "[Value](#cfn-odb-odbnetwork-tag-value)" : String
}
```

### YAML
<a name="aws-properties-odb-odbnetwork-tag-syntax.yaml"></a>

```
  [Key](#cfn-odb-odbnetwork-tag-key): String
  [Value](#cfn-odb-odbnetwork-tag-value): String
```

## Properties
<a name="aws-properties-odb-odbnetwork-tag-properties"></a>

`Key`  <a name="cfn-odb-odbnetwork-tag-key"></a>
The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with `aws:`. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `:`, `/`, `=`, `+`, `@`, `-`, and `"`.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-odb-odbnetwork-tag-value"></a>
The value for the tag. You can specify a value that's 1 to 256 characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ODB::OdbNetwork ZeroEtlAccess
<a name="aws-properties-odb-odbnetwork-zeroetlaccess"></a>

The configuration for Zero-ETL access from the ODB network.

## Syntax
<a name="aws-properties-odb-odbnetwork-zeroetlaccess-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-odb-odbnetwork-zeroetlaccess-syntax.json"></a>

```
{
  "[Cidr](#cfn-odb-odbnetwork-zeroetlaccess-cidr)" : String,
  "[Status](#cfn-odb-odbnetwork-zeroetlaccess-status)" : String
}
```

### YAML
<a name="aws-properties-odb-odbnetwork-zeroetlaccess-syntax.yaml"></a>

```
  [Cidr](#cfn-odb-odbnetwork-zeroetlaccess-cidr): String
  [Status](#cfn-odb-odbnetwork-zeroetlaccess-status): String
```

## Properties
<a name="aws-properties-odb-odbnetwork-zeroetlaccess-properties"></a>

`Cidr`  <a name="cfn-odb-odbnetwork-zeroetlaccess-cidr"></a>
The CIDR block for the Zero-ETL access.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-odb-odbnetwork-zeroetlaccess-status"></a>
The status of the Zero-ETL access.  
*Required*: No  
*Type*: String  
*Allowed values*: `ENABLED | ENABLING | DISABLED | DISABLING`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)